Scroll to navigation

BACKUPNINJA(1) backupninja package BACKUPNINJA(1)


BACKUPNINJA - A lightweight, extensible meta-backup system
"a silent flower blossom death strike to lost data."


backupninja [ -h ] [ -v ] [ -d ] [ -n ] [ -t ] [ -f filename ] [ --run filename ]


Backupninja allows you to coordinate system backups 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.


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.
in order to backup a db or sql database, you cannot simply copy database files. backupninja helps you safely export the data to a format which you can backup.

Backup types include:

secure, remote, incremental filesystem backup (via rdiff-backup). incremental data is compressed. permissions are retained even with an unpriviledged backup user.
basic system and hardware information.
encrypted remote backups (via duplicity).
safe backup of MySQL, PostgreSQL, OpenLDAP, and subversion databases.
burn CD/DVDs or create ISOs.


Show summary of options
Show backupninja version number
Run in debug mode, where all log messages are output to the current shell.
Use CONF_FILE for the main configuration instead of /etc/backupninja.conf
Run in test mode, no actions are actually taken.
Perform actions now, instead of when they might be scheduled.
Runs the action configuration ACTION_FILE and exits.


General settings are configured in /etc/backupninja.conf. In this file you can set the log level and change the default directory locations. See backupninja.conf(5).

To preform the actual backup actions, backupninja processes each action configuration file in /etc/backup.d according to the file's suffix. See backup.d(5).


root@srchost# ssh-keygen -t rsa -b 4096
root@srchost# ssh-copy-id -i /root/.ssh/ backup@desthost
ninjahelper(1) will walk you through these steps.


0 success
1 errors or warnings emitted during backup
2 one or more backup actions failed
3 syntax or usage error


/usr/sbin/backupninja main script
/etc/backupninja.conf main configuration file; general options
/etc/cron.d/backupninja runs main script hourly
/etc/logrotate.d/backupninja rotates backupninja.log
/etc/backup.d directory for configuration files
/usr/share/backupninja directory for handler scripts
/usr/share/doc/backupninja/examples example action configuration files.


ninjahelper(1), backupninja.conf(5), backup.d(5),


BACKUPNINJA was written by the collective.

October 10, 2005 riseup