dup: checked that bandwidthlimit still works with duplicity 0.4.2, reflected
[matthijs/upstream/backupninja.git] / examples / example.dup
index 88ac28c2287d93fcf56d75b02f21950da6653ac2..b90655140c1b56626eb3f6fc2fd6ea82f11d9a66 100644 (file)
@@ -10,26 +10,45 @@ nicelevel = 19
 
 ######################################################
 ## gpg section
-## (how to encrypt and optionnally sign the backups)
+## (how to encrypt and optionally sign the backups)
+##
+## 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, 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
+##     encryption: no GnuPG key pair is needed
 
 [gpg]
 
-# passphrase needed to unlock the GnuPG key
-# NB: do not quote it, and it should not contain any quote
-password = a_very_complicated_passphrase
-
-# default is no, for backward compatibility with backupninja <= 0.5.
-# when set to yes, either signkey or encryptkey option must be set below.
+# 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 below.
+# default is no, for backwards compatibility with backupninja <= 0.5.
 sign = yes
 
-# key ID used for data encryption.
-# if not set, local root's default GnuPG key is used.
+# ID of the GnuPG public key used for data encryption.
+# if not set, symmetric encryption is used, and data signing is not possible.
 encryptkey = 04D9EA79
 
-# key ID used for data signing.
+# ID of the GnuPG private key used for data signing.
 # if not set, encryptkey will be used.
 #signkey = 04D9EA79
 
+# password
+# NB: neither quote this, nor should it contain any quotes
+password = a_very_complicated_passphrase
+
 ######################################################
 ## source section
 ## (where the files to be backed up are coming from)
@@ -38,20 +57,6 @@ encryptkey = 04D9EA79
 
 # files to include in the backup
 # (supports globbing with '*')
-# BIG FAT WARNING
-# 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
 
 include = /var/spool/cron/crontabs
 include = /var/backups
@@ -67,15 +72,18 @@ include = /var/lib/dpkg/status-old
 # be used:
 # vsnames = all | <vserver1> <vserver2> ... (default = all)
 # vsinclude = <path>
+# vsinclude = <path>
+# ...
 # Any path specified in vsinclude is added to the include list for each vserver
-# listed in vsnames (or all if vsnames = all).
-# E.g. vsinclude = /home will backup the /home partition in every 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 and
-# /vservers/baz/home.
+# listed in vsnames (or all if vsnames = all, which is the default).
+#
+# For example, vsinclude = /home will backup the /home directory in every
+# 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
+# and /vservers/baz/home.
 # Vservers paths are derived from $VROOTDIR.
+# vsinclude supports globbing with '*'.
 
-# rdiff-backup specific comment, TO ADAPT
 # files to exclude from the backup
 # (supports globbing with '*')
 exclude = /home/*/.gnupg