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

docs: add info on renaming repositories (#5866)

Browse source 
docs: add info on renaming repositories, fixes #5240
This commit is contained in:
remyabel 2021-06-22 18:08:49 -04:00 • committed by GitHub
parent 35d2587aa6
commit 1c7602f9e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/faq.rst
View file

@ -1118,6 +1118,22 @@ checking for free disk space::
borg config -- $REPO_LOCATION additional_free_space -2T borg config -- $REPO_LOCATION additional_free_space -2T
How do I rename a repository?
-----------------------------
There is nothing special that needs to be done, you can simply rename the
directory that corresponds to the repository. However, the next time borg
interacts with the repository (i.e, via ``borg list``), depending on the value
of ``BORG_RELOCATED_REPO_ACCESS_IS_OK``, borg may warn you that the repository
has been moved. You will be given a prompt to confirm you are OK with this.
If ``BORG_RELOCATED_REPO_ACCESS_IS_OK`` is unset, borg will interactively ask for
each repository whether it's OK.
It may be useful to set ``BORG_RELOCATED_REPO_ACCESS_IS_OK=yes`` to avoid the
prompts when renaming multiple repositories or in a non-interactive context
such as a script. See :doc:`deployment` for an example.
Miscellaneous Miscellaneous
############# #############