######################################################
## gpg section
-## (how to encrypt and optionnally sign the backups)
+## (how to encrypt and optionally sign the backups)
##
-## WARNING: old (pre-0.9.2) example.dup used to give wrong information about
-## the way the following options are used. Please read ahead
+## WARNING: old (pre-0.9.4) example.dup used to give wrong information about
+## the way the following options are used. Please read the following
## carefully.
##
## If the encryptkey variable is set:
## - data is encrypted with the GnuPG public key specified by the encryptkey
## variable
-## - if signing is enabled, the password variable is used to unlock the GnuPG
-## private key used for signing; else, you do not need to set the password
-## variable
+## - if signing is enabled, data is signed with the GnuPG private
+## key specified by the signkey variable
+## - the password variable is used to unlock the GnuPG key(s) used
+## for encryption and (optionnal) signing
+##
## If the encryptkey option is not set:
## - data signing is not possible
## - the password variable is used to encrypt the data with symmetric
[gpg]
-# when set to yes, encryptkey variable must be set bellow; 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
-# variable bellow.
-# default is no, for backward compatibility with backupninja <= 0.5.
+# variable below.
+# default is no, for backwards compatibility with backupninja <= 0.5.
sign = yes
# ID of the GnuPG public key used for data encryption.
#signkey = 04D9EA79
# password
-# NB: do not quote it, and it should not contain any quote
+# NB: neither quote this, nor should it contain any quotes
password = a_very_complicated_passphrase
######################################################
[source]
-# files to include in the backup
-# (supports globbing with '*')
+# A few notes about includes and excludes:
+# 1. include, exclude and vsinclude statements support globbing with '*'
+# 2. 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
+# 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/backups
include = /etc
# vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
# and /vservers/baz/home.
# Vservers paths are derived from $VROOTDIR.
-# vsinclude supports globbing with '*'.
# files to exclude from the backup
-# (supports globbing with '*')
exclude = /home/*/.gnupg
######################################################
# 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
+# 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>"
+sshoptions = -o IdentityFile=/root/.ssh/id_dsa_duplicity
# put the backups under this directory
destdir = /backups