X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=examples%2Fexample.dup;h=52aea1781608f749d85c5fbc9c12577d68fdad79;hb=38642e9c0f902e3d7de1fa1154a9561ed0ef042c;hp=7db77710c755167cb68634c69604d2ef05a99a68;hpb=c4785ba5edb9738f7e9da8c4086a4b6984515dd2;p=matthijs%2Fupstream%2Fbackupninja.git

diff --git a/examples/example.dup b/examples/example.dup
index 7db7771..52aea17 100644
--- a/examples/example.dup
+++ b/examples/example.dup
@@ -11,21 +11,42 @@ nicelevel = 19
 ######################################################
 ## gpg section
 ## (how to encrypt and optionnally 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
+##          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 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
-
+# when set to yes, encryptkey variable must be set bellow; 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.
-# when set to yes, encryptkey option must be set below.
 sign = yes
 
-# key ID used for data encryption and, optionnally, signing.
-# if not set, local root's default gpg 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
 
+# ID of the GnuPG private key used for data signing.
+# if not set, encryptkey will be used.
+#signkey = 04D9EA79
+
+# password
+# NB: do not quote it, and it should not contain any quote
+password = a_very_complicated_passphrase
+
 ######################################################
 ## source section
 ## (where the files to be backed up are coming from)
@@ -66,7 +87,7 @@ include = /var/lib/dpkg/status-old
 # 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
+# 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.