X-Git-Url: https://git.stderr.nl/gitweb?p=matthijs%2Fupstream%2Fbackupninja.git;a=blobdiff_plain;f=README;h=8b01addab4345c7aa7deda22b220f037cdb8279c;hp=e3977bc55df13f7bbc17ae07715620a53883ee9e;hb=81921efa98093b5bab8d8d62b92120076bfc6810;hpb=6af4bda04f032ca98be639eb1c8707535259622e diff --git a/README b/README index e3977bc..8b01add 100644 --- a/README +++ b/README @@ -46,6 +46,37 @@ The following options are available: --run FILE Runs the specified action FILE (e.g. one of the /etc/backup.d/ files). Also puts backupninja in debug mode. +NINJAHELPER +=========== + +Ninjahelper is an additional script which will walk you through the process of +configuring backupninja. Ninjahelper has a menu driven curses based interface +(using dialog). + +To add an additional 'wizard' to ninjahelper, follow these steps: + +(1) to add a helper for the handler "blue", create the file + blue.helper in the directory where the handlers live. + (ie /usr/share/backupninja). + +(2) next, you need to add your helper to the global HELPERS variable + and define the main function for your helper (the function name + is always _wizard). for example, blue.helper: + HELPERS="$HELPERS blue:description_of_this_helper" + blue_wizard() { + ... do work here ... + } + +(3) look at the existing helpers to see how they are written. Try to re-use + functions, such as the dialog functions that are defined in easydialog.sh, + or the vserver functions defined in lib/vserver. + +(4) test, re-test, and test again. Try to break the helper by going backwards, + try to think like someone who has no idea how to configure your handler + would think, try to make your helper as simple as possible. Walk like a cat, + become your shadow, don't let your senses betray you. + + CONFIGURATION FILES =================== @@ -62,6 +93,7 @@ file in /etc/backup.d according to the file's suffix: .dup -- filesystem backup (using duplicity) .mysql -- backup mysql databases .ldap -- backup ldap databases + .pgsql -- backup PostgreSQL databases .sys -- general hardware, partition, and system reports. .svn -- backup subversion repositories .maildir -- incrementally backup maildirs (very specialized) @@ -79,8 +111,9 @@ For example: 90-runthislast.rdiff Typically, you will put a '.rdiff' config file last, so that any -database dumps you make are included in the filesystem backup. -Configurations files which begin with 0 (zero) are skipped. +database dumps you make are included in the filesystem backup. +Configurations files with names beginning with 0 (zero) or ending with +.disabled (preferred method) are skipped. Unless otherwise specified, the config file format is "ini style." @@ -180,74 +213,31 @@ blank by hitting return. The included helper program "ninjahelper" will walk you through creating an rdiff-backup configuration, and will set up the ssh keys for you. -INSTALLATION -============ - -Requirements: - apt-get install bash gawk - -Recommended: - apt-get install rdiff-backup gzip hwinfo - -Files: - /usr/sbin/backupninja -- main script - /etc/cron.d/backupninja -- runs main script nightly - /etc/logrotate.d/backupninja -- rotates backupninja.log - /etc/backup.d/ -- directory for configuration files - /etc/backupninja.conf -- general options - /usr/share/backupninja -- handler scripts which do the actual work - -Installation: - There is no install script, but you just need to move files to the - correct locations. All files should be owned by root. - - # tar xvzf backupninja.tar.gz - # cd backupninja - # mv backupninja /usr/sbin/backupninja - # mv etc/logrotate.d/backupninja /etc/logrotate.d/backupninja - # mv etc/cron.d/backupninja /etc/cron.d/backupninja - # mkdir /etc/backup.d/ - # mv etc/backupninja.conf /etc/backupninja.conf - # mv handlers /usr/share/backupninja + +Amazon Simple Storage Service (S3) +================================== + +Duplicity can store backups on Amazon S3 buckets, taking care of encryption. +Since it performs incremental backups it minimizes the number of request per +operation therefore reducing the costs. The boto Python interface to Amazon +Web Services is needed to use duplicity with S3 (Debian package: python-boto). 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. +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: +Additional vserver variables that can be configured in /etc/backupninja.conf, +but they 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`) - -NINJAHELPER -=========== - -Ninjahelper is an additional script which will walk you through the process of -configuring backupninja. Ninjahelper has a menu driven curses based interface -(using dialog). - -To add an additional 'wizard' to ninjahelper, follow these steps: - -(1) to add a helper for the handler "blue", create the file - blue.helper in the directory where the handlers live. - (ie /usr/share/backupninja). - -(2) next, you need to add your helper to the global HELPERS variable - and define the main function for your helper (the function name - is always _wizard). for example, blue.helper: - HELPERS="$HELPERS blue:description_of_this_helper" - blue_wizard() { - ... do work here ... - } - -(3) check the examples of the included helpers to see how they are - written. The dialog functions are defined in easydialog.sh. +VROOTDIR (default: `$VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'`)