Built-in collect pointsΒΆ
Required parameters are marked in red.
engine=archive
- Create an archive (.tar.gz, .tar.xz or .tar.bz2) with files collected from all sources.
List of available parameters:
- archive_name: Name of the created archive, must end by .tar.gz, .tar.bz2 or .tar.xz. Default: "archive.tar.gz"1
- collect_point_tags: list of tags (comma-separated) associated to this collect point. Default: "collect"
- excluded_backup_point_tags: any backup point with one of these tags (comma-separated) will not be associated to this local repo. 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_backup_point_tags: any backup point with one of these tags (comma-separated) will be associated to this local repo. You can use ? or * as jokers in these tags. Default: "*"
- local_path: absolute path where all data are locally gathered 1
engine=files
- Collect files from all sources in the folder 'local_path'.
List of available parameters:
- collect_point_tags: list of tags (comma-separated) associated to this collect point. Default: "collect"
- excluded_backup_point_tags: any backup point with one of these tags (comma-separated) will not be associated to this local repo. 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_backup_point_tags: any backup point with one of these tags (comma-separated) will be associated to this local repo. You can use ? or * as jokers in these tags. Default: "*"
- local_path: absolute path where all data are locally gathered 1
engine=git
- Create a local git repository. Collect files from all sources and commit them locally.
List of available parameters:
- collect_point_tags: list of tags (comma-separated) associated to this collect point. Default: "collect"
- commit_email: user email used for signing commits (default: "docs@build-7784484-project-54907-polyarchiv") 1
- commit_message: commit message (default: "Backup {Y}/{m}/{d} {H}:{M}") 1
- commit_name: user name used for signing commits (default: "docs") 1
- excluded_backup_point_tags: any backup point with one of these tags (comma-separated) will not be associated to this local repo. 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_backup_point_tags: any backup point with one of these tags (comma-separated) will be associated to this local repo. You can use ? or * as jokers in these tags. Default: "*"
- local_path: absolute path where all data are locally gathered 1
engine=subversion
- Collect files from all sources in the folder 'local_path' and commit them to a remote SVN repository.
List of available parameters:
- ca_cert: CA certificate associated to 'remote_url'. Set to "any" for not checking certificates 1
- client_cert: Client certificate associated to 'remote_url' 1
- client_cert_password: Password for encrypted client certificates 1
- collect_point_tags: list of tags (comma-separated) associated to this collect point. Default: "collect"
- commit_message: commit message (default: "Backup {Y}/{m}/{d} {H}:{M}") 1
- excluded_backup_point_tags: any backup point with one of these tags (comma-separated) will not be associated to this local repo. 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_backup_point_tags: any backup point with one of these tags (comma-separated) will be associated to this local repo. You can use ? or * as jokers in these tags. Default: "*"
- local_path: absolute path where all data are locally gathered 1
- remote_url: URL of the remote repository (must exist). Should contain username and password 12
- this parameter can use variables
- please only use file/http/https/ssh URLs. If a username and a password are required, their must be provided in the URL.