psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

When generating sample configuration, document the defaults for each option (#103).

Browse source
This commit is contained in:
Dan Helfman 2018-12-25 17:05:22 -08:00
parent 45a537b6b1
commit 426f54c9cc
2 changed files with 22 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
NEWS
View file

@ -1,4 +1,6 @@
1.2.14.dev0 1.2.14.dev0
* #103: When generating sample configuration with generate-borgmatic-config, document the defaults
for each option.
* #116: When running multiple configuration files, attempt all configuration files even if one of * #116: When running multiple configuration files, attempt all configuration files even if one of
them errors. Log a summary of results at the end. them errors. Log a summary of results at the end.

36
borgmatic/config/schema.yaml
View file

@ -30,14 +30,14 @@ map:
- user@backupserver:sourcehostname.borg - user@backupserver:sourcehostname.borg
one_file_system: one_file_system:
type: bool type: bool
desc: Stay in same file system (do not cross mount points). desc: Stay in same file system (do not cross mount points). Defaults to false.
example: true example: true
read_special: read_special:
type: bool type: bool
desc: | desc: |
Use Borg's --read-special flag to allow backup of block and other special Use Borg's --read-special flag to allow backup of block and other special
devices. Use with caution, as it will lead to problems if used when devices. Use with caution, as it will lead to problems if used when
backing up special devices such as /dev/zero. backing up special devices such as /dev/zero. Defaults to false.
example: false example: false
bsd_flags: bsd_flags:
type: bool type: bool
@ -48,7 +48,7 @@ map:
desc: | desc: |
Mode in which to operate the files cache. See Mode in which to operate the files cache. See
https://borgbackup.readthedocs.io/en/stable/usage/create.html#description for https://borgbackup.readthedocs.io/en/stable/usage/create.html#description for
details. details. Defaults to "ctime,size,inode".
example: ctime,size,inode example: ctime,size,inode
local_path: local_path:
type: scalar type: scalar
@ -102,11 +102,13 @@ map:
type: bool type: bool
desc: | desc: |
Exclude directories that contain a CACHEDIR.TAG file. See Exclude directories that contain a CACHEDIR.TAG file. See
http://www.brynosaurus.com/cachedir/spec.html for details. http://www.brynosaurus.com/cachedir/spec.html for details. Defaults to false.
example: true example: true
exclude_if_present: exclude_if_present:
type: scalar type: scalar
desc: Exclude directories that contain a file with the given filename. desc: |
Exclude directories that contain a file with the given filename. Defaults to not
set.
example: .nobackup example: .nobackup
storage: storage:
desc: | desc: |
@ -121,7 +123,7 @@ map:
The standard output of this command is used to unlock the encryption key. Only The standard output of this command is used to unlock the encryption key. Only
use on repositories that were initialized with passcommand/repokey encryption. use on repositories that were initialized with passcommand/repokey encryption.
Note that if both encryption_passcommand and encryption_passphrase are set, Note that if both encryption_passcommand and encryption_passphrase are set,
then encryption_passphrase takes precedence. then encryption_passphrase takes precedence. Defaults to not set.
example: "secret-tool lookup borg-repository repo-name" example: "secret-tool lookup borg-repository repo-name"
encryption_passphrase: encryption_passphrase:
type: scalar type: scalar
@ -129,7 +131,7 @@ map:
Passphrase to unlock the encryption key with. Only use on repositories that were Passphrase to unlock the encryption key with. Only use on repositories that were
initialized with passphrase/repokey encryption. Quote the value if it contains initialized with passphrase/repokey encryption. Quote the value if it contains
punctuation, so it parses correctly. And backslash any quote or backslash punctuation, so it parses correctly. And backslash any quote or backslash
literals as well. literals as well. Defaults to not set.
example: "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~" example: "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
checkpoint_interval: checkpoint_interval:
type: int type: int
@ -143,7 +145,7 @@ map:
desc: | desc: |
Specify the parameters passed to then chunker (CHUNK_MIN_EXP, CHUNK_MAX_EXP, Specify the parameters passed to then chunker (CHUNK_MIN_EXP, CHUNK_MAX_EXP,
HASH_MASK_BITS, HASH_WINDOW_SIZE). See https://borgbackup.readthedocs.io/en/stable/internals.html HASH_MASK_BITS, HASH_WINDOW_SIZE). See https://borgbackup.readthedocs.io/en/stable/internals.html
for details. for details. Defaults to "19,23,21,4095".
example: 19,23,21,4095 example: 19,23,21,4095
compression: compression:
type: scalar type: scalar
@ -154,25 +156,27 @@ map:
example: lz4 example: lz4
remote_rate_limit: remote_rate_limit:
type: int type: int
desc: Remote network upload rate limit in kiBytes/second. desc: Remote network upload rate limit in kiBytes/second. Defaults to unlimited.
example: 100 example: 100
ssh_command: ssh_command:
type: scalar type: scalar
desc: Command to use instead of just "ssh". This can be used to specify ssh options. desc: |
Command to use instead of just "ssh". This can be used to specify ssh options.
Defaults to not set.
example: ssh -i /path/to/private/key example: ssh -i /path/to/private/key
umask: umask:
type: scalar type: scalar
desc: Umask to be used for borg create. desc: Umask to be used for borg create. Defaults to 0077.
example: 0077 example: 0077
lock_wait: lock_wait:
type: int type: int
desc: Maximum seconds to wait for acquiring a repository/cache lock. desc: Maximum seconds to wait for acquiring a repository/cache lock. Defaults to 1.
example: 5 example: 5
archive_name_format: archive_name_format:
type: scalar type: scalar
desc: | desc: |
Name of the archive. Borg placeholders can be used. See the output of Name of the archive. Borg placeholders can be used. See the output of
"borg help placeholders" for details. Default is "borg help placeholders" for details. Defaults to
"{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this option, you must "{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this option, you must
also specify a prefix in the retention section to avoid accidental pruning of also specify a prefix in the retention section to avoid accidental pruning of
archives with a different archive name format. And you should also specify a archives with a different archive name format. And you should also specify a
@ -221,7 +225,7 @@ map:
desc: | desc: |
When pruning, only consider archive names starting with this prefix. When pruning, only consider archive names starting with this prefix.
Borg placeholders can be used. See the output of "borg help placeholders" for Borg placeholders can be used. See the output of "borg help placeholders" for
details. Default is "{hostname}-". details. Defaults to "{hostname}-".
example: sourcehostname example: sourcehostname
consistency: consistency:
desc: | desc: |
@ -256,14 +260,14 @@ map:
check_last: check_last:
type: int type: int
desc: Restrict the number of checked archives to the last n. Applies only to the desc: Restrict the number of checked archives to the last n. Applies only to the
"archives" check. "archives" check. Defaults to checking all archives.
example: 3 example: 3
prefix: prefix:
type: scalar type: scalar
desc: | desc: |
When performing the "archives" check, only consider archive names starting with When performing the "archives" check, only consider archive names starting with
this prefix. Borg placeholders can be used. See the output of this prefix. Borg placeholders can be used. See the output of
"borg help placeholders" for details. Default is "{hostname}-". "borg help placeholders" for details. Defaults to "{hostname}-".
example: sourcehostname example: sourcehostname
hooks: hooks:
desc: | desc: |