|
NAMEduplicity - Encrypted incremental backup to local or remote storage.SYNOPSISFor detailed descriptions for each command see chapter ACTIONS.duplicity [full|incremental] [options] source_directory target_url duplicity verify [options] [--compare-data] [--file-to-restore <relpath>] [--time time] source_url target_directory duplicity collection-status [options] [--file-changed <relpath>] [--show-changes-in-set <index>] target_url duplicity list-current-files [options] [--time time] target_url duplicity [restore] [options] [--file-to-restore <relpath>] [--time time] source_url target_directory duplicity remove-older-than <time> [options] [--force] target_url duplicity remove-all-but-n-full <count> [options] [--force] target_url duplicity remove-all-inc-of-but-n-full <count> [options] [--force] target_url duplicity cleanup [options] [--force] target_url duplicity replicate [options] [--time time] source_url target_url DESCRIPTIONDuplicity incrementally backs up files and folders into tar-format volumes encrypted with GnuPG and places them to a remote (or local) storage backend. See chapter URL FORMAT for a list of all supported backends and how to address them. Because duplicity uses librsync, incremental backups are space efficient and only record the parts of files that have changed since the last backup. Currently duplicity supports deleted files, full Unix permissions, uid/gid, directories, symbolic links, fifos, etc., but not hard links.If you are backing up the root directory /, remember to --exclude /proc, or else duplicity will probably crash on the weird stuff in there. EXAMPLESHere is an example of a backup, using sftp to back up /home/me to some_dir on the other.host machine:duplicity /home/me sftp://uid@other.host/some_dir
If the above is run repeatedly, the first will be a full backup, and subsequent ones will be incremental. To force a full backup, use the full action: duplicity full /home/me
sftp://uid@other.host/some_dir
or enforcing a full every other time via --full-if-older-than <time> , e.g. a full every month: duplicity --full-if-older-than 1M /home/me
sftp://uid@other.host/some_dir
Now suppose we accidentally delete /home/me and want to restore it the way it was at the time of last backup: duplicity sftp://uid@other.host/some_dir /home/me
Duplicity enters restore mode because the URL comes before the local directory. If we wanted to restore just the file "Mail/article" in /home/me as it was three days ago into /home/me/restored_file: duplicity -t 3D --file-to-restore Mail/article
sftp://uid@other.host/some_dir /home/me/restored_file
The following command compares the latest backup with the current files: duplicity verify sftp://uid@other.host/some_dir
/home/me
Finally, duplicity recognizes several include/exclude options. For instance, the following will backup the root directory, but exclude /mnt, /tmp, and /proc: duplicity --exclude /mnt --exclude /tmp --exclude /proc /
file:///usr/local/backup
Note that in this case the destination is the local directory /usr/local/backup. The following will backup only the /home and /etc directories under root: duplicity --include /home --include /etc --exclude '**' /
file:///usr/local/backup
Duplicity can also access a repository via ftp. If a user name is given, the environment variable FTP_PASSWORD is read to determine the password: FTP_PASSWORD=mypassword duplicity /local/dir
ftp://user@other.host/some_dir
ACTIONSDuplicity knows action commands, which can be finetuned with options.The actions for backup (full,incr) and restoration (restore) can as well be left out as duplicity detects in what mode it should switch to by the order of target URL and local folder. If the target URL comes before the local folder a restore is in order, is the local folder before target URL then this folder is about to be backed up to the target URL. If a backup is in order and old signatures can be found duplicity automatically performs an incremental backup. Note: The following explanations explain some but not all options that can be used in connection with that action command. Consult the OPTIONS section for more detailed informations.
OPTIONS
ENVIRONMENT VARIABLES
URL FORMATDuplicity uses the URL format (as standard as possible) to define data locations. The generic format for a URL is:scheme://[user[:password]@]host[:port]/[/]path
It is not recommended to expose the password on the command line since it could be revealed to anyone with permissions to do process listings, it is permitted however. Consider setting the environment variable FTP_PASSWORD instead, which is used by most, if not all backends, regardless of it's name. In protocols that support it, the path may be preceded by a single slash, '/path', to represent a relative path to the target home directory, or preceded by a double slash, '//path', to represent an absolute filesystem path. Note: Scheme (protocol) access may be provided by more than one
backend. In case the default backend is buggy or simply not working in a
specific case it might be worth trying an alternative implementation.
Alternative backends can be selected by prefixing the scheme with the name of
the alternative backend e.g. ncftp+ftp:// and are mentioned below the
scheme's syntax summary.
Formats of each of the URL schemes follow: Amazon Drive Backend ad://some_dir
See also A NOTE ON AMAZON DRIVE Azure azure://container-name
See also A NOTE ON AZURE ACCESS B2 b2://account_id[:application_key]@bucket_name/[folder/]
Box box:///some_dir[?config=path_to_config]
See also A NOTE ON BOX ACCESS Cloud Files (Rackspace) cf+http://container_name
See also A NOTE ON CLOUD FILES ACCESS Dropbox dpbx:///some_dir
Make sure to read A NOTE ON DROPBOX ACCESS first! Local file path file://[relative|/absolute]/local/path
FISH (Files transferred over Shell protocol) over ssh fish://user[:password]@other.host[:port]/[relative|/absolute]_path
FTP ftp[s]://user[:password]@other.host[:port]/some_dir
NOTE: use lftp+, ncftp+ prefixes to enforce a specific backend, default is lftp+ftp://... Google Docs gdocs://user[:password]@other.host/some_dir
NOTE: use pydrive+, gdata+ prefixes to enforce a specific backend, default is pydrive+gdocs://... Google Cloud Storage gs://bucket[/prefix]
HSI hsi://user[:password]@other.host/some_dir
hubiC cf+hubic://container_name
See also A NOTE ON HUBIC IMAP email storage imap[s]://user[:password]@host.com[/from_address_prefix]
See also A NOTE ON IMAP MEGA.nz cloud storage (only works for accounts created prior to November 2018, uses "megatools") mega://user[:password]@mega.nz/some_dir
NOTE: if not given in the URL, relies on password being stored within $HOME/.megarc (as used by the "megatools" utilities) MEGA.nz cloud storage (works for all MEGA accounts, uses "MEGAcmd" tools) megav2://user[:password]@mega.nz/some_dir
megav3://user[:password]@mega.nz/some_dir[?no_logout=1] (For latest MEGAcmd)
NOTE: despite "MEGAcmd" no longer uses a configuration file, for convenience storing the user password this backend searches it in the $HOME/.megav2rc file (same syntax as the old $HOME/.megarc) [Login] Username = MEGA_USERNAME Password = MEGA_PASSWORD OneDrive Backend onedrive://some_dir
Par2 Wrapper Backend par2+scheme://[user[:password]@]host[:port]/[/]path
See also A NOTE ON PAR2 WRAPPER BACKEND Rclone Backend rclone://remote:/some_dir
See also A NOTE ON RCLONE BACKEND
Rsync via daemon rsync://user[:password]@host.com[:port]::[/]module/some_dir
Rsync over ssh (only key auth) rsync://user@host.com[:port]/[relative|/absolute]_path
S3 storage (Amazon) s3://host[:port]/bucket_name[/prefix]
s3+http://bucket_name[/prefix] defaults to the legacy boto backend based on boto v2 (last update 2018/07) alternatively try the newer boto3+s3://bucket_name[/prefix] For details see A NOTE ON AMAZON S3 and see also A NOTE ON EUROPEAN S3 BUCKETS below. SCP/SFTP access scp://.. or
sftp://user[:password]@other.host[:port]/[relative|/absolute]_path defaults are paramiko+scp:// and paramiko+sftp://
Swift (Openstack) swift://container_name[/prefix]
See also A NOTE ON SWIFT (OPENSTACK OBJECT STORAGE) ACCESS Public Cloud Archive (OVH) pca://container_name[/prefix]
See also A NOTE ON PCA ACCESS Tahoe-LAFS tahoe://alias/directory
WebDAV webdav[s]://user[:password]@other.host[:port]/some_dir
alternatively try lftp+webdav[s]:// slate slate://[slate-id]
See also A NOTE ON SLATE BACKEND pydrive pydrive://<service account' email
address>@developer.gserviceaccount.com/some_dir
See also A NOTE ON PYDRIVE BACKEND below. gdrive gdrive://<service account' email
address>@developer.gserviceaccount.com/some_dir
See also A NOTE ON GDRIVE BACKEND below. multi multi:///path/to/config.json
See also A NOTE ON MULTI BACKEND below. MediaFire mf://user[:password]@mediafire.com/some_dir
See also A NOTE ON MEDIAFIRE BACKEND below. TIME FORMATSduplicity uses time strings in two places. Firstly, many of the files duplicity creates will have the time in their filenames in the w3 datetime format as described in a w3 note at http://www.w3.org/TR/NOTE-datetime. Basically they look like "2001-07-15T04:09:38-07:00", which means what it looks like. The "-07:00" section means the time zone is 7 hours behind UTC.Secondly, the -t, --time, and --restore-time options take a time string, which can be given in any of several formats:
FILE SELECTIONWhen duplicity is run, it searches through the given source directory and backs up all the files specified by the file selection system. The file selection system comprises a number of file selection conditions, which are set using one of the following command line options:--exclude
Each file selection condition either matches or doesn't match a given file. A
given file is excluded by the file selection system exactly when the first
matching file selection condition specifies that the file be excluded;
otherwise the file is included.
--exclude-device-files --exclude-if-present --exclude-filelist --exclude-regexp --include --include-filelist --include-regexp For instance, duplicity --include /usr --exclude /usr /usr
scp://user@host/backup
is exactly the same as duplicity /usr scp://user@host/backup
because the include and exclude directives match exactly the same files, and the --include comes first, giving it precedence. Similarly, duplicity --include /usr/local/bin --exclude /usr/local
/usr scp://user@host/backup
would backup the /usr/local/bin directory (and its contents), but not /usr/local/doc. The include, exclude, include-filelist, and exclude-filelist options accept some extended shell globbing patterns. These patterns can contain *, **, ?, and [...] (character ranges). As in a normal shell, * can be expanded to any string of characters not containing "/", ? expands to any character except "/", and [...] expands to a single character of those characters specified (ranges are acceptable). The new special pattern, **, expands to any string of characters whether or not it contains "/". Furthermore, if the pattern starts with "ignorecase:" (case insensitive), then this prefix will be removed and any character in the string can be replaced with an upper- or lowercase version of itself. Remember that you may need to quote these characters when typing them into a shell, so the shell does not interpret the globbing patterns before duplicity sees them. The --exclude pattern option matches a file if: 1. pattern can be expanded into the file's filename,
or
Conversely, the --include pattern matches a file if: 1. pattern can be expanded into the file's filename,
or
For example, --exclude /usr/local
matches e.g. /usr/local, /usr/local/lib, and /usr/local/lib/netscape. It is the same as --exclude /usr/local --exclude '/usr/local/**'. On the other hand --include /usr/local
specifies that /usr, /usr/local, /usr/local/lib, and /usr/local/lib/netscape (but not /usr/doc) all be backed up. Thus you don't have to worry about including parent directories to make sure that included subdirectories have somewhere to go. Finally, --include
ignorecase:'/usr/[a-z0-9]foo/*/**.py'
would match a file like /usR/5fOO/hello/there/world.py. If it did match anything, it would also match /usr. If there is no existing file that the given pattern can be expanded into, the option will not match /usr alone. The --include-filelist, and --exclude-filelist, options also introduce file selection conditions. They direct duplicity to read in a text file (either ASCII or UTF-8), each line of which is a file specification, and to include or exclude the matching files. Lines are separated by newlines or nulls, depending on whether the --null-separator switch was given. Each line in the filelist will be interpreted as a globbing pattern the way --include and --exclude options are interpreted, except that lines starting with "+ " are interpreted as include directives, even if found in a filelist referenced by --exclude-filelist. Similarly, lines starting with "- " exclude files even if they are found within an include filelist. For example, if file "list.txt" contains the lines: /usr/local
- /usr/local/doc /usr/local/bin + /var - /var then --include-filelist list.txt would include /usr, /usr/local, and /usr/local/bin. It would exclude /usr/local/doc, /usr/local/doc/python, etc. It would also include /usr/local/man, as this is included within /user/local. Finally, it is undefined what happens with /var. A single file list should not contain conflicting file specifications. Each line in the filelist will also be interpreted as a globbing pattern the way --include and --exclude options are interpreted. For instance, if the file "list.txt" contains the lines: dir/foo
+ dir/bar - ** Then --include-filelist list.txt would be exactly the same as specifying --include dir/foo --include dir/bar --exclude ** on the command line. Finally, the --include-regexp and --exclude-regexp options allow files to be included and excluded if their filenames match a python regular expression. Regular expression syntax is too complicated to explain here, but is covered in Python's library reference. Unlike the --include and --exclude options, the regular expression options don't match files containing or contained in matched files. So for instance --include '[0-9]{7}(?!foo)'
matches any files whose full pathnames contain 7 consecutive digits which aren't followed by 'foo'. However, it wouldn't match /home even if /home/ben/1234567 existed. A NOTE ON AMAZON DRIVE
A NOTE ON AMAZON S3When backing up to Amazon S3, two backend implementations are available. The schemes "s3" and "s3+http" are implemented using the older boto library, which has been deprecated and is no longer supported. The "boto3+s3" scheme is based on the newer boto3 library. This new backend fixes several known limitations in the older backend, which have crept in as Amazon S3 has evolved while the deprecated boto library has not kept up.The boto3 backend should behave largely the same as the older S3 backend, but there are some differences in the handling of some of the "S3" options. Additionally, there are some compatibility differences with the new backed. Because of these reasons, both backends have been retained for the time being. See the documentation for specific options regarding differences related to each backend. The boto3 backend does not support bucket creation. This is a deliberate choice which simplifies the code, and side steps problems related to region selection. Additionally, it is probably not a good practice to give your backup role bucket creation rights. In most cases the role used for backups should probably be limited to specific buckets. The boto3 backend only supports newer domain style buckets. Amazon is moving to deprecate the older bucket style, so migration is recommended. Use the older s3 backend for compatibility with backups stored in buckets using older naming conventions. The boto3 backend does not currently support initiating restores from the glacier storage class. When restoring a backup from glacier or glacier deep archive, the backup files must first be restored out of band. There are multiple options when restoring backups from cold storage, which vary in both cost and speed. See Amazon's documentation for details. A NOTE ON AZURE ACCESSThe Azure backend requires the Microsoft Azure Storage Blobs client library for Python to be installed on the system. See REQUIREMENTS.It uses the environment variable AZURE_CONNECTION_STRING (required). This string contains all necessary information such as Storage Account name and the key for authentication. You can find it under Access Keys for the storage account. Duplicity will take care to create the container when performing the backup. Do not create it manually before. A container name (as given as the backup url) must be a valid DNS name, conforming to the following naming rules:
These rules come from Azure; see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata A NOTE ON BOX ACCESSThe box backend requires boxsdk with jwt support to be installed on the system. See REQUIREMENTS.It uses the environment variable BOX_CONFIG_PATH (optional). This string contains the path to box custom app's config.json. Either this environment variable or the config query parameter in the url need to be specified, if both are specified, query paramter takes precedence. Create a Box custom appIn order to use box backend, user need to create a box custom app in the box developer console (https://app.box.com/developers/console).After create a new custom app, please make sure it is configured as follow:
The user also need to grant the created custom app permission in the admin console (https://app.box.com/master/custom-apps) by clicking the "+" button and enter the client_id which can be found on the custom app's configuration page. A NOTE ON CLOUD FILES ACCESSPyrax is Rackspace's next-generation Cloud management API, including Cloud Files access. The cfpyrax backend requires the pyrax library to be installed on the system. See REQUIREMENTS.Cloudfiles is Rackspace's now deprecated implementation of OpenStack Object Storage protocol. Users wishing to use Duplicity with Rackspace Cloud Files should migrate to the new Pyrax plugin to ensure support. The backend requires python-cloudfiles to be installed on the system. See REQUIREMENTS. It uses three environment variables for authentification: CLOUDFILES_USERNAME (required), CLOUDFILES_APIKEY (required), CLOUDFILES_AUTHURL (optional) If CLOUDFILES_AUTHURL is unspecified it will default to the value provided by python-cloudfiles, which points to rackspace, hence this value must be set in order to use other cloud files providers. A NOTE ON DROPBOX ACCESS
Full Dropbox: path is absolute and starts from
'Dropbox' root folder.
App Folder: path is related to application folder. Dropbox client will show it in ~/Dropbox/Apps/<app-name>
A NOTE ON EUROPEAN S3 BUCKETSAmazon S3 provides the ability to choose the location of a bucket upon its creation. The purpose is to enable the user to choose a location which is better located network topologically relative to the user, because it may allow for faster data transfers.duplicity will create a new bucket the first time a bucket access is attempted. At this point, the bucket will be created in Europe if --s3-european-buckets was given. For reasons having to do with how the Amazon S3 service works, this also requires the use of the --s3-use-new-style option. This option turns on subdomain based bucket addressing in S3. The details are beyond the scope of this man page, but it is important to know that your bucket must not contain upper case letters or any other characters that are not valid parts of a hostname. Consequently, for reasons of backwards compatibility, use of subdomain based bucket addressing is not enabled by default. Note that you will need to use --s3-use-new-style for all operations on European buckets; not just upon initial creation. You only need to use --s3-european-buckets upon initial creation, but you may may use it at all times for consistency. Further note that when creating a new European bucket, it can take a while before the bucket is fully accessible. At the time of this writing it is unclear to what extent this is an expected feature of Amazon S3, but in practice you may experience timeouts, socket errors or HTTP errors when trying to upload files to your newly created bucket. Give it a few minutes and the bucket should function normally. A NOTE ON FILENAME PREFIXESFilename prefixes can be used in multi backend with mirror mode to define affinity rules. They can also be used in conjunction with S3 lifecycle rules to transition archive files to Glacier, while keeping metadata (signature and manifest files) on S3.Duplicity does not require access to archive files except when restoring from backup. A NOTE ON GOOGLE CLOUD STORAGESupport for Google Cloud Storage relies on its Interoperable Access, which must be enabled for your account. Once enabled, you can generate Interoperable Storage Access Keys and pass them to duplicity via the GS_ACCESS_KEY_ID and GS_SECRET_ACCESS_KEY environment variables. Alternatively, you can run gsutil config -a to have the Google Cloud Storage utility populate the ~/.boto configuration file.Enable Interoperable Access:
https://code.google.com/apis/console#:storage
A NOTE ON HUBICThe hubic backend requires the pyrax library to be installed on the system. See REQUIREMENTS. You will need to set your credentials for hubiC in a file called ~/.hubic_credentials, following this pattern:[hubic]
email = your_email password = your_password client_id = api_client_id client_secret = api_secret_key redirect_uri = http://localhost/ A NOTE ON IMAPAn IMAP account can be used as a target for the upload. The userid may be specified and the password will be requested.The from_address_prefix may be specified (and probably should be). The text will be used as the "From" address in the IMAP server. Then on a restore (or list) command the from_address_prefix will distinguish between different backups. A NOTE ON MULTI BACKENDThe multi backend allows duplicity to combine the storage available in more than one backend store (e.g., you can store across a google drive account and a onedrive account to get effectively the combined storage available in both). The URL path specifies a JSON formated config file containing a list of the backends it will use. The URL may also specify "query" parameters to configure overall behavior. Each element of the list must have a "url" element, and may also contain an optional "description" and an optional "env" list of environment variables used to configure that backend.Query ParametersQuery parameters come after the file URL in standard HTTP format for example:multi:///path/to/config.json?mode=mirror&onfail=abort multi:///path/to/config.json?mode=stripe&onfail=continue multi:///path/to/config.json?onfail=abort&mode=stripe multi:///path/to/config.json?onfail=abort
JSON File Example[ { "description": "a comment about the backend" "url": "abackend://myuser@domain.com/backup", "env": [ { "name" : "MYENV", "value" : "xyz" }, { "name" : "FOO", "value" : "bar" } ], "prefixes": ["prefix1_", "prefix2_"] }, { "url": "file:///path/to/dir" } ] A NOTE ON PAR2 WRAPPER BACKENDPar2 Wrapper Backend can be used in combination with all other backends to create recovery files. Just add par2+ before a regular scheme (e.g. par2+ftp://user@host/dir or par2+s3+http://bucket_name ). This will create par2 recovery files for each archive and upload them all to the wrapped backend.Before restoring, archives will be verified. Corrupt archives will be repaired on the fly if there are enough recovery blocks available. Use --par2-redundancy percent to adjust the size (and redundancy) of recovery files in percent. A NOTE ON PYDRIVE BACKENDThe pydrive backend requires Python PyDrive package to be installed on the system. See REQUIREMENTS.There are two ways to use PyDrive: with a regular account or with a "service account". With a service account, a separate account is created, that is only accessible with Google APIs and not a web login. With a regular account, you can store backups in your normal Google Drive. To use a service account, go to the Google developers console at https://console.developers.google.com. Create a project, and make sure Drive API is enabled for the project. Under "APIs and auth", click Create New Client ID, then select Service Account with P12 key. Download the .p12 key file of the account and convert it to the
.pem format:
The content of .pem file should be passed to GOOGLE_DRIVE_ACCOUNT_KEY environment variable for authentification. The email address of the account will be used as part of URL. See URL FORMAT above. The alternative is to use a regular account. To do this, start as above, but when creating a new Client ID, select "Installed application" of type "Other". Create a file with the following content, and pass its filename in the GOOGLE_DRIVE_SETTINGS environment variable: client_config_backend: settings client_config: client_id: <Client ID from developers' console> client_secret: <Client secret from developers' console> save_credentials: True save_credentials_backend: file save_credentials_file: <filename to cache credentials> get_refresh_token: True In this scenario, the username and host parts of the URL play no role; only the path matters. During the first run, you will be prompted to visit an URL in your browser to grant access to your drive. Once granted, you will receive a verification code to paste back into Duplicity. The credentials are then cached in the file references above for future use. A NOTE ON SLATE BACKENDThree environment variables are used with the slate backend: 1. `SLATE_API_KEY` - Your slate API key 2. `SLATE_SSL_VERIFY` - either '1'(True) or '0'(False) for ssl verification (optional - True by default) 3. `PASSPHRASE` - your gpg passhprase for encryption (optional - will be prompted if not set or not used at all if using the `--no-encryption` parameter)To use the slate backend, use the following scheme: slate://[slate-id]
e.g. Full backup of current directory to slate: duplicity full .
"slate://6920df43-5c3w-2x7i-69aw-2390567uav75"
Here's a demo: https://gitlab.com/Shr1ftyy/duplicity/uploads/675664ef0eb431d14c8e20045e3fafb6/slate_demo.mp4 A NOTE ON GDRIVE BACKENDGDrive: is a rewritten PyDrive: backend with less dependencies, and a simpler setup - it uses the JSON keys downloaded directly from Google Cloud Console.Note Google has 2 drive methods, `Shared(previously Team) Drives` and `My Drive`, both can be shared but require different addressing For a Google Shared Drives folder Share Drive ID specified as a query parameter, driveID, in the backend URL. Example: gdrive://developer.gserviceaccount.com/target-folder/?driveID=<SHARED DRIVE ID> For a Google My Drive based shared folder MyDrive folder ID specified as a query parameter, myDriveFolderID, in the backend URL Example export GOOGLE_SERVICE_ACCOUNT_URL=<serviceaccount-name>@<serviceaccount-name>.iam.gserviceaccount.com gdrive://${GOOGLE_SERVICE_ACCOUNT_URL}/<target-folder-name-in-myDriveFolder>?myDriveFolderID=<google-myDrive-folder-id> There are also two ways to authenticate to use GDrive: with a regular account or with a "service account". With a service account, a separate account is created, that is only accessible with Google APIs and not a web login. With a regular account, you can store backups in your normal Google Drive. To use a service account, go to the Google developers console at https://console.developers.google.com. Create a project, and make sure Drive API is enabled for the project. In the "Credentials" section, click "Create credentials", then select Service Account with JSON key. The GOOGLE_SERVICE_JSON_FILE environment variable needs to contain the path to the JSON file on duplicity invocation. export GOOGLE_SERVICE_JSON_FILE=<path-to-serviceaccount-credentials.json> The alternative is to use a regular account. To do this, start as above, but when creating a new Client ID, select "Create OAuth client ID", with application type of "Desktop app". Download the client_secret.json file for the new client, and set the GOOGLE_CLIENT_SECRET_JSON_FILE environment variable to the path to this file, and GOOGLE_CREDENTIALS_FILE to a path to a file where duplicity will keep the authentication token - this location must be writable. During the first run, you will be prompted to visit an URL in your browser to grant access to your drive. Once granted, you will receive a verification code to paste back into Duplicity. The credentials are then cached in the file references above for future use. As a sanity check, GDrive checks the host and username from the URL against the JSON key, and refuses to proceed if the addresses do not match. Either the email (for the service accounts) or Client ID (for regular OAuth accounts) must be present in the URL. See URL FORMAT above. A NOTE ON RCLONE BACKENDRclone is a powerful command line program to sync files and directories to and from various cloud storage providers.Once you have configured an rclone remote via rclone config
and successfully set up a remote (e.g. gdrive for Google Drive), assuming you can list your remote files with rclone ls gdrive:mydocuments
you can start your backup with duplicity /mydocuments rclone://gdrive:/mydocuments
Please note the slash after the second colon. Some storage provider will work with or without slash after colon, but some other will not. Since duplicity will complain about malformed URL if a slash is not present, always put it after the colon, and the backend will handle it for you. A NOTE ON SSH BACKENDSThe ssh backends support sftp and scp/ssh transport protocols. This is a known user-confusing issue as these are fundamentally different. If you plan to access your backend via one of those please inform yourself about the requirements for a server to support sftp or scp/ssh access. To make it even more confusing the user can choose between several ssh backends via a scheme prefix: paramiko+ (default), pexpect+, lftp+... .paramiko & pexpect support --use-scp, --ssh-askpass and --ssh-options. Only the pexpect backend allows to define --scp-command and --sftp-command. SSH paramiko backend (default) is a complete reimplementation of ssh protocols natively in python. Advantages are speed and maintainability. Minor disadvantage is that extra packages are needed as listed in REQUIREMENTS. In sftp (default) mode all operations are done via the according sftp commands. In scp mode ( --use-scp ) though scp access is used for put/get operations but listing is done via ssh remote shell. SSH pexpect backend is the legacy ssh backend using the command line ssh binaries via pexpect. Older versions used scp for get and put operations and sftp for list and delete operations. The current version uses sftp for all four supported operations, unless the --use-scp option is used to revert to old behavior. SSH lftp backend is simply there because lftp can interact with the ssh cmd line binaries. It is meant as a last resort in case the above options fail for some reason. Why use sftp instead of scp? The change to sftp was made in order to allow the remote system to chroot the backup, thus providing better security and because it does not suffer from shell quoting issues like scp. Scp also does not support any kind of file listing, so sftp or ssh access will always be needed in addition for this backend mode to work properly. Sftp does not have these limitations but needs an sftp service running on the backend server, which is sometimes not an option. A NOTE ON SSL CERTIFICATE VERIFICATIONCertificate verification as implemented right now [02.2016] only in the webdav and lftp backends. older pythons 2.7.8- and older lftp binaries need a file based database of certification authority certificates (cacert file).Newer python 2.7.9+ and recent lftp versions however support the system default certificates (usually in /etc/ssl/certs) and also giving an alternative ca cert folder via --ssl-cacert-path. The cacert file has to be a PEM formatted text file as currently provided by the CURL project. See http://curl.haxx.se/docs/caextract.html
After creating/retrieving a valid cacert file you should copy it to either ~/.duplicity/cacert.pem
~/duplicity_cacert.pem /etc/duplicity/cacert.pem Duplicity searches it there in the same order and will fail if it can't find it. You can however specify the option --ssl-cacert-file <file> to point duplicity to a copy in a different location. Finally there is the --ssl-no-check-certificate option to disable certificate verification alltogether, in case some ssl library is missing or verification is not wanted. Use it with care, as even with self signed servers manually providing the private ca certificate is definitely the safer option. A NOTE ON SWIFT (OPENSTACK OBJECT STORAGE) ACCESSSwift is the OpenStack Object Storage service.The backend requires python-switclient to be installed on the system. python-keystoneclient is also needed to use OpenStack's Keystone Identity service. See REQUIREMENTS. It uses following environment variables for authentification: SWIFT_USERNAME (required), SWIFT_PASSWORD (required), SWIFT_AUTHURL (required), SWIFT_USERID (required, only for IBM Bluemix ObjectStorage), SWIFT_TENANTID (required, only for IBM Bluemix ObjectStorage), SWIFT_REGIONNAME (required, only for IBM Bluemix ObjectStorage), SWIFT_TENANTNAME (optional, the tenant can be included in the username) If the user was previously authenticated, the following environment variables can be used instead: SWIFT_PREAUTHURL (required), SWIFT_PREAUTHTOKEN (required) If SWIFT_AUTHVERSION is unspecified, it will default to version 1. A NOTE ON PCA ACCESSPCA is a long-term data archival solution by OVH. It runs a slightly modified version of Openstack Swift introducing latency in the data retrieval process. It is a good pick for a multi backend configuration where receiving volumes while an other backend is used to store manifests and signatures.The backend requires python-switclient to be installed on the system. python-keystoneclient is also needed to interact with OpenStack's Keystone Identity service. See REQUIREMENTS. It uses following environment variables for authentification: PCA_USERNAME (required), PCA_PASSWORD (required), PCA_AUTHURL (required), PCA_USERID (optional), PCA_TENANTID (optional, but either the tenant name or tenant id must be supplied) PCA_REGIONNAME (optional), PCA_TENANTNAME (optional, but either the tenant name or tenant id must be supplied) If the user was previously authenticated, the following environment variables can be used instead: PCA_PREAUTHURL (required), PCA_PREAUTHTOKEN (required) If PCA_AUTHVERSION is unspecified, it will default to version 2. A NOTE ON MEDIAFIRE BACKENDThis backend requires mediafire python library to be installed on the system. See REQUIREMENTS.Use URL escaping for username (and password, if provided via command line): mf://duplicity%40example.com@mediafire.com/some_folder
The destination folder will be created for you if it does not exist. A NOTE ON SYMMETRIC ENCRYPTION AND SIGNINGSigning and symmetrically encrypt at the same time with the gpg binary on the command line, as used within duplicity, is a specifically challenging issue. Tests showed that the following combinations proved working.1. Setup gpg-agent properly. Use the option --use-agent and enter both passphrases (symmetric and sign key) in the gpg-agent's dialog. 2. Use a PASSPHRASE for symmetric encryption of your choice but the signing key has an empty passphrase. 3. The used PASSPHRASE for symmetric encryption and the passphrase of the signing key are identical. KNOWN ISSUES / BUGSHard links currently unsupported (they will be treated as non-linked regular files).Bad signatures will be treated as empty instead of logging appropriate error message. OPERATION AND DATA FORMATSThis section describes duplicity's basic operation and the format of its data files. It should not necessary to read this section to use duplicity.The files used by duplicity to store backup data are tarfiles in GNU tar format. They can be produced independently by rdiffdir(1). For incremental backups, new files are saved normally in the tarfile. But when a file changes, instead of storing a complete copy of the file, only a diff is stored, as generated by rdiff(1). If a file is deleted, a 0 length file is stored in the tar. It is possible to restore a duplicity archive "manually" by using tar and then cp, rdiff, and rm as necessary. These duplicity archives have the extension difftar. Both full and incremental backup sets have the same format. In effect, a full backup set is an incremental one generated from an empty signature (see below). The files in full backup sets will start with duplicity-full while the incremental sets start with duplicity-inc. When restoring, duplicity applies patches in order, so deleting, for instance, a full backup set may make related incremental backup sets unusable. In order to determine which files have been deleted, and to calculate diffs for changed files, duplicity needs to process information about previous sessions. It stores this information in the form of tarfiles where each entry's data contains the signature (as produced by rdiff) of the file instead of the file's contents. These signature sets have the extension sigtar. Signature files are not required to restore a backup set, but without an up-to-date signature, duplicity cannot append an incremental backup to an existing archive. To save bandwidth, duplicity generates full signature sets and incremental signature sets. A full signature set is generated for each full backup, and an incremental one for each incremental backup. These start with duplicity-full-signatures and duplicity-new-signatures respectively. These signatures will be stored both locally and remotely. The remote signatures will be encrypted if encryption is enabled. The local signatures will not be encrypted and stored in the archive dir (see --archive-dir ). REQUIREMENTSDuplicity requires a POSIX-like operating system with a python interpreter version 2.6+ installed. It is best used under GNU/Linux.Some backends also require additional components (probably available as packages for your specific platform):
AUTHOR
Most backends were contributed individually. Information about their authorship may be found in the according file's header. Also we'd like to thank everybody posting issues to the mailing list or on launchpad, sending in patches or contributing otherwise. Duplicity wouldn't be as stable and useful if it weren't for you. A special thanks goes to rsync.net, a Cloud Storage provider with explicit support for duplicity, for several monetary donations and for providing a special "duplicity friends" rate for their offsite backup service. Email info@rsync.net for details. SEE ALSOrdiffdir(1), python(1), rdiff(1), rdiff-backup(1).
Visit the GSP FreeBSD Man Page Interface. |