Documentation.
[monikop.git] / monikop.config.example
blob744175ff1179221aa6dbaa1a3a9f54ecbd935ce2
1 # (This is -*- perl -*- code.)
2 ##############################################################################
3 # Monikop's configuration file.
5 # Copy this file to `monikop.config' and adapt it to your needs.
6 ##############################################################################
8 # Possible data Sources, and by what directory name to represent them in
9 # Destination.
10 # When the latter is not unique, care must be taken that all pathnames in the 
11 # respective Sources are unique, or files will overwrite each other in
12 # unpredictable ways.
13 %sources = (
14     'data_producer1::data' => 'p1_dir',
15     'data_producer2::data' => 'p2_dir',
16     'data_producer3::data' => '',
17     'data_producer4::data' => '',
18     );
20 # Possible mount points of the removable disks.
21 @usable_mount_points = (
22     '/media/disk_1',
23     '/media/disk_2',
24     '/media/disk_3',
25     );
27 # Common directory (under a mount point) to put new data in.
28 # Must agree with Pokinom's setting.
29 $path_under_mount_point =
30     'measuring_data'
31     ;
33 # Directories (under any mount point) of this name will be deleted by Monikop.
34 # Must agree with Pokinom's setting.
35 $path_under_mount_point_backed_up =
36     'backed_up'
37     ;
39 # Directory name (under a mount point) while being deleted.
40 # Must agree with Pokinom's setting.
41 $path_under_mount_point_being_deleted =
42     'being_deleted'
43     ;
45 # Path and file name prefix for rsync's raw logs:
46 $rsync_log_prefix =
47     '~/log/monikop/log.'
48     ;
50 # Path and file name prefix for the list of successfully rsynced files:
51 $finished_prefix =
52     '~/log/monikop/finished.'
53     ; 
55 # Safe files are supposed to survive power cuts during write operations.
56 # How to suffix the name of the duplicate of a safe file:
57 $safe_file_backup_suffix =
58     '.bak'
59     ; 
61 # How to suffix the name of an unfinished safe file:
62 $safe_file_unfinished_suffix =
63     '.unfinished'
64     ; 
66 # What to do (shutdown) when F3 has been pressed:
67 $key_f3_action =
68     "sudo halt -p"
69     ;
71 # What to do (reboot) when F6 has been pressed:
72 $key_f6_action =
73     "sudo reboot"
74     ;
76 # Rsync's time (in seconds) to wait for a response. This is roughly the time
77 # Monikop needs to notice the disappearance of a Source. Must not be 0.
78 $rsync_timeout =
79     30
80     ;
82 # Rsync's directory (relative to mount point of removable disk) for partially
83 # transferred files.
84 # Must agree with Pokinom's setting. Make sure your payload data does not
85 # contain an equally-named directory.
86 $rsync_partial_dir_name =
87     '.rsync_partial'
88     ;