added scheduling (!) see readme.

[matthijs/upstream/backupninja.git] / README

diff --git a/README b/README
index 1b8bd66ddc6dbbd04ee464f5574343121146755b..e361ba74773da467b8834bac812d94a200a5f615 100644 (file)
--- a/README
+++ b/README
@@ -28,6 +28,7 @@ The following options are available:
 -f <file>  Use <file> for the main configuration instead of
            /etc/backupninja.conf
  
+
 CONFIGURATION FILES
 ===================
 
@@ -44,6 +45,7 @@ file in /etc/backup.d according to the file's suffix:
   .maildir --  this is a configuration to backup maildirs
   .mysql   --  mysql backup configuration
   .ldap    --  ldap backup configuration
+  .sys     --  general system reports
 
 Support for additional configuration types can be added by dropping
 bash scripts with the name of the suffix into /usr/share/backupninja. 
@@ -76,6 +78,42 @@ For example:
    pear = no thanks \
    i will not have a pear.
 
+
+SCHEDULING
+==========
+
+By default, each configuration file is processed everyday at 01:00 (1
+AM). This can be changed by specifying the 'when' option in a config
+file.
+
+For example:
+
+  when = sundays at 02:00
+  when = 30th at 22
+  when = 30 at 22:00
+  when = everyday at 01            <-- the default
+  when = Tuesday at 05:00
+
+A configuration file will be processed at the time(s) specified by the
+"when" option. If multiple "when" options are present, then they all
+apply. If two configurations files are scheduled to run in the same
+hour, then we fall back on the alphabetical ordering specified above.
+If two configurations files are scheduled close to one another in
+time, it is possible to have multiple copies of backupninja running if
+the first instance is not finished before the next one starts.
+
+These values for 'when' are equivalent:
+
+  when = tuesday at 05:30
+  when = TUESDAYS at 05
+
+These values for 'when' are invalid:
+  
+  when = tuesday at 2am
+  when = tuesday at 2
+  when = tues at 02
+
+
 REAL WORLD USAGE
 ================
 
@@ -100,6 +138,7 @@ the backup server must have root on the production server, and (3)
 rdiff-backup is more space efficient and featureful than using rsync +
 hard links. 
 
+
 SSH KEYS
 ========
 
@@ -116,15 +155,19 @@ user 'backup' on desthost without specifying a password.
 Note: when prompted for a password by ssh-keygen, just leave it
 blank by hitting return.
 
+
 INSTALLATION
 ============
    
 Requirements:
   apt-get install bash gawk
 
-Suggested:
+Recommended: 
   apt-get install rdiff-backup gzip
 
+Suggested:
+  apt-get install sfdisk discover  
+
 Files:
   /usr/sbin/backupninja        -- main script
   /etc/cron.d/backupninja      -- runs main script nightly