borg/docs/usage/config.rst

.. include:: config.rst.inc

.. 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\!

Examples
~~~~~~~~
::

    # 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
Add borg config command (fixes #3304) This command works similarly to "git config" - it parses repo and cache configs to get, set, and delete values. It only works on local repos so a malicious client can't e.g. override their storage quota or reset the append_only flag. Add tests for borg config Add documentation for borg config Change manual config edits -> borg config There were a couple places in the documentation where it was advised to edit the repository or cache config file, a process that is stream- lined by borg config. 2017-11-11 04:30:02 +00:00			`.. include:: config.rst.inc`

			`.. 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\!`

			`Examples`
			`~~~~~~~~`
			`::`

			`# find cache directory`
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`$ cd ~/.cache/borg/$(borg config id)`
Add borg config command (fixes #3304) This command works similarly to "git config" - it parses repo and cache configs to get, set, and delete values. It only works on local repos so a malicious client can't e.g. override their storage quota or reset the append_only flag. Add tests for borg config Add documentation for borg config Change manual config edits -> borg config There were a couple places in the documentation where it was advised to edit the repository or cache config file, a process that is stream- lined by borg config. 2017-11-11 04:30:02 +00:00
			`# reserve some space`
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`$ borg config additional_free_space 2G`
Add borg config command (fixes #3304) This command works similarly to "git config" - it parses repo and cache configs to get, set, and delete values. It only works on local repos so a malicious client can't e.g. override their storage quota or reset the append_only flag. Add tests for borg config Add documentation for borg config Change manual config edits -> borg config There were a couple places in the documentation where it was advised to edit the repository or cache config file, a process that is stream- lined by borg config. 2017-11-11 04:30:02 +00:00
			`# make a repo append-only`
build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			`$ borg config append_only 1`
Add borg config command (fixes #3304) This command works similarly to "git config" - it parses repo and cache configs to get, set, and delete values. It only works on local repos so a malicious client can't e.g. override their storage quota or reset the append_only flag. Add tests for borg config Add documentation for borg config Change manual config edits -> borg config There were a couple places in the documentation where it was advised to edit the repository or cache config file, a process that is stream- lined by borg config. 2017-11-11 04:30:02 +00:00