Skip to content
Snippets Groups Projects
Commit fbd0b874 authored by micah's avatar micah :speech_balloon:
Browse files

Standardize the example file format. Making the comments have the same

number of hash marks, clearly specify example settings and what the
defaults are set to.
parent 1b991d6c
Branches
No related tags found
No related merge requests found
## This is an example duplicity configuration file.
##
## Here you can find all the possible duplicity options, details of
## what the options provide and possible settings. The defaults are set
## as the commented out option, uncomment and change when
## necessary. Options which are uncommented in this example do not have
## defaults, and the settings provided are recommended.
## passed directly to duplicity, e.g. to increase verbosity set this to:
## options = --verbosity 8
##
## Default:
# options =
# passed directly to duplicity ## default is 0, but set to something like 19 if you want to lower the priority.
#options = --verbosity 8 ##
## Default:
# default is 0, but set to 19 if you want to lower the priority. # nicelevel = 0
nicelevel = 19
# default is yes. set to no to skip the test if the remote host is alive ## test the connection? set to no to skip the test if the remote host is alive
#testconnect = no ##
## Default:
# testconnect = yes
# temporary directory used by duplicity ## temporary directory used by duplicity, set to some other location if your /tmp is small
# (default = /tmp or /usr/tmp, depending on the system) ## default is either /tmp or /usr/tmp, depending on the system
#tmpdir = /var/tmp/duplicity ##
## Default:
# tmpdir = /tmp
###################################################### ######################################################
## gpg section ## gpg section
...@@ -35,23 +51,36 @@ nicelevel = 19 ...@@ -35,23 +51,36 @@ nicelevel = 19
[gpg] [gpg]
# when set to yes, encryptkey variable must be set below; if you want to use ## when set to yes, encryptkey variable must be set below; if you want to use
# two different keys for encryption and signing, you must also set the signkey ## two different keys for encryption and signing, you must also set the signkey
# variable below. ## variable below.
# default is no, for backwards compatibility with backupninja <= 0.5. ## default is set to no, for backwards compatibility with backupninja <= 0.5.
sign = yes ##
## Default:
# sign = no
# ID of the GnuPG public key used for data encryption. ## ID of the GnuPG public key used for data encryption.
# if not set, symmetric encryption is used, and data signing is not possible. ## if not set, symmetric encryption is used, and data signing is not possible.
encryptkey = 04D9EA79 ## an example setting would be:
## encryptkey = 04D9EA79
##
## Default:
# encryptkey =
# ID of the GnuPG private key used for data signing. ## ID of the GnuPG private key used for data signing.
# if not set, encryptkey will be used. ## if not set, encryptkey will be used, an example setting would be:
#signkey = 04D9EA79 ## signkey = 04D9EA79
##
## Default:
# signkey =
# password ## password
# NB: neither quote this, nor should it contain any quotes ## NB: neither quote this, nor should it contain any quotes,
password = a_very_complicated_passphrase ## an example setting would be:
## password = a_very_complicated_passphrase
##
## Default:
# password =
###################################################### ######################################################
## source section ## source section
...@@ -59,23 +88,23 @@ password = a_very_complicated_passphrase ...@@ -59,23 +88,23 @@ password = a_very_complicated_passphrase
[source] [source]
# A few notes about includes and excludes: ## A few notes about includes and excludes:
# 1. include, exclude and vsinclude statements support globbing with '*' ## 1. include, exclude and vsinclude statements support globbing with '*'
# 2. Symlinks are not dereferenced. Moreover, an include line whose path ## 2. Symlinks are not dereferenced. Moreover, an include line whose path
# contains, at any level, a symlink to a directory, will only have the ## 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 ## symlink backed-up, not the target directory's content. Yes, you have to
# dereference yourself the symlinks, or to use 'mount --bind' instead. ## dereference yourself the symlinks, or to use 'mount --bind' instead.
# Example: let's say /home is a symlink to /mnt/crypt/home ; the following ## 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 ## line will only backup a "/home" symlink ; neither /home/user nor
# /home/user/Mail will be backed-up : ## /home/user/Mail will be backed-up :
# include = /home/user/Mail ## include = /home/user/Mail
# A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to ## A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
# write : ## write :
# include = /mnt/crypt/home/user/Mail ## include = /mnt/crypt/home/user/Mail
# 3. All the excludes come after all the includes. The order is not otherwise ## 3. All the excludes come after all the includes. The order is not otherwise
# taken into account. ## taken into account.
# files to include in the backup ## files to include in the backup
include = /var/spool/cron/crontabs include = /var/spool/cron/crontabs
include = /var/backups include = /var/backups
include = /etc include = /etc
...@@ -86,20 +115,20 @@ include = /usr/local/sbin ...@@ -86,20 +115,20 @@ include = /usr/local/sbin
include = /var/lib/dpkg/status include = /var/lib/dpkg/status
include = /var/lib/dpkg/status-old include = /var/lib/dpkg/status-old
# If vservers = yes in /etc/backupninja.conf then the following variables can ## If vservers = yes in /etc/backupninja.conf then the following variables can
# be used: ## be used:
# vsnames = all | <vserver1> <vserver2> ... (default = all) ## vsnames = all | <vserver1> <vserver2> ... (default = all)
# vsinclude = <path> ## vsinclude = <path>
# vsinclude = <path> ## vsinclude = <path>
# ... ## ...
# Any path specified in vsinclude is added to the include list for each vserver ## Any path specified in vsinclude is added to the include list for each vserver
# listed in vsnames (or all if vsnames = all, which is the default). ## listed in vsnames (or all if vsnames = all, which is the default).
# ##
# For example, vsinclude = /home will backup the /home directory in every ## For example, vsinclude = /home will backup the /home directory in every
# vserver listed in vsnames. If you have 'vsnames = foo bar baz', this ## 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 ## vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
# and /vservers/baz/home. ## and /vservers/baz/home.
# Vservers paths are derived from $VROOTDIR. ## Vservers paths are derived from $VROOTDIR.
# files to exclude from the backup # files to exclude from the backup
exclude = /home/*/.gnupg exclude = /home/*/.gnupg
...@@ -110,38 +139,67 @@ exclude = /home/*/.gnupg ...@@ -110,38 +139,67 @@ exclude = /home/*/.gnupg
[dest] [dest]
# perform an incremental backup? (default = yes) ## perform an incremental backup? (default = yes)
# if incremental = no, perform a full backup in order to start a new backup set ## if incremental = no, perform a full backup in order to start a new backup set
##
## Default:
# incremental = yes # incremental = yes
# how many days of data to keep ; default is 60 days. ## how many days of data to keep ; default is 60 days.
# (you can also use the time format of duplicity) ## (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 = yes' means : do not delete old data, the remote host will take care of this
##
## Default:
# keep = 60 # keep = 60
#keep = yes
# full destination URL, in duplicity format; if set, desturl overrides ## full destination URL, in duplicity format; if set, desturl overrides
# sshoptions, destdir, desthost and destuser; it also disables testconnect and ## sshoptions, destdir, desthost and destuser; it also disables testconnect and
# bandwithlimit. For details, see duplicity manpage, section "URL FORMAT". ## bandwithlimit. For details, see duplicity manpage, section "URL FORMAT", some
#desturl = file:///usr/local/backup ## examples include:
#desturl = rsync://user@other.host//var/backup/bla ## desturl = file:///usr/local/backup
## desturl = rsync://user@other.host//var/backup/bla
# bandwith limit, in kbit/s ; default is 0, i.e. no limit ## the default value of this configuration option is not set:
#bandwidthlimit = 128 ##
## Default:
# desturl =
# passed directly to ssh, scp (and sftp in duplicity >=0.4.2) ## bandwith limit, in kbit/s ; default is 0, i.e. no limit an example
# warning: sftp does not support all scp options, especially -i; as ## setting would be:
# a workaround, you can use "-o <SSHOPTION>" ## bandwidthlimit = 128
sshoptions = -o IdentityFile=/root/.ssh/id_dsa_duplicity ##
## Default:
# bandwidthlimit = 0
## passed directly to ssh, scp (and sftp in duplicity >=0.4.2)
## warning: sftp does not support all scp options, especially -i; as
## a workaround, you can use "-o <SSHOPTION>"
## an example setting would be:
## sshoptions = -o IdentityFile=/root/.ssh/id_dsa_duplicity
##
## Default:
# sshoptions =
# put the backups under this directory ## put the backups under this directory, this must be set!
destdir = /backups ## an example setting would be:
## destdir = /backups
##
## Default:
# destdir =
# the machine which will receive the backups ## the machine which will receive the backups, this must be set!
desthost = backuphost ## an example setting would be:
## desthost = backuphost
##
## Default:
# desthost =
## make the files owned by this user
## note: you must be able to ssh backupuser@backhost
## without specifying a password (if type = remote).
## an example setting would be:
## destuser = backupuser
##
## Default:
# destuser =
# 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
## ##
## This is an example rdiff-backup configuration file. ## This is an example rdiff-backup configuration file.
## The defaults are useful in most cases, just make sure ##
## to configure the destination host and user. ## Here you can find all the possible duplicity options, details of
## what the options provide and possible settings. The defaults are set
## as the commented out option, uncomment and change when
## necessary. Options which are uncommented in this example do not have
## defaults, and the settings provided are recommended.
##
## The defaults are useful in most cases, just make sure to configure the
## destination host and user.
## ##
## passed directly to rdiff-backup ## passed directly to rdiff-backup
# options = --force ## an example setting would be:
## options = --force
##
## Default:
# options =
## default is 0, but set to 19 if you want to lower the priority. ## default is 0, but set to 19 if you want to lower the priority.
# nicelevel = 19 ## an example setting would be:
## nicelevel = 19
##
## Default
# nicelevel = 0
## default is yes. set to no to skip the test if the remote host is alive ## default is yes. set to no to skip the test if the remote host is alive
##
## Default:
# testconnect = no # testconnect = no
## default is not to limit bandwidth. ## default is not to limit bandwidth.
...@@ -18,7 +35,11 @@ ...@@ -18,7 +35,11 @@
## number to set a limit that will never be exceeded, or a positive number ## number to set a limit that will never be exceeded, or a positive number
## to set a target average bandwidth use. cstream is required. See cstream's ## to set a target average bandwidth use. cstream is required. See cstream's
## -t option for more information. 62500 bytes = 500 Kb (.5 Mb) ## -t option for more information. 62500 bytes = 500 Kb (.5 Mb)
# bwlimit = 62500 ## an example setting would be:
## bwlimit = 62500
##
## Default:
# bwlimit = 0
## should backupninja ignore the version differences between source and remote ## should backupninja ignore the version differences between source and remote
## rdiff-backup? (default: no) ## rdiff-backup? (default: no)
...@@ -28,6 +49,8 @@ ...@@ -28,6 +49,8 @@
## An example usage could be the remote side has its authorized_keys configured ## An example usage could be the remote side has its authorized_keys configured
## with command="rdiff-backup --server" to allow for restricted yet automated ## with command="rdiff-backup --server" to allow for restricted yet automated
## password-less backups ## password-less backups
##
## Default:
# ignore_version = no # ignore_version = no
###################################################### ######################################################
...@@ -36,39 +59,42 @@ ...@@ -36,39 +59,42 @@
[source] [source]
# an optional subdirectory below 'directory' (see [dest]) ## an optional subdirectory below 'directory' (see [dest])
label = thishostname label = thishostname
# type can be "local" or "remote" ## type can be "local" or "remote"
type = local type = local
# only use if '[source] type = remote' ## only use if '[source] type = remote'
# host = srchost # host = srchost
# user = srcuser # user = srcuser
# how many days of data to keep ## how many days of data to keep
# (you can also use the time format of rdiff-backup, e.g. 6D5h) ## (you can also use the time format of rdiff-backup, e.g. 6D5h)
# (to keep everything, set this to yes) ## (to keep everything, set this to yes)
#keep = yes ## an example setting would be:
keep = 60 ##keep = yes
##
# A few notes about includes and excludes: ## Default:
# 1. include, exclude and vsinclude statements support globbing with '*' # keep = 60
# 2. Symlinks are not dereferenced. Moreover, an include line whose path
# contains, at any level, a symlink to a directory, will only have the ## A few notes about includes and excludes:
# symlink backed-up, not the target directory's content. Yes, you have to ## 1. include, exclude and vsinclude statements support globbing with '*'
# dereference yourself the symlinks, or to use 'mount --bind' instead. ## 2. Symlinks are not dereferenced. Moreover, an include line whose path
# Example: let's say /home is a symlink to /mnt/crypt/home ; the following ## contains, at any level, a symlink to a directory, will only have the
# line will only backup a "/home" symlink ; neither /home/user nor ## symlink backed-up, not the target directory's content. Yes, you have to
# /home/user/Mail will be backed-up : ## dereference yourself the symlinks, or to use 'mount --bind' instead.
# include = /home/user/Mail ## Example: let's say /home is a symlink to /mnt/crypt/home ; the following
# A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to ## line will only backup a "/home" symlink ; neither /home/user nor
# write : ## /home/user/Mail will be backed-up :
# include = /mnt/crypt/home/user/Mail ## include = /home/user/Mail
# 3. All the excludes come after all the includes. The order is not otherwise ## A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
# taken into account. ## write :
## include = /mnt/crypt/home/user/Mail
# files to include in the backup ## 3. All the excludes come after all the includes. The order is not otherwise
## taken into account.
## files to include in the backup
include = /var/spool/cron/crontabs include = /var/spool/cron/crontabs
include = /var/backups include = /var/backups
include = /etc include = /etc
...@@ -79,23 +105,23 @@ include = /usr/local/sbin ...@@ -79,23 +105,23 @@ include = /usr/local/sbin
include = /var/lib/dpkg/status include = /var/lib/dpkg/status
include = /var/lib/dpkg/status-old include = /var/lib/dpkg/status-old
# If vservers = yes in /etc/backupninja.conf then the following variables can ## If vservers = yes in /etc/backupninja.conf then the following variables can
# be used: ## be used:
# vsnames = all | <vserver1> <vserver2> ... (default = all) ## vsnames = all | <vserver1> <vserver2> ... (default = all)
# vsinclude = <path> ## vsinclude = <path>
# vsinclude = <path> ## vsinclude = <path>
# ... ## ...
# Any path specified in vsinclude is added to the include list for each vserver ## Any path specified in vsinclude is added to the include list for each vserver
# listed in vsnames (or all if vsnames = all, which is the default). ## listed in vsnames (or all if vsnames = all, which is the default).
# ##
# For example, vsinclude = /home will backup the /home directory in every ## For example, vsinclude = /home will backup the /home directory in every
# vserver listed in vsnames. If you have 'vsnames = foo bar baz', this ## 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 ## vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
# and /vservers/baz/home. ## and /vservers/baz/home.
# Vservers paths are derived from $VROOTDIR. ## Vservers paths are derived from $VROOTDIR.
# files to exclude from the backup ## files to exclude from the backup
#exclude = /home/*/.gnupg exclude = /home/*/.gnupg
###################################################### ######################################################
## destination section ## destination section
...@@ -103,18 +129,35 @@ include = /var/lib/dpkg/status-old ...@@ -103,18 +129,35 @@ include = /var/lib/dpkg/status-old
[dest] [dest]
# type can be "local" or "remote" ## type can be "local" or "remote", this must be set!
type = remote ## an example configuration would be:
## type = remote
##
## Default:
# type =
# put the backups under this directory ## put the backups under this directory, this must be set!
directory = /backups ## an example setting would be:
## directory = /backups
##
## Default:
# directory =
# the machine which will receive the backups. ## the machine which will receive the backups.
# only use if "[dest] type = remote" ## only use if "[dest] type = remote"
host = backuphost ## an example setting would be:
## host = backuphost
##
## Default
# host =
## make the files owned by this user. you must be able to
## `su -c "ssh backupuser@backhost"` without specifying a password.
## only use if "[dest] type = remote"
## an example setting would be:
## user = backupuser
##
## Default:
# user =
# make the files owned by this user. you must be able to
# `su -c "ssh backupuser@backhost"` without specifying a password.
# only use if "[dest] type = remote"
user = backupuser
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment