Built-in backup points¶

Required parameters are marked in red.

engine=archive

Gather all files of your collect point into a .tar archive (.tar.gz, .tar.bz2 or .tar.xz) and copy it to the remote URL.

List of available parameters:

backup_point_tags: list of tags (comma-separated) associated to this backup point (default: "backup")
ca_cert: CA certificate associated to 'remote_url'. Set to "any" for not checking certificates ¹
excluded_collect_point_tags: any collect point with one of these tags (comma-separated) will not be associated to this backup point. You can use ? or * as jokers in these tags. Have precedence over included_collect_point_tags and included_backup_point_tags.
frequency: frequency of backup operations. Can be an integer (number of seconds), "monthly:d" (at least the d-th day of each month, d = 0..28), "weekly:d" (the d-th day of each week, d = 0..6), "weekly" or "daily" (once a week or once a day), "daily:h" (the h-th hour of each day, h = 0..23)
included_collect_point_tags: any collect point with one of these tags (comma-separated) will be associated to this backup point. You can use ? or * as jokers in these tags.
keytab: absolute path of the keytab file (for Kerberos authentication) ¹
metadata_ca_cert: private certificate associated to 'metadata_url' ² ³
metadata_keytab: keytab (for Kerberos authentication) associated to 'metadata_url' ² ³
metadata_private_key: private key associated to 'metadata_url' ² ³
metadata_ssh_options: SSH options associated to 'metadata_url' ² ³
metadata_url: send metadata (about the successful last backup) to this URL.Should end by "/" or use the {name} variable ² ³ ⁴
private_key: private key or certificate associated to 'remote_url' ¹
remote_url: synchronize data to this URL, like 'ssh://user@hostname/folder/archive.tar.gz'. Must end by ".tar.gz", "tar.bz2", "tar.xz" ¹ ⁴
ssh_options: SSH options associated to 'url' ¹

engine=git

Use a remote git repository and push local modifications to it. Can use https (with password or kerberos auth) or git+ssh remote URLs (with private key authentication). local and remote branches are always named 'master'.

List of available parameters:

backup_point_tags: list of tags (comma-separated) associated to this backup point (default: "backup")
commit_email: user email used for signing commits (default: "docs@build-7784484-project-54907-polyarchiv")
commit_message: commit message (default: "Backup {Y}/{m}/{d} {H}:{M}") ¹
commit_name: user name used for signing commits (default: "docs")
excluded_collect_point_tags: any collect point with one of these tags (comma-separated) will not be associated to this backup point. You can use ? or * as jokers in these tags. Have precedence over included_collect_point_tags and included_backup_point_tags.
frequency: frequency of backup operations. Can be an integer (number of seconds), "monthly:d" (at least the d-th day of each month, d = 0..28), "weekly:d" (the d-th day of each week, d = 0..6), "weekly" or "daily" (once a week or once a day), "daily:h" (the h-th hour of each day, h = 0..23)
included_collect_point_tags: any collect point with one of these tags (comma-separated) will be associated to this backup point. You can use ? or * as jokers in these tags.
keytab: absolute path of the keytab file (for Kerberos authentication) ¹
metadata_ca_cert: private certificate associated to 'metadata_url' ² ³
metadata_keytab: keytab (for Kerberos authentication) associated to 'metadata_url' ² ³
metadata_private_key: private key associated to 'metadata_url' ² ³
metadata_ssh_options: SSH options associated to 'metadata_url' ² ³
metadata_url: send metadata (about the successful last backup) to this URL.Should end by "/" or use the {name} variable ² ³ ⁴
private_key: absolute path of the private key file (for SSH key authentication) ¹
remote_url: URL of the remote server, including username and password (e.g.: ssh://git@mygitlab.example.org/project.git, file:///foo/bar/project.git or https://username:password@mygitlab.example.org/username/project.git). The password is not required for SSH connections (you should use SSH keys).The backup point must already exists. If you created it by hand, do not forget to set 'git config --bool core.bare true'. ¹ ⁴

engine=gitlab

Use a remote git repository and push local modifications to it. If the 'private_key' is set, then git+ssh is used for pushing data. Otherwise, use password or kerberos auth with git+http. The backup point is automatically created if required using the HTTP API provided by Gitlab.

List of available parameters:

api_key: API key allowing for creating new repositories ¹
backup_point_tags: list of tags (comma-separated) associated to this backup point (default: "backup")
commit_email: user email used for signing commits (default: "docs@build-7784484-project-54907-polyarchiv")
commit_message: commit message (default: "Backup {Y}/{m}/{d} {H}:{M}") ¹
commit_name: user name used for signing commits (default: "docs")
excluded_collect_point_tags: any collect point with one of these tags (comma-separated) will not be associated to this backup point. You can use ? or * as jokers in these tags. Have precedence over included_collect_point_tags and included_backup_point_tags.
frequency: frequency of backup operations. Can be an integer (number of seconds), "monthly:d" (at least the d-th day of each month, d = 0..28), "weekly:d" (the d-th day of each week, d = 0..6), "weekly" or "daily" (once a week or once a day), "daily:h" (the h-th hour of each day, h = 0..23)
gitlab_url: HTTP URL of the gitlab server (e.g.: 'https://mygitlab.example.org/') ¹ ⁴
included_collect_point_tags: any collect point with one of these tags (comma-separated) will be associated to this backup point. You can use ? or * as jokers in these tags.
keytab: absolute path of the keytab file (for Kerberos authentication) ¹
metadata_ca_cert: private certificate associated to 'metadata_url' ² ³
metadata_keytab: keytab (for Kerberos authentication) associated to 'metadata_url' ² ³
metadata_private_key: private key associated to 'metadata_url' ² ³
metadata_ssh_options: SSH options associated to 'metadata_url' ² ³
metadata_url: send metadata (about the successful last backup) to this URL.Should end by "/" or use the {name} variable ² ³ ⁴
password: Password for HTTP auth (if private_key and keytab are not set) ¹
private_key: absolute path of the private key file (for SSH key authentication) ¹
project_name: Name of the Gitlab project (e.g. 'myuser/myproject')¹
username: Username to use for pushing data. If you use git+ssh, use the SSH username (often 'git'), otherwise use your real username. ¹

engine=restic

Use a remote restic repository and push local modifications to it. Check https://restic.readthedocs.io/en/stable/index.html for more info.

List of available parameters:

backup_point_tags: list of tags (comma-separated) associated to this backup point (default: "backup")
excluded_collect_point_tags: any collect point with one of these tags (comma-separated) will not be associated to this backup point. You can use ? or * as jokers in these tags. Have precedence over included_collect_point_tags and included_backup_point_tags.
frequency: frequency of backup operations. Can be an integer (number of seconds), "monthly:d" (at least the d-th day of each month, d = 0..28), "weekly:d" (the d-th day of each week, d = 0..6), "weekly" or "daily" (once a week or once a day), "daily:h" (the h-th hour of each day, h = 0..23)
included_collect_point_tags: any collect point with one of these tags (comma-separated) will be associated to this backup point. You can use ? or * as jokers in these tags.
metadata_ca_cert: private certificate associated to 'metadata_url' ² ³
metadata_keytab: keytab (for Kerberos authentication) associated to 'metadata_url' ² ³
metadata_private_key: private key associated to 'metadata_url' ² ³
metadata_ssh_options: SSH options associated to 'metadata_url' ² ³
metadata_url: send metadata (about the successful last backup) to this URL.Should end by "/" or use the {name} variable ² ³ ⁴
password: restic password for encrypting data ¹
remote_auth_url: auth URL for OpenStack Swift (keystone v1/v2/v3)⁴
remote_project_domain_name: tenant name for OpenStack Swift (keystone v2), project domain name for OpenStack Swift (keystone v3)
remote_project_name: tenant ID for OpenStack Swift (keystone v2), project name for OpenStack Swift (keystone v3)
remote_region_name: region name for OpenStack Swift (keystone v2/v3)
remote_secret: secret access key for Amazon S3 and Minio Server, key/password for OpenStack Swift (keystone v1/v2/v3), account key for Blackblaze B2 and Microsoft Azure Blob Storage, path to the JSON key file for Google Cloud Storage
remote_url: URL of the remote server. Any valid Restic URL can be used.The repository must be initialized (https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html) ¹ ⁴
remote_user_domain_name: user domain name for OpenStack Swift (keystone v3)
remote_username: access key id for Amazon S3 and Minio Server, username for OpenStack Swift (keystone v1/v2/v3), account ID for Backblaze B2, account name for Microsoft Azure Blob Storage, google project ID for Google Cloud Storage

engine=rolling_archive

Gather all files of your collect point into a .tar archive (.tar.gz, .tar.bz2 or .tar.xz) and copy it to the remote URL. Also tracks previous archives to only keep a given number of hourly/daily/weekly/yearly backups, deleting unneeded ones.

List of available parameters:

backup_point_tags: list of tags (comma-separated) associated to this backup point (default: "backup")
ca_cert: CA certificate associated to 'remote_url'. Set to "any" for not checking certificates ¹
daily_count: Number of daily backups to keep (default to 30)
excluded_collect_point_tags: any collect point with one of these tags (comma-separated) will not be associated to this backup point. You can use ? or * as jokers in these tags. Have precedence over included_collect_point_tags and included_backup_point_tags.
frequency: frequency of backup operations. Can be an integer (number of seconds), "monthly:d" (at least the d-th day of each month, d = 0..28), "weekly:d" (the d-th day of each week, d = 0..6), "weekly" or "daily" (once a week or once a day), "daily:h" (the h-th hour of each day, h = 0..23)
hourly_count: Number of hourly backups to keep (default to 0)
included_collect_point_tags: any collect point with one of these tags (comma-separated) will be associated to this backup point. You can use ? or * as jokers in these tags.
keytab: absolute path of the keytab file (for Kerberos authentication) ¹
metadata_ca_cert: private certificate associated to 'metadata_url' ² ³
metadata_keytab: keytab (for Kerberos authentication) associated to 'metadata_url' ² ³
metadata_private_key: private key associated to 'metadata_url' ² ³
metadata_ssh_options: SSH options associated to 'metadata_url' ² ³
metadata_url: send metadata (about the successful last backup) to this URL.Should end by "/" or use the {name} variable ² ³ ⁴
private_key: private key or certificate associated to 'remote_url' ¹
remote_url: synchronize data to this URL (SHOULD DEPEND ON THE DATE AND TIME): 'file:///var/backup/archive-{Y}-{m}-{d}_{H}-{M}.tar.gz'Must end by ".tar.gz", "tar.bz2", "tar.xz" ¹ ⁴
ssh_options: SSH options associated to 'url' ¹
weekly_count: Number of weekly backups to keep (default to 100)
yearly_count: Number of yearly backups to keep (fefault to 20)

engine=synchronize

List of available parameters:

backup_point_tags: list of tags (comma-separated) associated to this backup point (default: "backup")
ca_cert: CA certificate associated to 'remote_url'. Set to "any" for not checking certificates ¹
excluded_collect_point_tags: any collect point with one of these tags (comma-separated) will not be associated to this backup point. You can use ? or * as jokers in these tags. Have precedence over included_collect_point_tags and included_backup_point_tags.
frequency: frequency of backup operations. Can be an integer (number of seconds), "monthly:d" (at least the d-th day of each month, d = 0..28), "weekly:d" (the d-th day of each week, d = 0..6), "weekly" or "daily" (once a week or once a day), "daily:h" (the h-th hour of each day, h = 0..23)
included_collect_point_tags: any collect point with one of these tags (comma-separated) will be associated to this backup point. You can use ? or * as jokers in these tags.
keytab: absolute path of the keytab file (for Kerberos authentication) ¹
metadata_ca_cert: private certificate associated to 'metadata_url' ² ³
metadata_keytab: keytab (for Kerberos authentication) associated to 'metadata_url' ² ³
metadata_private_key: private key associated to 'metadata_url' ² ³
metadata_ssh_options: SSH options associated to 'metadata_url' ² ³
metadata_url: send metadata (about the successful last backup) to this URL.Should end by "/" or use the {name} variable ² ³ ⁴
private_key: private key or certificate associated to 'remote_url' ¹
remote_url: synchronize data to this URL. Must ends by a folder name ¹ ⁴
ssh_options: SSH options associated to 'url' ¹

this parameter can use variables
this parameter can use time/host-independent variables
Metadata should be used if some parameters use time- or host-dependent variables. This is required for restore operation.
please only use file/http/https/ssh URLs. If a username and a password are required, their must be provided in the URL.

Previous topic

Next topic

This Page

Built-in backup points¶

engine=archive

engine=git

engine=gitlab

engine=restic

engine=rolling_archive

engine=synchronize