Files
RIBS/dist/etc/ribs/conf-available/ribs.config.sample

125 lines
4.7 KiB
Plaintext

# Configuration file for Rod's Incremental Backup System
# Version 1.3.2
# ************************** General Options ***************************
#
# All of the options in the genera options section must be defined.
#
# ********************
# Dry run - Set to false for normal mode or true for testing.
#
DRY_RUN=true
#
# ********************
# Source directory - The directory where files to be backed up are
# located. This must be an absolute, not a relative path. If the
# trailing slash is included, the contents of the directory will be
# backed up. If not, the directory itself will be backed up.
# NOTE: Special characters must be escaped with backslashes!
#
SRC="/var/www/"
#
# ********************
# Backup root directory - The directory on the backup storage where the
# backups are stored. For OFFLINE storage, this is the mount point of
# the backup drive filesystem. For REMOTE storage, this is the path on
# the remote server. Must be writable to user running ribs. This must
# be an absolute, not a relative path. Directories named as the date
# of the backups will be created here containing the backed up files.
# NOTE: Special characters must be escaped with backslashes!
#
BACKUP_ROOT="/mnt/incremental_backup_dir"
#
# ********************
# Backup subdirectory - A subdirectory of BACKUP_ROOT in which to store
# the backup date directories. To just put the date directories
# directly in BACKUP_ROOT, set this to blank ("").
# NOTE: Special characters must be escaped with backslashes!
#
BACKUP_SUBDIR=""
#BACKUP_SUBDIR="/main"
#
# ********************
# Exclude list - List of file patterns to exclude, separated by
# newlines. Anything in the source directory that matches a pattern in
# this list will not be backed up. If you don't want to exclude
# anything from the backup, set this to blank ("").
# NOTE: Special characters must be escaped with backslashes unless
# they represent a wildcard in a pattern!
#
EXCLUDE_LIST=""
#EXCLUDE_LIST="
#DatabaseBackups-*
#somehugedir
#secretstuff
#"
#
# ********************
# Day limit - The number of days of backups to keep. When the backup is
# complete, directories with dates older than this limit will be
# deleted.
#
DAY_LMT=90
#
# ********************
# Storage type - Where the backups are to be stored. Only one of the
# three options should be specified. Set the option you want, then
# refer to the appropriate section below for that specific
# configuration. Possible values are:
# LOCAL - Back up to a local directory. Can also be anything already
# mounted on the local filesystem.
# OFFLINE - Back up to offline storage that must be mounted. Can be
# anything that you can mount and unmount, including a filesystem
# on a local block device or a remote NFS or CIFS/SMB share.
# REMOTE - Back up to a remote system directly via rsync. If you use
# this, you must define REMOTE_USER_HOST below and setup pubkey
# authentication vi ssh for the remote user and host.
#
STORAGE_TYPE="REMOTE"
#
# **********************************************************************
# ******************* Options for LOCAL storage type *******************
#
# There are no specific settings for the local storage type.
#
# **********************************************************************
# ****************** Options for OFFLINE storage type ******************
#
# Leave this entire section commented out for LOCAL or REMOTE storage.
#
# Mount parameters - Storage filesystem mount parameters. Should be what
# you'd type on the command line between the word "mount" and the
# mountpoint. See the manual page for the mount command (man 8 mount)
# for the available options.
#
#MOUNT_PARAMETERS="-t nfs nfsserver:/srv/ribs-backups"
#MOUNT_PARAMETERS="-t ext4 -U 433a2e61-25aa-4da5-a7c7-4d730a5793e7"
#MOUNT_PARAMETERS="/dev/sdc1"
#
# Remount read-only - Set this to true if storage should be remounted in
# read-only mode when not being used for backups.
#
#REMOUNT_RO=true
#REMOUNT_RO=false
#
# **********************************************************************
# ****************** Options for REMOTE storage type *******************
#
# Leave this entire section commented out for LOCAL or OFFLINE storage.
#
# Remote user and host - The user and host to connect to for backup
# storage. If you want RIBS to be able to run unattended, for example
# as a cron job, you will need to ensure that the user's ssh public
# key is listed in the remote host's authorized_keys file. This is
# usually done with the ssh-copy-id command, which also takes care of
# adding the host's key fingerprint to the local known_hosts file.
#
REMOTE_USER_HOST="user@backupserver"
#
# **********************************************************************