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