borg [common options] config [options] [NAME] [VALUE]
positional arguments |
||
|
name of config key |
|
|
new value for key |
|
optional arguments |
||
|
get and set values from the repo cache |
|
|
delete the key from the config file |
|
|
list the configuration of the repo |
|
This command gets and sets options in a local repository or cache config file. For security reasons, this command only works on local repositories.
To delete a config value entirely, use --delete
. To list the values
of the configuration file or the default values, use --list
. To get an existing
key, pass only the key name. To set a key, pass both the key name and
the new value. Keys can be specified in the format “section.name” or
simply “name”; the section will default to “repository” and “cache” for
the repo and cache configs, respectively.
By default, borg config manipulates the repository config file. Using --cache
edits the repository cache’s config file instead.
Note
The repository & cache config files are some of the only directly manipulable parts of a repository that aren’t versioned or backed up, so be careful when making changes!
# find cache directory
$ cd ~/.cache/borg/$(borg config id)
# reserve some space
$ borg config additional_free_space 2G
# make a repo append-only
$ borg config append_only 1