Added trac handler, changed VSERVERS variable to be lowercase and

[matthijs/upstream/backupninja.git] / README

diff --git a/README b/README
index 7830fe266747278e65d2e861eb046c904e0c8b88..b6483bd9f3312c91e4a50941554d924c0d7631ea 100644 (file)
--- a/README
+++ b/README
@@ -23,6 +23,7 @@ Features:
  - backup actions can be scheduled
  - you can choose when status report emails are mailed to you
    (always, on warning, on error, never).
+ - works with Linux-Vservers (http://linux-vserver.org/)
  
 The following options are available:
 -h, --help           This usage message
@@ -33,7 +34,7 @@ The following options are available:
 -t, --test           Run in test mode, no actions are actually taken.
 -n, --now            Perform actions now, instead of when they
                      might be scheduled.
-
+--run FILE           runs the specified action FILE (e.g. one of the /etc/backup.d/ files)
 
 CONFIGURATION FILES
 ===================
@@ -49,9 +50,11 @@ file in /etc/backup.d according to the file's suffix:
   .sh      --  run this file as a shell script.
   .rdiff   --  this is a configuration for rdiff-backup
   .maildir --  this is a configuration to backup maildirs
+  .dup     --  this is a configuration for duplicity
   .mysql   --  mysql backup configuration
   .ldap    --  ldap backup configuration
   .sys     --  general system reports
+  .svn     --  subversion repository backups
 
 Support for additional configuration types can be added by dropping
 bash scripts with the name of the suffix into /usr/share/backupninja. 
@@ -169,10 +172,7 @@ Requirements:
   apt-get install bash gawk
 
 Recommended: 
-  apt-get install rdiff-backup gzip
-
-Suggested:
-  apt-get install sfdisk discover  
+  apt-get install rdiff-backup gzip hwinfo
 
 Files:
   /usr/sbin/backupninja        -- main script
@@ -194,3 +194,21 @@ Installation:
   # mkdir /etc/backup.d/
   # mv etc/backupninja.conf /etc/backupninja.conf
   # mv handlers /usr/share/backupninja
+
+
+VSERVERS
+========
+
+If you are using Linux-Vservers (http://linux-vserver.org/) there are some
+special capabilities that different handlers have to make vserver backups easier.
+Set the variable "vservers" to be "yes" in /etc/backupninja.conf and see the
+example configuration files for each handler to configure the vserver specific
+variables.
+
+Additional vserver variables that can be configured in /etc/backupninja.conf. but
+probably don't need to be changed:
+
+VSERVERINFO (default: /usr/sbin/vserver-info)
+VSERVER (default: /usr/sbin/vserver)
+VROOTDIR (default: `$VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'; fi`)
+