mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-03 18:27:01 +00:00
Code Issues Releases Wiki Activity

BORG_DATA_DIR / BORG_SECURITY_DIR docs update

Browse source
This commit is contained in:
Thomas Waldmann 2023-05-17 17:56:17 +02:00
parent b8d49a0274
commit c8996aaf12
No known key found for this signature in database
GPG key ID: 243ACFA951F78E01
2 changed files with 23 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/faq.rst
View file

@ -410,13 +410,6 @@ How important is the $HOME/.config/borg directory?
The Borg config directory has content that you should take care of:
``security`` subdirectory
Each directory here represents one Borg repository by its ID and contains the last known status.
If a repository's status is different from this information at the beginning of BorgBackup
operation, Borg outputs warning messages and asks for confirmation, so make sure you do not lose
or manipulate these files. However, apart from those warnings, a loss of these files can be
recovered.
``keys`` subdirectory
All your borg keyfile keys are stored in this directory. Please note that
borg repokey keys are stored inside the repository. You MUST make sure to have an
@ -426,6 +419,22 @@ The Borg config directory has content that you should take care of:
Make sure that only you have access to the Borg config directory.
.. _home_data_borg:
How important is the $HOME/.local/share/borg directory?
-------------------------------------------------------
The Borg data directory has content that you should take care of:
``security`` subdirectory
Each directory here represents one Borg repository by its ID and contains the last known status.
If a repository's status is different from this information at the beginning of BorgBackup
operation, Borg outputs warning messages and asks for confirmation, so make sure you do not lose
or manipulate these files. However, apart from those warnings, a loss of these files can be
recovered.
Make sure that only you have access to the Borg data directory.
.. _cache_security:
Do I need to take security precautions regarding the cache?

10
docs/usage/general/environment.rst.inc
View file

@ -145,10 +145,14 @@ Directories and files:
`XDG env var`_ ``XDG_CONFIG_HOME`` is set, then ``$XDG_CONFIG_HOME/borg`` is being used instead.
This directory contains all borg configuration directories, see the FAQ
for a security advisory about the data in this directory: :ref:`home_config_borg`
BORG_DATA_DIR
Defaults to ``$BORG_BASE_DIR/.local/share/borg``. If ``BORG_BASE_DIR`` is not explicitly set while
`XDG env var`_ ``XDG_DATA_HOME`` is set, then ``$XDG_DATA_HOME/borg`` is being used instead.
This directory contains all borg data directories, see the FAQ
for a security advisory about the data in this directory: :ref:`home_data_borg`
BORG_SECURITY_DIR
Defaults to ``$BORG_CONFIG_DIR/security``.
This directory contains information borg uses to track its usage of NONCES ("numbers used
once" - usually in encryption context) and other security relevant data.
Defaults to ``$BORG_DATA_DIR/security``.
This directory contains security relevant data.
BORG_KEYS_DIR
Defaults to ``$BORG_CONFIG_DIR/keys``.
This directory contains keys for encrypted repositories.