Monikop's config changed
[monikop.git] / doc / usage.muse
blob2d2d5e20179cff47b7148b19001a783dc2a967c4
1 #title Monikop and Pokinom
2 #subtitle rsync between unconnected hosts
3 #author Bert Burgemeister
5 * Usage
7 ** Monikop
9 Put removable disks into Monikop's host on Rover and switch it on. Immediately,
10 Monikop starts pulling data from Sources it can reach. Monikop will
11 notice additional Sources that become reachable later and will start
12 pulling data there as well.
14 For each Source, Monikop keeps starting over to see if there is new
15 data. Only Monikop's shutdown or the disappearance of the data Source
16 will end this cycle.
18 One removable disk is sufficient for Monikop's correct
19 operation; but if speed is important, putting in as many disks as
20 there are data Sources may be beneficial as Monikop uses them in parallel.
22 To end a session, press [F3] to shut down Monikop, and remove the
23 disks. Monikop's display shows which disks are not yet used so you
24 can avoid carrying empty disks around.
28 ** Pokinom
30 Put removable disks into Pokinom's host in office and switch it
31 on. Immediately, Pokinom starts pushing data to Destination. You
32 should wait until it's finished, otherwise files, even if copied to
33 Destination, can't be deleted from their removable disks by Monikop.
35 Press [F9] to toggle wheather or not Pokinom shuts down when finished.
37 File permissions in Destination's receiving directory must not be
38 changed in a way that prevents the rsync server from modifying.
39 Best practice is to move anything out of this directory prior to any
40 processing. 
42 Pokinom needs a sufficient amount of free space on Destination; it
43 must be rebooted once this hasn't been the case. 
46    - You have to be able to tell from your data if it's complete.
47    - data transferred, but to ignore
48    - Backup functionality: data remains on disks until re-inserted in
49      Monikop. Names in use. How to recover.
50    - Re-copy data from Source: delete from log the two files per Source that
51      are named by $rsync_log_prefix and $finished_prefix in [[installation#monikop.config][=monikop.config=]].
55 ** fsck-pokinom
56    - TODO: unfinished
57    - fsck-pokinom: to be run by root
60 * Bugs
62   - Payload data must not contain any directories with the names set in
63     [[installation#monikop][=monikop.config]]/[[installation#pokinom.config][pokinom.config]]
64     by =$rsync_partial_dir_name=.
65   - Doesn't reflect disappearance of files on sources
66   - May ignore empty dirs (really?)
67   - During copying, obsolete versions of some files may temporarily be
68     on destination (after interrupted transfer of files which then have
69     grown larger)
70   - frequent power cuts (as opposed to normal shutdown operations) may
71      compromise efficiency in terms of disk usage.
72   - By running multiple instances of Rsync, Monikop puts considerable strain
73     to the system, which may reveal previously unnoticed hardware faults.
75 ; System reports disk error on (say) /dev/sdb1. What is it's label?
76 ; ls -l /dev/disk/by-label
78 ; Monikop and Pokinom will create the directories they need.