upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-06-13 10:50:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

improve configuration precedence docs

Browse source
This commit is contained in:
Thomas Waldmann 2026-02-28 19:46:06 +01:00
parent cf6fd0769d
commit f2bdb689c5
No known key found for this signature in database
GPG key ID: 243ACFA951F78E01
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/usage/general/config.rst.inc
View file

@ -1,3 +1,15 @@
Configuration Precedence
~~~~~~~~~~~~~~~~~~~~~~~~
From lowest to highest:
1. Defaults defined in the source code.
2. Default config file (``$BORG_CONFIG_DIR/default.yaml``).
3. ``--config`` file(s) (in the order given).
4. Full config environment variable: (``BORG_CONFIG``).
5. Environment variables (e.g. ``BORG_LOG_LEVEL``).
6. Command-line arguments in order left to right (might include config files).
Configuration files
~~~~~~~~~~~~~~~~~~~
@ -44,12 +56,6 @@ File format
under a subcommand name (e.g. ``create:``) are only applied when that
subcommand is invoked.
Precedence (lowest to highest)
1. Default config file (``$BORG_CONFIG_DIR/default.yaml``)
2. ``--config`` file(s) (in the order given)
3. Environment variables (e.g. ``BORG_REPO``)
4. Command-line arguments
.. note::
``--print_config`` shows the merged effective configuration and is a
convenient way to check what values Borg will actually use, and to