borg-config1
Get, set, and delete values in a repository or cache config file
Usage
borg [common
options]
config
[options]
[REPOSITORY]
[NAME]
[VALUE]
Overview
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.
arguments
REPOSITORY
|
repository to configure |
|---|---|
NAME
|
name of config key |
VALUE
|
new value for key |
options
-
-c, --cache -
get and set values from the repo cache
-
-d, --delete -
delete the key from the config file
-
-l, --list -
list the configuration of the repo
Examples
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 /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 # set storage quota to 50 GB $ borg config /path/to/repo storage_quota 50G # set maximum segment size to 100 MiB (see "Adjusting segment size" in Usage Notes) $ borg config /path/to/repo max_segment_size 104857600
Releases
5 releases since Debian 10 (Buster); the text changed 4 times.