2021-01-22 17:24:14 +01:00
|
|
|
## This is an example duplicity configuration file.
|
2009-08-27 22:53:43 +02:00
|
|
|
##
|
|
|
|
## Here you can find all the possible duplicity options, details of
|
|
|
|
## what the options provide and possible settings. The defaults are set
|
|
|
|
## as the commented out option, uncomment and change when
|
|
|
|
## necessary. Options which are uncommented in this example do not have
|
|
|
|
## defaults, and the settings provided are recommended.
|
|
|
|
|
|
|
|
## passed directly to duplicity, e.g. to increase verbosity set this to:
|
|
|
|
## options = --verbosity 8
|
2010-01-09 23:14:17 +01:00
|
|
|
## when using the Amazon S3 backend to create buckets in Europe:
|
|
|
|
## options = --s3-european-buckets --s3-use-new-style
|
2009-08-27 22:53:43 +02:00
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# options =
|
2005-05-27 18:31:23 +02:00
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## default is 0, but set to something like 19 if you want to lower the priority.
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# nicelevel = 0
|
2005-05-27 18:31:23 +02:00
|
|
|
|
2020-05-16 18:08:25 +02:00
|
|
|
## ionicelevel is optional. If it is left undefined or empty, ionice will not
|
|
|
|
## be used at all. If it is set to to an integer value from 0 to 7, then ionice
|
|
|
|
## will be used with the best effort class (-c2) and with the ionicelevel as
|
|
|
|
## the class data (-n).
|
|
|
|
##
|
|
|
|
## See the ionice(1) man page for more details about available levels.
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# ionicelevel =
|
|
|
|
|
2010-05-06 19:47:54 +02:00
|
|
|
## test the connection? set to no to skip the test if the remote host is alive.
|
|
|
|
## if 'desturl' is set below, 'testconnect' must be set to 'no' for now.
|
2009-08-27 22:53:43 +02:00
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# testconnect = yes
|
2005-05-27 18:31:23 +02:00
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## temporary directory used by duplicity, set to some other location if your /tmp is small
|
|
|
|
## default is either /tmp or /usr/tmp, depending on the system
|
2021-01-22 17:24:14 +01:00
|
|
|
##
|
2009-08-27 22:53:43 +02:00
|
|
|
## Default:
|
|
|
|
# tmpdir = /tmp
|
2007-11-26 08:42:24 +01:00
|
|
|
|
2005-05-27 18:31:23 +02:00
|
|
|
######################################################
|
|
|
|
## gpg section
|
2006-04-23 00:02:43 +02:00
|
|
|
## (how to encrypt and optionally sign the backups)
|
2005-12-28 18:32:12 +01:00
|
|
|
##
|
2006-05-30 05:40:34 +02:00
|
|
|
## WARNING: old (pre-0.9.4) example.dup used to give wrong information about
|
2006-04-22 23:41:39 +02:00
|
|
|
## the way the following options are used. Please read the following
|
2005-12-28 18:32:12 +01:00
|
|
|
## carefully.
|
|
|
|
##
|
|
|
|
## If the encryptkey variable is set:
|
|
|
|
## - data is encrypted with the GnuPG public key specified by the encryptkey
|
|
|
|
## variable
|
2006-05-30 05:40:34 +02:00
|
|
|
## - 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
|
|
|
|
##
|
2005-12-28 18:32:12 +01:00
|
|
|
## 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
|
2005-05-27 18:31:23 +02:00
|
|
|
|
|
|
|
[gpg]
|
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## 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
|
2013-11-13 15:18:15 +01:00
|
|
|
## variable (and probably signpassword) below.
|
2009-08-27 22:53:43 +02:00
|
|
|
## default is set to no, for backwards compatibility with backupninja <= 0.5.
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# sign = no
|
2005-12-27 20:38:15 +01:00
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## ID of the GnuPG public key used for data encryption.
|
|
|
|
## if not set, symmetric encryption is used, and data signing is not possible.
|
|
|
|
## an example setting would be:
|
|
|
|
## encryptkey = 04D9EA79
|
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# encryptkey =
|
2009-08-27 22:53:43 +02:00
|
|
|
|
|
|
|
## ID of the GnuPG private key used for data signing.
|
|
|
|
## if not set, encryptkey will be used, an example setting would be:
|
|
|
|
## signkey = 04D9EA79
|
2021-01-22 17:24:14 +01:00
|
|
|
##
|
2009-08-27 22:53:43 +02:00
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# signkey =
|
2009-08-27 22:53:43 +02:00
|
|
|
|
2013-11-13 15:18:15 +01:00
|
|
|
## password used to unlock the encryption key
|
|
|
|
## NB: neither quote this, nor should it contain any quotes,
|
2009-08-27 22:53:43 +02:00
|
|
|
## an example setting would be:
|
|
|
|
## password = a_very_complicated_passphrase
|
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# password =
|
2005-12-28 18:32:12 +01:00
|
|
|
|
2013-11-13 15:18:15 +01:00
|
|
|
## password used to unlock the signature key, used only if
|
|
|
|
## it differs from the encryption key
|
|
|
|
## NB: neither quote this, nor should it contain any quotes,
|
|
|
|
## an example setting would be:
|
|
|
|
## signpassword = a_very_complicated_passphrase
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# signpassword =
|
|
|
|
|
2005-05-27 18:31:23 +02:00
|
|
|
######################################################
|
|
|
|
## source section
|
|
|
|
## (where the files to be backed up are coming from)
|
|
|
|
|
|
|
|
[source]
|
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## A few notes about includes and excludes:
|
2021-01-03 18:07:56 +01:00
|
|
|
## 1. include and exclude statements support globbing with '*'
|
2009-08-27 22:53:43 +02:00
|
|
|
## 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
|
2005-05-27 18:31:23 +02:00
|
|
|
include = /var/spool/cron/crontabs
|
|
|
|
include = /var/backups
|
|
|
|
include = /etc
|
|
|
|
include = /root
|
|
|
|
include = /home
|
|
|
|
include = /usr/local/bin
|
|
|
|
include = /usr/local/sbin
|
|
|
|
include = /var/lib/dpkg/status
|
|
|
|
include = /var/lib/dpkg/status-old
|
|
|
|
|
|
|
|
# files to exclude from the backup
|
|
|
|
exclude = /home/*/.gnupg
|
2010-05-10 22:18:49 +02:00
|
|
|
exclude = /var/cache/backupninja/duplicity
|
2005-05-27 18:31:23 +02:00
|
|
|
|
|
|
|
######################################################
|
|
|
|
## destination section
|
|
|
|
## (where the files are copied to)
|
|
|
|
|
|
|
|
[dest]
|
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## perform an incremental backup? (default = yes)
|
|
|
|
## if incremental = no, perform a full backup in order to start a new backup set
|
|
|
|
##
|
2021-01-22 17:24:14 +01:00
|
|
|
## Default:
|
2009-08-27 22:53:43 +02:00
|
|
|
# incremental = yes
|
2005-05-27 18:31:23 +02:00
|
|
|
|
2010-05-06 18:49:18 +02:00
|
|
|
## how many days of incremental backups before doing a full backup again ;
|
|
|
|
## default is 30 days (one can also use the time format of duplicity).
|
2021-01-22 17:24:14 +01:00
|
|
|
## if increments = keep, never automatically perform a new full backup ;
|
2010-05-06 18:49:18 +02:00
|
|
|
## only perform incremental backups.
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# increments = 30
|
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## how many days of data to keep ; default is 60 days.
|
|
|
|
## (you can also use the time format of duplicity)
|
|
|
|
## 'keep = yes' means : do not delete old data, the remote host will take care of this
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# keep = 60
|
|
|
|
|
2011-04-25 22:49:57 +02:00
|
|
|
# for how many full backups do we keep their later increments ;
|
|
|
|
# default is all (keep all increments).
|
|
|
|
# increments for older full backups will be deleted : only the more
|
|
|
|
# recent ones (count provided) will be kept
|
|
|
|
#
|
|
|
|
## Default:
|
|
|
|
# keepincroffulls = all
|
|
|
|
|
2009-08-27 22:53:43 +02:00
|
|
|
## full destination URL, in duplicity format; if set, desturl overrides
|
|
|
|
## sshoptions, destdir, desthost and destuser; it also disables testconnect and
|
|
|
|
## bandwithlimit. For details, see duplicity manpage, section "URL FORMAT", some
|
|
|
|
## examples include:
|
|
|
|
## desturl = file:///usr/local/backup
|
|
|
|
## desturl = rsync://user@other.host//var/backup/bla
|
2010-01-09 23:14:17 +01:00
|
|
|
## desturl = s3+http://
|
2010-05-06 20:05:20 +02:00
|
|
|
## desturl = ftp://myftpuser@ftp.example.org/remote/ftp/path
|
2017-07-25 11:55:13 +02:00
|
|
|
## desturl = dpbx:///myserver
|
2009-08-27 22:53:43 +02:00
|
|
|
## the default value of this configuration option is not set:
|
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# desturl =
|
2005-05-27 18:31:23 +02:00
|
|
|
|
2010-01-09 23:14:17 +01:00
|
|
|
## Amazon Web Services Access Key ID and Secret Access Key, needed for backups
|
|
|
|
## to S3 buckets.
|
|
|
|
## awsaccesskeyid = YOUR_AWS_ACCESS_KEY_ID
|
|
|
|
## awssecretaccesskey = YOUR_AWS_SECRET_KEY
|
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# awsaccesskeyid =
|
|
|
|
# awssecretaccesskey =
|
2010-01-09 23:14:17 +01:00
|
|
|
|
2011-10-22 21:46:50 +02:00
|
|
|
## RackSpace's CloudFiles username, API key, and authentication URL.
|
|
|
|
## cfusername = YOUR_CF_USERNAME
|
|
|
|
## cfapikey = YOUR_CF_API_KEY
|
|
|
|
## cfauthurl = YOUR_CF_AUTH_URL
|
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# cfusername =
|
|
|
|
# cfapikey =
|
|
|
|
# cfauthurl =
|
2011-10-22 21:46:50 +02:00
|
|
|
|
2017-07-25 11:55:13 +02:00
|
|
|
## Dropbox requires a valid authentication token. To obtain one, you will need
|
|
|
|
## to create a Dropbox API application at https://www.dropbox.com/developers/apps/create.
|
|
|
|
## See the "A note on Dropbox access" section of the Duplicity manpage for more
|
|
|
|
## details: http://duplicity.nongnu.org/duplicity.1.html#sect12
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# dropboxappkey =
|
|
|
|
# dropboxappsecret =
|
|
|
|
# dropboxaccesstoken =
|
|
|
|
|
2010-05-06 20:05:20 +02:00
|
|
|
## FTP password, needed for backups using desturl = ftp://...
|
|
|
|
##
|
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# ftp_password =
|
2010-05-06 20:05:20 +02:00
|
|
|
|
2017-08-13 00:10:29 +02:00
|
|
|
## bandwith limit, in KB/s ; default is 0, i.e. no limit
|
2010-05-06 19:47:54 +02:00
|
|
|
## if using 'desturl' above, 'bandwidthlimit' must not be set
|
2017-08-13 00:10:29 +02:00
|
|
|
## an example setting of 128 KB/s would be:
|
2009-08-27 22:53:43 +02:00
|
|
|
## bandwidthlimit = 128
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# bandwidthlimit = 0
|
|
|
|
|
2012-01-29 14:39:39 +01:00
|
|
|
## duplicity < 0.6.17
|
|
|
|
## ------------------
|
2009-08-27 22:53:43 +02:00
|
|
|
## 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>"
|
|
|
|
## an example setting would be:
|
2011-01-27 19:02:05 +01:00
|
|
|
## sshoptions = -o IdentityFile=/root/.ssh/id_rsa_duplicity
|
2009-08-27 22:53:43 +02:00
|
|
|
##
|
2012-01-29 14:39:39 +01:00
|
|
|
## duplicity >= 0.6.17
|
2013-07-23 12:01:02 +02:00
|
|
|
## -------------------
|
|
|
|
## supports only "-oIdentityFile=..." since duplicity >=0.6.17 uses paramiko,
|
|
|
|
## a ssh python module.
|
|
|
|
## warning: requires no space beetween "-o" and "IdentityFile=...".
|
2012-01-29 14:39:39 +01:00
|
|
|
##
|
2009-08-27 22:53:43 +02:00
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# sshoptions =
|
2009-08-27 22:53:43 +02:00
|
|
|
|
2010-05-06 19:47:54 +02:00
|
|
|
## put the backups under this destination directory
|
|
|
|
## if using 'desturl' above, this must not be set
|
|
|
|
## in all other cases, this must be set!
|
2009-08-27 22:53:43 +02:00
|
|
|
## an example setting would be:
|
|
|
|
## destdir = /backups
|
2021-01-22 17:24:14 +01:00
|
|
|
##
|
2009-08-27 22:53:43 +02:00
|
|
|
## Default:
|
2021-01-22 17:24:14 +01:00
|
|
|
# destdir =
|
2009-08-27 22:53:43 +02:00
|
|
|
|
2010-05-06 19:47:54 +02:00
|
|
|
## the machine which will receive the backups
|
|
|
|
## if using 'desturl' above, this must not be set
|
|
|
|
## in all other cases, this must be set!
|
2009-08-27 22:53:43 +02:00
|
|
|
## an example setting would be:
|
|
|
|
## desthost = backuphost
|
2021-01-22 17:24:14 +01:00
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# desthost =
|
2009-08-27 22:53:43 +02:00
|
|
|
|
|
|
|
## make the files owned by this user
|
2010-05-06 19:47:54 +02:00
|
|
|
## if using 'desturl' above, this must not be set
|
|
|
|
## note: if using an SSH based transport and 'type' is set to 'remote', you must
|
|
|
|
## be able to 'ssh backupuser@backuphost' without specifying a password.
|
2009-08-27 22:53:43 +02:00
|
|
|
## an example setting would be:
|
|
|
|
## destuser = backupuser
|
|
|
|
##
|
|
|
|
## Default:
|
|
|
|
# destuser =
|