Features:
- easy to read ini style configuration files.
- - secure, remote, incremental filesytem backup (via rdiff-backup).
- incremental data is compressed. permissions are retained even
- with an unpriviledged backup user.
- - backup of mysql databases (via mysqlhotcopy and mysqldump).
- - backup of ldap databases (via slapcat and ldapsearch).
- - passwords are never sent via the command line to helper programs.
- you can drop in scripts to handle new types of backups.
- backup actions can be scheduled
- you can choose when status report emails are mailed to you
(always, on warning, on error, never).
+ - console-based wizard (ninjahelper) makes it easy to create
+ backup action configuration files.
+ - passwords are never sent via the command line to helper programs.
+ - works with Linux-Vservers (http://linux-vserver.org/)
+Backup types:
+ - secure, remote, incremental filesytem backup (via rdiff-backup).
+ incremental data is compressed. permissions are retained even
+ with an unpriviledged backup user.
+ - backup of mysql databases (via mysqlhotcopy and mysqldump).
+ - backup of ldap databases (via slapcat and ldapsearch).
+ - basic system and hardware info
+ - encrypted remote backups (via duplicity).
+ - backup of subversion repositories.
+
The following options are available:
-h, --help This usage message
-d, --debug Run in debug mode, where all log messages are
output to the current shell.
-f, --conffile FILE Use FILE for the main configuration instead
of /etc/backupninja.conf
--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)
+-t, --test Test run mode. This will test if the backup could run, without actually
+ preforming any backups. For example, it will attempt to authenticate
+ or test that ssh keys are set correctly.
+-n, --now Perform actions now, instead of when they might be scheduled.
+ No output will be created unless also run with -d.
+--run FILE Runs the specified action FILE (e.g. one of the /etc/backup.d/ files).
+ Also puts backupninja in debug mode.
CONFIGURATION FILES
===================
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
- .mysql -- mysql backup configuration
- .ldap -- ldap backup configuration
- .sys -- general system reports
+ .rdiff -- filesystem backup (using rdiff-backup)
+ .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)
Support for additional configuration types can be added by dropping
bash scripts with the name of the suffix into /usr/share/backupninja.
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."
time, it is possible to have multiple copies of backupninja running if
the first instance is not finished before the next one starts.
+Make sure that you put the "when" option before any sections in your
+configuration file.
+
These values for 'when' are equivalent:
when = tuesday at 05:30
REAL WORLD USAGE
================
-Backupninja can be used to impliment whatever backup strategy you
+Backupninja can be used to implement whatever backup strategy you
choose. It is intended, however, to be used like so:
(1) First, databases are safely copied or exported to /var/backups.
Note: when prompted for a password by ssh-keygen, just leave it
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
============
apt-get install bash gawk
Recommended:
- apt-get install rdiff-backup gzip
-
-Suggested:
- apt-get install discover
+ apt-get install rdiff-backup gzip hwinfo
Files:
/usr/sbin/backupninja -- main script
# tar xvzf backupninja.tar.gz
# cd backupninja
# mv backupninja /usr/sbin/backupninja
+ # mv ninjahelper /usr/sbin/ninjahelper
# 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
+
+
+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 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}'`)
+
+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 <helper>_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.
projects / matthijs / upstream / backupninja.git / blobdiff