| Branch: | Tag: | Revision:

root @ master

Name Size Revision Age Author Comment
  etc 7355535e about 7 years Jacob Anawalt Enable pg_dump format option. The format optio...
  examples 03292147 over 3 years rhatto Rsync example: show 'user' parameter as a requi...
  handlers 41c3544e over 2 years micah dsync: the dsync handler incorrectly would test...
  lib 0e6df840 almost 4 years intrigeri Add shell functions to compare version numbers.
  man 47762748 about 6 years intrigeri Don't mention LDAP support in documentation.
  src 21bcb7e6 over 3 years Mark Janssen -- Sig-I/O Automatisering Ignore files ending in ~
.gitignore 822 Bytes 8693a0cf over 6 years intrigeri Update .gitignore.
AUTHORS 2.92 KB 3146245d about 3 years intrigeri Update ChangeLog and AUTHORS.
COPYING 17.6 KB 419cc1a7 about 12 years micah Oops, cleanup and move the license to the stand...
ChangeLog 37.9 KB 48b7b6ad almost 3 years intrigeri Close one more forgotten Debian bug report in C...
FAQ 1009 Bytes ea9814ad about 9 years intrigeri FAQ: new file, with first Q/A for duplicity vs....
INSTALL 405 Bytes 0cef8411 about 4 years micah update INSTALL file to add some missing recomme... 1.65 KB 17be899a over 5 years intrigeri Have "make dist" ship the FAQ.
NEWS 2.75 KB 4015b1b2 over 7 years intrigeri NEWS: added note about excluding duplicity cach...
README 9.44 KB 31279148 almost 6 years intrigeri Document what features available to .sh jobs (R...
TODO 1.05 KB 29b86fdf almost 8 years intrigeri TODO: removed issues that are resolved or track... 414 Bytes 28338e91 over 11 years micah Added RPM patches submitted by Robert Napier 1.47 KB 9400bd00 almost 8 years intrigeri Fixed remaining pointers to our deprecated Trac... 2.26 KB 3d36ded8 over 5 years rhatto Releasing backupninja 1.0.1

Latest revisions

# Date Author Comment
41c3544e 03/30/2015 04:23 PM micah

dsync: the dsync handler incorrectly would test for >3 failures before
emitting the failure message, it should do so at =>3

48b7b6ad 02/07/2015 10:06 AM intrigeri

Close one more forgotten Debian bug report in ChangeLog.

3146245d 11/07/2014 05:40 PM intrigeri

Update ChangeLog and AUTHORS.

3094b04d 11/07/2014 05:16 PM rhatto

Rsync: check test mode should set proper dest path (#8196)

89860aa3 11/07/2014 04:36 PM rhatto

Rsync: check test mode also in prepare_storage (#8196)

c649339b 11/05/2014 01:18 PM rhatto

Rsync: support for backupninja's test option (#8196)

8b6b607d 06/14/2014 06:52 AM intrigeri

Update AUTHORS and ChangeLog.

21bcb7e6 06/14/2014 06:47 AM Mark Janssen -- Sig-I/O Aut...

Ignore files ending in ~

4377caaf 05/03/2014 02:09 PM intrigeri

Update ChangeLog.

9b37f756 05/03/2014 02:08 PM intrigeri

Exclude tmpfs filesystems from df output in the sys handler (Closes: Debian#745818).

View all revisions | View revisions


|\_ B A C K U P N I N J A /()/ `\| a silent flower blossom death strike to lost data. Backupninja allows you to coordinate system backup by dropping a few simple configuration files into /etc/backup.d/. Most programs you might use for making backups don't have their own configuration file format. Backupninja provides a centralized way to configure and coordinate many different backup utilities. Features: - easy to read ini style configuration files. - 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 ( 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). - 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 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. 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, 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 =================== The general configuration file is /etc/backupninja.conf. In this file you can set the log level and change the default directory locations. You can force a different general configuration file with "backupninja -f /path/to/conf". To preform the actual backup, backupninja processes each configuration file in /etc/backup.d according to the file's suffix: .sh -- run this file as a shell script. .rdiff -- filesystem backup (using rdiff-backup) .dup -- filesystem backup (using duplicity) .mysql -- backup mysql 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. The configuration files are processed in alphabetical order. However, it is suggested that you name the config files in "sysvinit style." For example: 00-disabled.pgsql 20-runthisnext.mysql 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 with names beginning with 0 (zero) or ending with .disabled (preferred method) are skipped. Unless otherwise specified, the config file format is "ini style." For example: # this is a comment [fishes] fish = red fish = blue [fruit] apple = yes 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. 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 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 ================ 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. Typically, you cannot make a file backup of a database while it is in use, hence the need to use special tools to make a safe copy or export into /var/backups. (2) Then, vital parts of the file system, including /var/backups, are nightly pushed to a remote, off-site, hard disk (using rdiff-backup). The local user is root, but the remote user is not priviledged. Hopefully, the remote filesystem is encrypted. There are many different backup strategies out there, including "pull style", magnetic tape, rsync + hard links, etc. We believe that the strategy outlined above is the way to go because: (1) hard disks are very cheap these days, (2) pull style backups are no good, because then 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 ======== In order for rdiff-backup to sync files over ssh unattended, you must create ssh keys on the source server and copy the public key to the remote user's authorized keys file. For example: root@srchost# ssh-keygen -t rsa -b 4096 root@srchost# ssh-copy-id -i /root/.ssh/ backup@desthost Now, you should be able to ssh from user 'root' on srchost to user 'backup' on desthost without specifying a password. 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. 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 ( 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}'`) .sh CONFIGURATION FILES ======================= Shell jobs may use the following features: * logging and control flow functions: halt, fatal, error, warning, info, debug, passthru. All such functions take a list of strings a parameters. Those strings are passed to whatever logging mechanism is enabled, and colored if relevant. * Using "exit N" is useless, and has unspecified consequences. Just don't do it. * when=TIME works as documented above; at may also be written "when = TIME". * The $BACKUPNINJA_DEBUG environment variable is set when backupninja is invoked with the -d option.

Also available in: Atom