Name¶

borg-config - get, set, and delete values in a repository or cache config file

SYNOPSIS¶

borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]

DESCRIPTION¶

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.

OPTIONS¶

See borg-common(1) for common options of Borg commands.

EXAMPLES¶

Note:

# find cache directory
$ cd ~/.cache/borg/$(borg config /path/to/repo id)
# reserve some space
$ borg config /path/to/repo additional_free_space 2G
# make a repo append-only
$ borg config /path/to/repo append_only 1

SEE ALSO¶

borg-common(1)

Author¶

The Borg Collective