examples/example.dup

   1 ## This is an example duplicity configuration file.
   2 ##
   3 ## Here you can find all the possible duplicity options, details of
   4 ## what the options provide and possible settings. The defaults are set
   5 ## as the commented out option, uncomment and change when
   6 ## necessary. Options which are uncommented in this example do not have
   7 ## defaults, and the settings provided are recommended.
   8
   9 ## passed directly to duplicity, e.g. to increase verbosity set this to:
  10 ## options = --verbosity 8
  11 ## when using the Amazon S3 backend to create buckets in Europe:
  12 ## options = --s3-european-buckets --s3-use-new-style
  13 ##
  14 ## Default:
  15 # options =
  16
  17 ## default is 0, but set to something like 19 if you want to lower the priority.
  18 ##
  19 ## Default:
  20 # nicelevel = 0
  21
  22 ## test the connection? set to no to skip the test if the remote host is alive
  23 ##
  24 ## Default:
  25 # testconnect = yes
  26
  27 ## temporary directory used by duplicity, set to some other location if your /tmp is small
  28 ## default is either /tmp or /usr/tmp, depending on the system
  29 ##
  30 ## Default:
  31 # tmpdir = /tmp
  32
  33 ######################################################
  34 ## gpg section
  35 ## (how to encrypt and optionally sign the backups)
  36 ##
  37 ## WARNING: old (pre-0.9.4) example.dup used to give wrong information about
  38 ##          the way the following options are used. Please read the following
  39 ##          carefully.
  40 ##
  41 ## If the encryptkey variable is set:
  42 ##   - data is encrypted with the GnuPG public key specified by the encryptkey
  43 ##     variable
  44 ##   - if signing is enabled, data is signed with the GnuPG private
  45 ##     key specified by the signkey variable
  46 ##   - the password variable is used to unlock the GnuPG key(s) used
  47 ##     for encryption and (optionnal) signing
  48 ##
  49 ## If the encryptkey option is not set:
  50 ##   - data signing is not possible
  51 ##   - the password variable is used to encrypt the data with symmetric
  52 ##     encryption: no GnuPG key pair is needed
  53
  54 [gpg]
  55
  56 ## when set to yes, encryptkey variable must be set below; if you want to use
  57 ## two different keys for encryption and signing, you must also set the signkey
  58 ## variable below.
  59 ## default is set to no, for backwards compatibility with backupninja <= 0.5.
  60 ##
  61 ## Default:
  62 # sign = no
  63
  64 ## ID of the GnuPG public key used for data encryption.
  65 ## if not set, symmetric encryption is used, and data signing is not possible.
  66 ## an example setting would be:
  67 ## encryptkey = 04D9EA79
  68 ##
  69 ## Default:
  70 # encryptkey =
  71
  72 ## ID of the GnuPG private key used for data signing.
  73 ## if not set, encryptkey will be used, an example setting would be:
  74 ## signkey = 04D9EA79
  75 ##
  76 ## Default:
  77 # signkey =
  78
  79 ## password
  80 ## NB: neither quote this, nor should it contain any quotes,
  81 ## an example setting would be:
  82 ## password = a_very_complicated_passphrase
  83 ##
  84 ## Default:
  85 # password =
  86
  87 ######################################################
  88 ## source section
  89 ## (where the files to be backed up are coming from)
  90
  91 [source]
  92
  93 ## A few notes about includes and excludes:
  94 ## 1. include, exclude and vsinclude statements support globbing with '*'
  95 ## 2. Symlinks are not dereferenced. Moreover, an include line whose path
  96 ##    contains, at any level, a symlink to a directory, will only have the
  97 ##    symlink backed-up, not the target directory's content. Yes, you have to
  98 ##    dereference yourself the symlinks, or to use 'mount --bind' instead.
  99 ##    Example: let's say /home is a symlink to /mnt/crypt/home ; the following
 100 ##    line will only backup a "/home" symlink ; neither /home/user nor
 101 ##    /home/user/Mail will be backed-up :
 102 ##      include = /home/user/Mail
 103 ##    A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
 104 ##    write :
 105 ##      include = /mnt/crypt/home/user/Mail
 106 ## 3. All the excludes come after all the includes. The order is not otherwise
 107 ##    taken into account.
 108
 109 ## files to include in the backup
 110 include = /var/spool/cron/crontabs
 111 include = /var/backups
 112 include = /etc
 113 include = /root
 114 include = /home
 115 include = /usr/local/bin
 116 include = /usr/local/sbin
 117 include = /var/lib/dpkg/status
 118 include = /var/lib/dpkg/status-old
 119
 120 ## If vservers = yes in /etc/backupninja.conf then the following variables can
 121 ## be used:
 122 ## vsnames = all | <vserver1> <vserver2> ... (default = all)
 123 ## vsinclude = <path>
 124 ## vsinclude = <path>
 125 ## ...
 126 ## Any path specified in vsinclude is added to the include list for each vserver
 127 ## listed in vsnames (or all if vsnames = all, which is the default).
 128 ##
 129 ## For example, vsinclude = /home will backup the /home directory in every
 130 ## vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
 131 ## vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
 132 ## and /vservers/baz/home.
 133 ## Vservers paths are derived from $VROOTDIR.
 134
 135 # files to exclude from the backup
 136 exclude = /home/*/.gnupg
 137
 138 ######################################################
 139 ## destination section
 140 ## (where the files are copied to)
 141
 142 [dest]
 143
 144 ## perform an incremental backup? (default = yes)
 145 ## if incremental = no, perform a full backup in order to start a new backup set
 146 ##
 147 ## Default:
 148 # incremental = yes
 149
 150 ## how many days of data to keep ; default is 60 days.
 151 ## (you can also use the time format of duplicity)
 152 ## 'keep = yes' means : do not delete old data, the remote host will take care of this
 153 ##
 154 ## Default:
 155 # keep = 60
 156
 157 ## full destination URL, in duplicity format; if set, desturl overrides
 158 ## sshoptions, destdir, desthost and destuser; it also disables testconnect and
 159 ## bandwithlimit. For details, see duplicity manpage, section "URL FORMAT", some
 160 ## examples include:
 161 ## desturl = file:///usr/local/backup
 162 ## desturl = rsync://user@other.host//var/backup/bla
 163 ## desturl = s3+http://
 164 ## the default value of this configuration option is not set:
 165 ##
 166 ## Default:
 167 # desturl =
 168
 169 ## Amazon Web Services Access Key ID and Secret Access Key, needed for backups
 170 ## to S3 buckets.
 171 ## awsaccesskeyid = YOUR_AWS_ACCESS_KEY_ID
 172 ## awssecretaccesskey = YOUR_AWS_SECRET_KEY
 173 ##
 174 ## Default:
 175 # awsaccesskeyid =
 176 # awssecretaccesskey =
 177
 178 ## bandwith limit, in kbit/s ; default is 0, i.e. no limit an example
 179 ## setting would be:
 180 ## bandwidthlimit = 128
 181 ##
 182 ## Default:
 183 # bandwidthlimit = 0
 184
 185 ## passed directly to ssh, scp (and sftp in duplicity >=0.4.2)
 186 ## warning: sftp does not support all scp options, especially -i; as
 187 ## a workaround, you can use "-o <SSHOPTION>"
 188 ## an example setting would be:
 189 ## sshoptions = -o IdentityFile=/root/.ssh/id_dsa_duplicity
 190 ##
 191 ## Default:
 192 # sshoptions =
 193
 194 ## put the backups under this directory, this must be set!
 195 ## an example setting would be:
 196 ## destdir = /backups
 197 ##
 198 ## Default:
 199 # destdir =
 200
 201 ## the machine which will receive the backups, this must be set!
 202 ## an example setting would be:
 203 ## desthost = backuphost
 204 ##
 205 ## Default:
 206 # desthost =
 207
 208 ## make the files owned by this user
 209 ## note: you must be able to ssh backupuser@backhost
 210 ## without specifying a password (if type = remote).
 211 ## an example setting would be:
 212 ## destuser = backupuser
 213 ##
 214 ## Default:
 215 # destuser =
 216
 217