diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README | 256 | ||||
| -rw-r--r-- | docs/changelog | 153 | ||||
| -rw-r--r-- | docs/examples/example.dup | 111 | ||||
| -rw-r--r-- | docs/examples/example.ldap | 45 | ||||
| -rw-r--r-- | docs/examples/example.makecd | 31 | ||||
| -rw-r--r-- | docs/examples/example.mysql | 75 | ||||
| -rw-r--r-- | docs/examples/example.pgsql | 20 | ||||
| -rw-r--r-- | docs/examples/example.rdiff | 79 | ||||
| -rw-r--r-- | docs/examples/example.sh | 2 | ||||
| -rw-r--r-- | docs/examples/example.svn | 23 | ||||
| -rw-r--r-- | docs/examples/example.sys | 32 | ||||
| -rw-r--r-- | docs/examples/example.trac | 16 | ||||
| -rw-r--r-- | docs/gpl.txt | 340 |
13 files changed, 1183 insertions, 0 deletions
diff --git a/docs/README b/docs/README new file mode 100644 index 0000000..849fe3a --- /dev/null +++ b/docs/README @@ -0,0 +1,256 @@ + + |\_ + 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 (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 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 +=================== + +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 + .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. + +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.ldap + 10-runthisfirst.sh + 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 dsa + root@srchost# ssh-copy-id -i /root/.ssh/id_dsa.pub 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. + +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 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 +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) check the examples of the included helpers to see how they are + written. The dialog functions are defined in easydialog.sh. + diff --git a/docs/changelog b/docs/changelog new file mode 100644 index 0000000..ee0d727 --- /dev/null +++ b/docs/changelog @@ -0,0 +1,153 @@ +version 0.9 -- unreleased + removed erroneous magic file marker in pgsql handler + fixed insecure temporary file creation + fixed incorrect find positional + +version 0.8 -- September 15 2005 + added pgsql (PostgreSQL) handler, with vservers support. + added vservers support to duplicity handler + Note: the configuration is a bit different than the rdiff + handler's one, but the default behavior is the same: + have a look at example.dup. + improved README + documented .disabled method. + corrected VROOTDIR default value. + added ninjahelper to the install instructions. + improved rdiff, dup and sys handlers' vservers support + prevent vserver-debiantools' $VROOTDIR/ARCHIVES directory + to be seen as a vserver + changes to sys handler + make use of configurable $VSERVERINFO instead of hard-coded vserver-info. + fixed dpkg existence test inside vserver. + fixed $nodpkg use. + changes to pgsql handler + now checks if the specified vserver is running. + now checks if $PGSQLDUMP/$PGSQLDUMPALL are available where needed. + now checks if "postgres" user exists on the host/vserver. + changes to ninjahelper + check_perms() does not die anymore on group/world readable + helper scripts (now consistent with the "helper scripts + must not be group or world writable!" error msg). + xedit action now tries $EDITOR, then /etc/alternatives/editor, + then nano, vim and vi, and aborts if none of these exists. + added helper for pgsql handler. + rdiff handler now does not require 'label' + changes to mysql and svn handlers' vservers support + these handlers now check if the source vserver is running + added 'ignores' for mysql handler. (thanks Daniel.Bonniot@inria.fr) + +version 0.7 -- July 26 2005 + added ninjahelper: a dialog based wizard for creating backupninja configs. + considerably improved and changed the log file output. + you can now disable actions with .disabled (this is new preferred method). + added makecd handler and example.makecd for backing up to cd/dvd (thanks stef). + fixed bug when specifying multiple 'when' options. + +version 0.6 -- June 16 2005 + ldap handler has new options: backup method to use (ldapsearch or + slapcat), restart, passwordfile and binddn. Default backup method + is set to ldapsearch as this is safer + ****************************************************************** + NOTE: to get the previous default behavior with the ldap handler, + you must set "method = slapcat". The new default is ldapsearch. + ****************************************************************** + implemented fix so that the main script will echo fatal errors rather + than being silent about them, this means an error message every hour + if there is a major configuration problem (not a handler problem) + added vserver support to main script and to the handlers: mysql, svn, sys, rdiff + changes to duplicity handler (thanks intrigeri!): + "keep = yes" now disables file cleaning on desthost + added "sign" option for backups signing + added "encryptkey" option to specify the gpg key to use + split config into [source], [gpg] and [dest] sections + added "nicelevel" option + added "testconnect" option + added "sshoptions" option (will be passed to ssh/scp) + added "bandwidthlimit" option + example.dup example config file for duplicity handler + added trac (http://trac.edgewall.com/) environment handler (thanks Charles Lepple!) + added configfile option to mysql handler + the default is /etc/mysql/debian.cnf. with this, + sqldump doesn't need dbusername. (hotcopy still does). + fixed bug in mysql handler which caused some passwords to not work. + (.my.cnf files now have double quotes around password) + can now pass options to hwinfo and sfdisk in sys handler. + +version 0.5 -- April 12 2005 + rdiff handler works when remote sshd has a banner + rdiff handler supports local dest + logfile is created if it doesn't exist + added "when = hourly" + added optional 'nicelevel' to rdiff handler + fixed bug where actions were not run in numeric order. + improved 'when' parsing. + +version 0.4.4 -- March 18 2005 + results of handlers are now read line by line. + changes to rdiff handler: added "options", and "keep" is + not necessarily days now (ie, it will pass straight through to + rdiff-backup if the keep has a unit on it, otherwise it adds the 'D'). + added dup handler (still pretty beta) + added maildir handler (very specialized handler) + added --run option (runs the specified action file) + improved sys handler, now uses hwinfo + added subversion hotbackup handler, svn. + added PATH to cron.d file, which fixes file not found errors. + +version 0.4.2 -- Jan 6 2005 + fixed bug which caused a report email to be sent even if no actions were run. + fixed bug where multiple handler status messages were ignored + added status in the subject line of report emails + +version 0.4.1 -- Jan 3 2005 + added $usecolors and now more conservative about when colors are echoed. + fixed major bug, 'when' actually works now. + replaced debug function with debug, info, warning, error, fatal. + added --now option to force all actions to be performed now. + +version 0.4 -- Dec 26 2004 + added "when" option, so that all configs can specify when + they are to be run. + added reportsuccess and reportwarning config options + added .sys handler (hardware, packages, partitions). + +version 0.3.4 -- Dec 8 2004 + fixed numerical variable quoting compatibility with older wc + fixed stderr redirect bug + some comments in example.rdiff + +version 0.3.3 -- Nov 10 2004 + '*' (asterisk) works now in rdiff config files + works now with gawk as well as mawk + many bug fixes to ldap handler + paths to helper scripts can be configured in global config + does not require /usr/bin/stat + +version 0.3.2 -- Sept 29 2004 + handler scripts are no longer executable (to comply with debian policy) + handler error and warning messages are sent with the notify email + +version 0.3.1 -- Sept 5 2004 + added ldap handler + moved sh support to a handler script + add test mode, where no action is taken. + added --help + force only root can read /etc/backup.d/* + fixed missing equals symbols in example.rdiff + changed backupninja executable to be /usr/sbin rather than /usr/bin + +version 0.3 -- Oct 20 2004 + ** IMPORTANT ** all config files are now ini style, not apache style + rewrote all scripts in bash for portability + added drop-in backupninja lib directory (/usr/share/backupninja) + all scripts are now run as root + +version 0.2 -- Oct 14 2004 + move distribution folder ./cron.d to ./etc/cron.d + fixed bug: removed printr of excludes (!) + added support for changing the user/group in rdiff sources. + added support for .mysql config files. + +version 0.1 -- Oct 8 2004 + initial release + diff --git a/docs/examples/example.dup b/docs/examples/example.dup new file mode 100644 index 0000000..7db7771 --- /dev/null +++ b/docs/examples/example.dup @@ -0,0 +1,111 @@ + +# passed directly to duplicity +#options = --verbosity 8 + +# default is 0, but set to 19 if you want to lower the priority. +nicelevel = 19 + +# default is yes. set to no to skip the test if the remote host is alive +#testconnect = no + +###################################################### +## gpg section +## (how to encrypt and optionnally sign the backups) + +[gpg] + +# passphrase needed to unlock the GnuPG key +# NB: do not quote it, and it should not contain any quote +password = a_very_complicated_passphrase + +# default is no, for backward compatibility with backupninja <= 0.5. +# when set to yes, encryptkey option must be set below. +sign = yes + +# key ID used for data encryption and, optionnally, signing. +# if not set, local root's default gpg key is used. +encryptkey = 04D9EA79 + +###################################################### +## source section +## (where the files to be backed up are coming from) + +[source] + +# files to include in the backup +# (supports globbing with '*') +# BIG FAT WARNING +# Symlinks are not dereferenced. Moreover, an include line whose path +# contains, at any level, a symlink to a directory, will only have the +# symlink backed-up, not the target directory's content. Yes, you have +# to dereference yourself the symlinks, or to use 'mount --bind' +# instead. +# EXAMPLE +# Let's say /home is a symlink to /mnt/crypt/home ; the following line +# will only backup a "/home" symlink ; neither /home/user nor +# /home/user/Mail will be backed-up : +# include = /home/user/Mail +# A workaround is to 'mount --bind /mnt/crypt/home /home' ; another +# one is to write : +# include = /mnt/crypt/home/user/Mail + +include = /var/spool/cron/crontabs +include = /var/backups +include = /etc +include = /root +include = /home +include = /usr/local/bin +include = /usr/local/sbin +include = /var/lib/dpkg/status +include = /var/lib/dpkg/status-old + +# If vservers = yes in /etc/backupninja.conf then the following variables can +# be used: +# vsnames = all | <vserver1> <vserver2> ... (default = all) +# vsinclude = <path> +# Any path specified in vsinclude is added to the include list for each vserver +# listed in vsnames (or all if vsnames = all). +# E.g. vsinclude = /home will backup the /home partition in every vserver +# listed in vsnames. If you have vsnames = "foo bar baz", this vsinclude will +# add to the include list /vservers/foo/home, /vservers/bar/home and +# /vservers/baz/home. +# Vservers paths are derived from $VROOTDIR. + +# rdiff-backup specific comment, TO ADAPT +# files to exclude from the backup +# (supports globbing with '*') +exclude = /home/*/.gnupg + +###################################################### +## destination section +## (where the files are copied to) + +[dest] + +# perform an incremental backup? (default = yes) +# if incremental = no, perform a full backup in order to start a new backup set +#incremental = yes + +# how many days of data to keep ; default is 60 days. +# (you can also use the time format of duplicity) +# 'keep = yes' means : do not delete old data, the remote host will take care of this +#keep = 60 +#keep = yes + +# bandwith limit, in kbit/s ; default is 0, i.e. no limit +#bandwidthlimit = 128 + +# passed directly to ssh and scp +sshoptions = -i /root/.ssh/id_dsa_duplicity + +# put the backups under this directory +destdir = /backups + +# the machine which will receive the backups +desthost = backuphost + +# make the files owned by this user +# note: you must be able to ssh backupuser@backhost +# without specifying a password (if type = remote). +destuser = backupuser + diff --git a/docs/examples/example.ldap b/docs/examples/example.ldap new file mode 100644 index 0000000..adc1fcd --- /dev/null +++ b/docs/examples/example.ldap @@ -0,0 +1,45 @@ +## +## configuration file for openldap backups +## +## If the method is set to "slapcat", the LDIFs generated are +## suitable for use with slapadd. As the entries are in database +## order, not superior first order, they cannot be loaded with +## ldapadd without being reordered. +## + +## backupdir (default /var/backups/ldap): the destination for the backups +# backupdir = /var/backups/ldap + +## conf (default /etc/ldap/slapd.conf): the location of the slapd.conf file. +# conf = /etc/ldap/slapd.conf + +## databases (default all): either a space separated list of database +## numbers or prefixes, or the keyword 'all'. +# databases = all + +## compress (default yes): if set to yes, ldif exports are gzipped. +# compress = yes + +## restart (default no): if set to yes, slapd is stopped before backups are +## performed, and then started again after they have finished, this is necessary +## if your backend is ldbm and your method is slapcat, but unnecessary otherwise. +# restart = no + +## method (default ldapsearch): either 'ldapsearch' or 'slapcat' +## ldapsearch is the safer method to do backups, but is slow, slapcat +## is much faster, but should not be done on an ldbm backend unless you have +## restart set to yes +## NOTE: with the ldapsearch method passwordfile and binddn need to be set +# method = ldapsearch + +## passwordfile (no default): this should be set to the file that contains +## your ldap password, this is required for ldapsearch and not needed for slapcat +## this file should have no newlines in it, echo -n "password" > passfile works. +## NOTE: be sure to set the permissions on your password file appropriately +## (hint: world readable is not appropriate) +# passwordfile = + +## binddn (no default): set this to the DN of the user that the ldapsearch binds +## to, not needed for slapcat +# binddn = + diff --git a/docs/examples/example.makecd b/docs/examples/example.makecd new file mode 100644 index 0000000..b01094e --- /dev/null +++ b/docs/examples/example.makecd @@ -0,0 +1,31 @@ + +# TYP is cd or dvd AS WELL AS the disk inside!! +burnertype = cd + +# system (yes) or directory/files (no) +# this function not yet implemented +#system = yes + +# location for image file +backupdir = /var/backups/makecd + +# image filename +imagefile = example.iso + +# iso or burn to cd/dvd? +isoonly = no + +# cd/dvd burner device +device=/dev/hdc + +# base directory to include in the backup +target = / + +# files or directories to be excluded +exclude = /proc +exclude = /lost+found +exclude = /tmp + +# backupninja will perfrom this at gvien date/time +when = wednesday at 02:00 + diff --git a/docs/examples/example.mysql b/docs/examples/example.mysql new file mode 100644 index 0000000..51c2247 --- /dev/null +++ b/docs/examples/example.mysql @@ -0,0 +1,75 @@ +### backupninja mysql config file ### + +databases = all +backupdir = /var/backups/mysql +hotcopy = no +sqldump = yes +compress = yes + +### authentication ### + +# three authentication methods: +# +# 1. setting the user, so that /home/user/.my.cnf is used. +# user = some-unix-user +# +# 2. specifying the mysql dbuser and dbpassword, +# which generates a temporary .my.cnf in /root/.my.cnf +# dbusername = <some-mysql-user> +# dbpassword = <password> +# +# 3. specify which config file to use with configfile +# (this option does not work with hotcopy) +# configfile = /etc/mysql/debian.cnf +# +# if user and dbusername are not specified, the default is to use +# /etc/mysql/debian.cnf for configfile. + +### all options ### + +# configfile = < path/to/file > (default = /etc/mysql/debian.cnf) +# The config file is passed to mysql with --defaults-file. +# On debian, this default will allow backupninja to make backups +# of mysql without configuring any additional options. +# (this option is not compatible with "user" or "dbusername"). +# +# user = <user> (default = root) +# Run mysql commands as 'user'. A valid .my.cnf must exist with a +# database username and password in the user's home directory. +# (this option is not compatible with "configfile" or "dbusername"). +# +# dbusername = <dbuser> (no default) +# The user must have access to the databases specified later. +# (this option is not compatible with "configfile" or "user"). +# +# dbpassword = <dbpass> (no default) +# The password used with dbusername. this password will NOT be passed +# on the command line and is not readable using "ps aux". +# +# dbhost = <host> (default = localhost) +# only localhost works right now. +# +# databases = < all | db1 db2 db3 > (default = all) +# which databases to backup. should either be the word 'all' or a +# space separated list of database names. +# +# backupdir = < path/to/destination > (default = /var/backups/mysql) +# where to dump the backups. hotcopy backups will be in a subdirectory 'hotcopy' and +# sqldump backups will be in a subdirectory 'sqldump' +# +# hotcopy = < yes | no > (default = no) +# make a backup of the actual database binary files using mysqlhotcopy. +# +# sqldump = < yes | no > (default = no) +# make a backup using mysqldump. this creates text files with sql commands +# sufficient to recontruct the database. +# +# compress = < yes | no > (default = yes) +# if yes, compress the sqldump output. +# +# vsname = <vserver> (no default) +# what vserver to operate on, only used if vserver = yes in /etc/backupninja.conf +# if you do not specify a vsname the host will be operated on +# +# NB: databases = all doesn't seem to work with hotcopy = yes when vsname is specified +# I would like to know how to fix this. diff --git a/docs/examples/example.pgsql b/docs/examples/example.pgsql new file mode 100644 index 0000000..d9aab42 --- /dev/null +++ b/docs/examples/example.pgsql @@ -0,0 +1,20 @@ +### backupninja PostgreSQL config file ### + +# vsname = <vserver> (no default) +# what vserver to operate on, only used if vserver = yes in /etc/backupninja.conf +# if you do not specify a vsname the host will be operated on +# Note: if operating on a vserver, $VROOTDIR will be prepended to backupdir. + +# backupdir = <dir> (default: /var/backups/postgres) +# where to dump the backups + +# databases = < all | db1 db2 db3 > (default = all) +# which databases to backup. should either be the word 'all' or a +# space separated list of database names. +# Note: when using 'all', pg_dumpall is used instead of pg_dump, which means +# that cluster-wide data (such as users and groups) are saved. + +# compress = < yes | no > (default = yes) +# if yes, compress the pg_dump/pg_dumpall output. + + diff --git a/docs/examples/example.rdiff b/docs/examples/example.rdiff new file mode 100644 index 0000000..bd16c3c --- /dev/null +++ b/docs/examples/example.rdiff @@ -0,0 +1,79 @@ + +## passed directly to rdiff-backup +# options = --force + +## default is 0, but set to 19 if you want to lower the priority. +# nicelevel = 19 + +## default is yes. set to no to skip the test if the remote host is alive +# testconnect = no + +###################################################### +## source section +## (where the files to be backed up are coming from) + +[source] + +# an optional subdirectory below 'directory' (see [dest]) +label = thishostname + +# only local type is currently supported +type = local + +# how many days of data to keep +# (you can also use the time format of rdiff-backup, e.g. 6D5h) +keep = 60 + +# a note about includes and excludes: +# all the excludes come after all the includes. +# otherwise, the order is not taken into account. +# currently, you cannot do "include = /" + +# files to include in the backup +# (supports globbing with '*') +include = /var/spool/cron/crontabs +include = /var/backups +include = /etc +include = /root +include = /home +include = /usr/local/bin +include = /usr/local/sbin +include = /var/lib/dpkg/status +include = /var/lib/dpkg/status-old + +# If vservers = yes in /etc/backupninja.conf then the following variable can be used: +# vsinclude = <path> +# Any path specified in vsinclude is added to the include list for each vserver +# on the system. +# e.g. vsinclude = /home will backup the /home partition in every vserver +# on the system. If you have /vservers/foo, /vservers/bar and /vservers/baz +# this vsinclude will add to the include list /vservers/foo/home, +# /vservers/bar/home and /vservers/baz/home +# Included vservers are derived from listing all vservers in $VROOTDIR (suggestions +# for improving this are encouraged). + +# files to exclude from the backup +# (supports globbing with '*') +#exclude = /home/*/.gnupg + +###################################################### +## destination section +## (where the files are copied to) + +[dest] + +# default is remote, if set to 'local' then +# ignore the 'host' and 'user' options. +type = remote + +# put the backups under this directory +directory = /backups + +# the machine which will receive the backups +host = backuphost + +# make the files owned by this user +# note: you must be able to ssh backupuser@backhost +# without specifying a password (if type = remote). +user = backupuser + diff --git a/docs/examples/example.sh b/docs/examples/example.sh new file mode 100644 index 0000000..f02f026 --- /dev/null +++ b/docs/examples/example.sh @@ -0,0 +1,2 @@ + +dpkg --get-selections > /var/backups/dpkg-selections.txt diff --git a/docs/examples/example.svn b/docs/examples/example.svn new file mode 100644 index 0000000..e849706 --- /dev/null +++ b/docs/examples/example.svn @@ -0,0 +1,23 @@ +## +## Perform a hot backup of subversion repositories. +## +## REQUIRES: apt-get install subversion-tools +## +## This file can be empty, the defaults are usually good. +## + +## where subversion data lives +# src = /var/lib/svn + +## where to save the backups to +# dest = /var/backups/svn + +## where to save temporary backups +## (if successful, $tmp is moved to $dest) +# tmp = /var/backups/svn.tmp + +## the hotbackup program to use. +# HOTBACKUP = /usr/lib/subversion/hot-backup.py + +## the name of the vserver containing svn, if using vservers +# vsname =
\ No newline at end of file diff --git a/docs/examples/example.sys b/docs/examples/example.sys new file mode 100644 index 0000000..9ebd4b2 --- /dev/null +++ b/docs/examples/example.sys @@ -0,0 +1,32 @@ +# +# this config file will save various reports of vital system information. +# by default, all the reports are enabled and are saved in /var/backups. +# +# requires dpkg, sfdisk, and hwinfo +# +# (1) a list of all the packages installed and removed. +# this file can be used to restore the state of installed packages +# by running "dpkg --set-selections < dpkg-selections.txt +# +# (2) the partition table of all disks. +# this partition table can be used to format another disk of +# the same size. this can be handy if using software raid and +# you have a disk go bad. just replace the disk and partition it +# by running "sfdisk /dev/sdb < partitions.sdb.txt" +# (MAKE SURE YOU PARTITION THE CORRECT DISK!!!) +# +# (3) hardware information. +# detailed information on most important aspects of the hardware. +# + +# here are the defaults, commented out: + +# packages = yes +# packagesfile = /var/backups/dpkg-selections.txt + +# partitions = yes +# partitionsfile = /var/backups/partitions.__star__.txt + +# hardware = yes +# hardwarefile = /var/backups/hardware.txt + diff --git a/docs/examples/example.trac b/docs/examples/example.trac new file mode 100644 index 0000000..645998e --- /dev/null +++ b/docs/examples/example.trac @@ -0,0 +1,16 @@ +## +## Perform backups of trac environment +## +## REQUIRES: apt-get install trac +## +## This file can be empty, the defaults are usually good. +## + +## where one or more Trac environments live +src = /var/lib/trac + +## where to save the backups to +dest = /var/backups/trac + +## where to save temporary backups +tmp = /var/backups/trac.tmp diff --git a/docs/gpl.txt b/docs/gpl.txt new file mode 100644 index 0000000..c968251 --- /dev/null +++ b/docs/gpl.txt @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. |