# -*- shell-script -*- # This is a sample config file for the backup system. Tailor it to your # needs and remove the line below: echo >&2 "$0: WARNING: using default configuration boilerplate" # This file is essentially a shell script defining variables used by # the backup scripts. For a detailed information about it see backup.conf(5) # To debug the configuration, run "backup --dry-run" and "restore --dry-run". # For a detailed descriptions of these commands, see backup(1). # When set, the prologue hook is called right before starting backup or # restore. Similarly, the epilogue_hook is called immediately after # finishing all operations. # Use these hooks to perform any preliminary and/or cleanup jobs that # might be necessary in your setup. # When set, these variables must point to shell functions taking no # arguments. The best place to define such functions is perhaps in this # configuration file as well. # # By default, both variables are empty, i.e. no hooks are executed. prologue_hook= epilogue_hook= ########################################################################## # Archivation setup ########################################################################## # Interval in weeks during which old backups and snapshots are retained. # If zero or empty, backups are retained forever. backup_retain_interval= ########################################################################## # S3 configuration. ########################################################################## # To use S3 as the backup storage, define this variable to the name of the # bucket to keep backups in. backup_bucket_name= # Mountpoint for the raw bucket. #backup_mp_s3backer=/mnt/s3backer # Mountpoint for the actual file system. #backup_mp_s3=/mnt/s3 ########################################################################## # Tar setup. # # Tar setup variables configure invocation of tar. # ########################################################################## # Any additional options to pass to tar. Do not place tar operation # switches (as -c, -t, etc.) here! These will be added automatically # by appropriate scripts, depending on the operation being performed. # # By default this variable is empty (no additional options). # # In this example it is used to request bzip2 compression: backup_tar_options="-j" # Suffix for archive files. # Default is "tar" # backup_suffix="tar.bz2" # Directory where archive files are to be located. It's OK to specify # a remote directory here, e.g. 10.10.0.1:/export/backup # # This variable must be set. Whatever directory it points to must already # exist, the backup script won't create it. backup_archive_dir=/var/run # Directory where to store snapshot files. The files will be named as # their archive counterparts, with the suffix ".db". # # This variable must be set backup_snapshot_dir=/var/run # Set this variable to a non-empty value if you wish backup procedures to # be verbose. backup_verbose= ########################################################################## # Backup items. # # Backup items are symbolic names that identify abstract objects that # need to be backed up (or restored). These must be valid shell variable # names. For each backup item , this configuration file defines a # set of variables which determine what files to backup and what methods # to use for that. Each such variable is named _, where # is the item name, and is the variable name. The set # of variables needed depends on the type of each particular item. # ########################################################################## # The following are sample entries. Be sure to edit them # Define the list of items to back up. # This variable must be set. backup_items="dbdump system" # For each item in $backup_items, at least its type (variable _type) # must be declared. The item type determines the mechanism used to backup # and restore it. Valid item types are: # # fs back up a file system # postgres back up a postgres database # # You may define additional types, if you need. To do so, create an executable # file named .sh in the directory @LIBDIR@/backup. See backup_type(5), # for a detailed description. # # Dump Postgres database "mydb". # The _database is the only variable required by type "postgres". dbdump_type=postgres dbdump_database="mydb" # Back up directories in the file system. # The "fs" type requires at least to variables: # # _dir specifies the directory (usually, but not necessarily a mount # point), under which the directories and files to be backed up are located. # # _files specifies a list of directories and/or files in that directory. system_type=fs system_dir="/" system_files="etc var/spool"