################################################## # Configuration file for backup2l # ################################################## # Define the backup2l version for which the configuration file is written. # This way, future versions can automatically warn if the syntax has changed. FOR_VERSION=1.5 ################################################## # Volume identification # This is the prefix for all output files; # multiple volumes can be handled by using different configuration files VOLNAME="all" ################################################## # Source files # List of directories to make backups of. # All paths MUST be absolute and start with a '/'! #SRCLIST=(/etc /root /home /var/mail /usr/local) SRCLIST=(/etc /root /home /usr/local/bin /usr/local/sbin /mnt/part3/kamera /var/www) # The following expression specifies the files not to be archived. # See the find(1) man page for further info. It is discouraged to # use anything different from conditions (e. g. actions) as it may have # unforeseeable side effects. # This example skips all files and directories with a path name containing # '.nobackup' and all .o files: #SKIPCOND=(-path "*.nobackup*" -o -name "*.o") #SKIPCOND=(-path "*.nobackup*" -o -name ".xsession-errors*" -o -name "logfile*" -o -path "*/.cache/*" -o -path "*/.opera/cache/*" -o -path "*/.opera/opcache/*" -o -path "*/.opera/icons/*" -o -path "*/.mozilla/*/*/Cache/*" -o -path "*/.googleearth/Cache/*" -o -path "*/.adobe/Acrobat/*/Cache/*" -o -path "*/.local/share/Trash/*" -o -path "*/.cache/*" -o -path "*/.fontconfig/*" -o -path "*/.local/share/geeqie/trash/*" -o -path "*/.oneswarm/metainfo/*" -o -path "*/.oneswarm/active/*" -o -path "*/.off/blockcache/*" -o -path "*/.nexuiz/data/dlcache/*") SKIPCOND=(-path "*.nobackup*" -o -name ".xsession-errors*" -o -name "logfile*" -o -path "*cache/*" -o -path "*icons/*" -o -path "*Cache/*" -o -path "*Trash/*" -o -path "*fontconfig/*" -o -path "*trash/*" -o -path "*metainfo/*" -o -path "*active/*" -o -path "*Flash_Player/*" -o -path "*/tmp/*" -o -path "*/baseq3/*") # Some background on 'SKIPCOND': The method of using a find(1) expression to determine # files to backup or to skip is very powerful. Some of the following examples result from feature # requests by various users who were not always aware that their "feature" was already implemented. ;-) # # If you want to exclude several directories use the following expression: # SKIPCOND=(-path '/path1' -o -path '/path1/*' -o -path '/path2' -o -path '/path2/*') # # If you do not have anything to skip, use: # SKIPCOND=(-false) # "SKIPCOND=()" does not work # # To skip directory trees (for performance reasons) you can add the '-prune' action to your SKIPCOND setting, e.g.: # SKIPCOND=( -name "unimportant_dir" -prune ) # # To prevent backup2l from crossing filesystem boundaries you can add '-xdev' to your SKIPCOND setting. ################################################## # Destination # Mount point of backup device (optional) #BACKUP_DEV="/disk2" BACKUP_DEV="/mnt/freeagent" # Destination directory for backups; # it must exist and must not be the top-level of BACKUP_DEV #BACKUP_DIR="/disk2/backup" BACKUP_DIR="/mnt/freeagent/backup" ################################################## # Backup parameters # Number of levels of differential backups (1..9) MAX_LEVEL=3 # Maximum number of differential backups per level (1..9) MAX_PER_LEVEL=8 # Maximum number of full backups (1..8) MAX_FULL=2 # For differential backups: number of generations to keep per level; # old backups are removed such that at least GENERATIONS * MAX_PER_LEVEL # recent versions are still available for the respective level GENERATIONS=1 # If the following variable is 1, a check file is automatically generated CREATE_CHECK_FILE=1 ################################################## # Pre-/Post-backup functions # This user-defined bash function is executed before a backup is made PRE_BACKUP () { echo " pre-backup: nothing to do" # e. g., shut down some mail/db servers if their files are to be backup'ed # On a Debian system, the following statements dump a machine-readable list of # all installed packages to a file. #echo " writing dpkg selections to /root/dpkg-selections.log..." #dpkg --get-selections | diff - /root/dpkg-selections.log > /dev/null || dpkg --get-selections > /root/dpkg-selections.log } # This user-defined bash function is executed after a backup is made POST_BACKUP () { # e. g., restart some mail/db server if its files are to be backup'ed echo " post-backup: nothing to do" } ################################################## # Misc. # Create a backup when invoked without arguments? AUTORUN=0 # Size units SIZE_UNITS="" # set to "B", "K", "M" or "G" to obtain unified units in summary list # Remove this line after the setup is finished. UNCONFIGURED=0 # Archive driver for new backups (optional, default = "DRIVER_TAR_GZ") #CREATE_DRIVER="DRIVER_MY_AFIOZ" # Usable built-in drivers for CREATE_DRIVER: # DRIVER_TAR, DRIVER_TAR_GZ, DRIVER_TAR_BZ2, DRIVER_AFIOZ ################################################## # User-defined archive drivers (optional) # This section demonstrates how user-defined archive drivers can be added. # The example shows a modified version of the "afioz" driver with some additional parameters # one may want to pass to afio in order to tune the speed, archive size etc. . # An archive driver consists of a bash function named # "DRIVER_" implementing the (sometimes simple) operations "-test", "-suffix", # "-create", "-toc", and "-extract". # registering custom drivers below for use as CREATE_DRIVER (optional) #USER_DRIVER_LIST="DRIVER_MY_AFIOZ DRIVER_MY_AFIOBZ2 DRIVER_MY_AFIO_BZ2" DRIVER_MY_AFIOZ () { case $1 in -test) # This function should check whether all prerequisites are met, especially if all # required tools are installed. This prevents backup2l to fail in inconvenient # situations, e. g. during a backup or restore operation. If everything is ok, the # string "ok" should be returned. Everything else is interpreted as a failure. require_tools afio # The function 'require_tools' checks for the existence of all tools passed as # arguments. If one of the tools is not found by which(1), an error message is # displayed and the function does not return. echo "ok" ;; -suffix) # This function should return the suffix of backup archive files. If the driver #ädoes not create a file (e. g. transfers the backup data immediately to a tape # or network device), an empty string has to be returned. backup2l uses this suffix # to select a driver for unpacking. If a user-configured driver supports the same # suffix as a built-in driver, the user driver is preferred (as in this case). echo "afioz" ;; -create) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file # This function is called to create a backup file. The argument $3 is the full file # name of the archive file including path and suffix. $4 contains an alphabetically # sorted list of files (full pathname) to be backed up. Directories are not contained, # they are handled by backup2l directly without using the driver. # All output to stderr should be directed to stdout ("2>&1"). afio -Zo -G 9 -M 30m -T 2k $3 < $4 2>&1 # This line passes some additional options to afio (see afio(1)): # '-G 9' maximizes the compression by gzip. # '-M 30m' increases the size of the internal file buffer. Larger files have to # be compressed twice. # '-T 2k' prevents the compression of files smaller than 2k in order to save time. ;; -toc) # Arguments: $2 = BID, $3 = archive file name # This function is used to validate the correct generation of an archive file. # The output is compared to the list file passed to the '-create' function. # Any difference is reported as an error. afio -Zt $3 | sed 's#^#/#' # The sed command adds a leading slash to each entry. ;; -extract) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file # This function is called by backup2l's restore procedure for each archive. # It is extremely important that only those files contained in $4 are restored. # Otherwise it may happen that files are overwritten by incorrect (e. g. older) # versions of the same file. afio -Zinw $4 $3 2>&1 ;; esac } ################################################## # More sample archive drivers (optional) # This is an unordered collection of drivers that may be useful for you, # either to use them directly or to derive own drivers. # Here's a version of the standard DRIVER_TAR_GZ driver, # modified to split the output archive file into multiple sections. # (donated by Michael Moedt) DRIVER_TAR_GZ_SPLIT () { case $1 in -test) require_tools tar split cat echo "ok" ;; -suffix) echo "tgz_split" ;; -create) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file mkdir -p ${3} tar cz -T $4 --no-recursion | split --bytes=725100100 - ${3}/part_ ;; -toc) # Arguments: $2 = BID, $3 = archive file name cat ${3}/part_* | tar tz | sed 's#^#/#' ;; -extract) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file cat ${3}/part_* | tar xz --same-permission --same-owner -T $4 2>&1 ;; esac } # This driver uses afio and bzip2, where bzip2 is invoked by afio. # (donated by Carl Staelin) DRIVER_MY_AFIOBZ2 () { case $1 in -test) require_tools afio bzip2 echo "ok" ;; -suffix) echo "afio-bz2" ;; -create) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file afio -z -1 m -P bzip2 -Q -9 -Z -M 50m -T 1k -o $3 <$4 2>&1 # This line passes some additional options to afio (see afio(1)): # '-P bzip2' utilizes bzip2 as an external compressor # '-Q 9' maximizes the compression by bzip2. # '-M 50m' increases the size of the internal file buffer. Larger files have to # be compressed twice. # '-T 1k' prevents the compression of files smaller than 1k in order to save time. ;; -toc) # Arguments: $2 = BID, $3 = archive file name afio -t -Z -P bzip2 -Q -d - <$3 | sed 's#^#/#' # The sed command adds a leading slash to each entry. ;; -extract) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file afio -Zinw $4 -P bzip2 -Q -d - <$3 2>&1 ;; esac } # This driver uses afio and bzip2, such that the I/O stream is piped through bzip2. # (donated by Carl Staelin) DRIVER_MY_AFIO_BZ2 () { case $1 in -test) require_tools afio bzip2 echo "ok" ;; -suffix) echo "afio.bz2" ;; -create) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file afio -o - < $4 | bzip2 --best > $3 2>&1 ;; -toc) # Arguments: $2 = BID, $3 = archive file name bzip2 -d < $3 | afio -t - | sed 's#^#/#' # The sed command adds a leading slash to each entry. ;; -extract) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file bzip2 -d < $3 | afio -inw $4 - 2>&1 ;; esac } # This driver uses the Info-ZIP tools to generate zip files. Unfourtunately unzip # expects all file names to be on the command line. So unless there is a work- # around it's not possible to use the "-extract" command. # (donated by Georg Lutz) DRIVER_ZIP () { case $1 in -test) require_tools zip echo "ok" ;; -suffix) echo "zip" ;; -create) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file cat $4| zip -qy $3 -@ ;; -toc) # Arguments: $2 = BID, $3 = archive file name zipinfo -1 $3| sed 's#^#/#' ;; -extract) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file echo "Not implemented yet! Sorry." #unzip $3 ;; esac } # This driver uses tar and pipes the output trough gnupg. You can specifiy # the passphrase in a file (/etc/backup2l.pass in the example). You have to # invoke gpg at least one time before backup because gnupg has to initiate # first thing in the home directory. DRIVER_TAR_GPG () { case $1 in -test) require_tools tar gpg echo "ok" ;; -suffix) echo "tar.pgp" ;; -create) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file tar -c -T $4 --no-recursion | /usr/bin/gpg --batch --no-tty -q --passphrase-fd 3 3 $3 ;; -toc) # Arguments: $2 = BID, $3 = archive file name /usr/bin/gpg --batch --no-tty -q --passphrase-fd 3 3/dev/null | tar t | sed 's#^#/#' ;; -extract) # Arguments: $2 = BID, $3 = archive file name, $4 = file list file /usr/bin/gpg --batch --no-tty -q --passphrase-fd 3 3/dev/null | tar -x --same-permission --same-owner -f $3 -T $4 2>&1 ;; esac }