3 B A C K U P N I N J A /()/
6 a silent flower blossom death strike to lost data.
8 Backupninja allows you to coordinate system backup by dropping a few
9 simple configuration files into /etc/backup.d/. Most programs you
10 might use for making backups don't have their own configuration file
11 format. Backupninja provides a centralized way to configure and
12 coordinate many different backup utilities.
15 - easy to read ini style configuration files.
16 - secure, remote, incremental filesytem backup (via rdiff-backup).
17 incremental data is compressed. permissions are retained even
18 with an unpriviledged backup user.
19 - backup of mysql databases (via mysqlhotcopy and mysqldump).
20 - backup of ldap databases (via slapcat and ldapsearch).
21 - passwords are never sent via the command line to helper programs.
22 - you can drop in scripts to handle new types of backups.
23 - backup actions can be scheduled
24 - you can choose when status report emails are mailed to you
25 (always, on warning, on error, never).
27 The following options are available:
28 -h, --help This usage message
29 -d, --debug Run in debug mode, where all log messages are
30 output to the current shell.
31 -f, --conffile FILE Use FILE for the main configuration instead
32 of /etc/backupninja.conf
33 -t, --test Run in test mode, no actions are actually taken.
34 -n, --now Perform actions now, instead of when they
36 --run FILE runs the specified action FILE (e.g. one of the /etc/backup.d/ files)
41 The general configuration file is /etc/backupninja.conf. In this file
42 you can set the log level and change the default directory locations.
43 You can force a different general configuration file with "backupninja
46 To preform the actual backup, backupninja processes each configuration
47 file in /etc/backup.d according to the file's suffix:
49 .sh -- run this file as a shell script.
50 .rdiff -- this is a configuration for rdiff-backup
51 .maildir -- this is a configuration to backup maildirs
52 .dup -- this is a configuration for duplicity
53 .mysql -- mysql backup configuration
54 .ldap -- ldap backup configuration
55 .sys -- general system reports
57 Support for additional configuration types can be added by dropping
58 bash scripts with the name of the suffix into /usr/share/backupninja.
60 The configuration files are processed in alphabetical order. However,
61 it is suggested that you name the config files in "sysvinit style."
69 Typically, you will put a '.rdiff' config file last, so that any
70 database dumps you make are included in the filesystem backup.
71 Configurations files which begin with 0 (zero) are skipped.
73 Unless otherwise specified, the config file format is "ini style."
86 i will not have a pear.
92 By default, each configuration file is processed everyday at 01:00 (1
93 AM). This can be changed by specifying the 'when' option in a config
98 when = sundays at 02:00
101 when = everyday at 01 <-- the default
102 when = Tuesday at 05:00
104 A configuration file will be processed at the time(s) specified by the
105 "when" option. If multiple "when" options are present, then they all
106 apply. If two configurations files are scheduled to run in the same
107 hour, then we fall back on the alphabetical ordering specified above.
108 If two configurations files are scheduled close to one another in
109 time, it is possible to have multiple copies of backupninja running if
110 the first instance is not finished before the next one starts.
112 These values for 'when' are equivalent:
114 when = tuesday at 05:30
115 when = TUESDAYS at 05
117 These values for 'when' are invalid:
119 when = tuesday at 2am
127 Backupninja can be used to impliment whatever backup strategy you
128 choose. It is intended, however, to be used like so:
130 (1) First, databases are safely copied or exported to /var/backups.
131 Typically, you cannot make a file backup of a database while it
132 is in use, hence the need to use special tools to make a safe copy
133 or export into /var/backups.
135 (2) Then, vital parts of the file system, including /var/backups, are
136 nightly pushed to a remote, off-site, hard disk (using
137 rdiff-backup). The local user is root, but the remote user is not
138 priviledged. Hopefully, the remote filesystem is encrypted.
140 There are many different backup strategies out there, including "pull
141 style", magnetic tape, rsync + hard links, etc. We believe that the
142 strategy outlined above is the way to go because: (1) hard disks are
143 very cheap these days, (2) pull style backups are no good, because then
144 the backup server must have root on the production server, and (3)
145 rdiff-backup is more space efficient and featureful than using rsync +
152 In order for rdiff-backup to sync files over ssh unattended, you must
153 create ssh keys on the source server and copy the public key to the
154 remote user's authorized keys file. For example:
156 root@srchost# ssh-keygen -t dsa
157 root@srchost# ssh-copy-id -i /root/.ssh/id_dsa.pub backup@desthost
159 Now, you should be able to ssh from user 'root' on srchost to
160 user 'backup' on desthost without specifying a password.
162 Note: when prompted for a password by ssh-keygen, just leave it
163 blank by hitting return.
170 apt-get install bash gawk
173 apt-get install rdiff-backup gzip hwinfo
176 /usr/sbin/backupninja -- main script
177 /etc/cron.d/backupninja -- runs main script nightly
178 /etc/logrotate.d/backupninja -- rotates backupninja.log
179 /etc/backup.d/ -- directory for configuration files
180 /etc/backupninja.conf -- general options
181 /usr/share/backupninja -- handler scripts which do the actual work
184 There is no install script, but you just need to move files to the
185 correct locations. All files should be owned by root.
187 # tar xvzf backupninja.tar.gz
189 # mv backupninja /usr/sbin/backupninja
190 # mv etc/logrotate.d/backupninja /etc/logrotate.d/backupninja
191 # mv etc/cron.d/backupninja /etc/cron.d/backupninja
192 # mkdir /etc/backup.d/
193 # mv etc/backupninja.conf /etc/backupninja.conf
194 # mv handlers /usr/share/backupninja