1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-22 15:57:15 +00:00

Merge pull request #8546 from ThomasWaldmann/files-cache-upgrade-notes

upgrade notes about files cache settings when NOT using archive series
This commit is contained in:
TW 2024-11-16 18:52:33 +01:00 committed by GitHub
commit 10c25414f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -50,6 +50,16 @@ Compatibility notes:
within the same series of archives to make borg work more efficiently. within the same series of archives to make borg work more efficiently.
the name now identifies a series of archive, to identify a single archive the name now identifies a series of archive, to identify a single archive
please use aid:<archive-hash-prefix>, e.g.: borg delete aid:d34db33f please use aid:<archive-hash-prefix>, e.g.: borg delete aid:d34db33f
- in case you do NOT want to adopt the "series name" way of naming archives
(like "myarchive") as we recommend, but keep using always-changing names
(like "myserver-myarchive-20241231"), you can do that, but then you must
make use of BORG_FILES_CACHE_SUFFIX and either set it to a constant suffix
(like "all") or to a unique suffix per archive series (like
"myserver-myarchive") so that borg can find the correct files cache.
For the "all" variant, you must also set BORG_FILES_CACHE_TTL to a value
greater than the count of different archives series you write to that repo.
Usually borg uses a different files cache suffix per archive (series) name
and defaults to BORG_FILES_CACHE_TTL=2 because that is sufficient for that.
- the archive id is always given separately from the repository - the archive id is always given separately from the repository
(differently than with borg 1.x you must not give repo::archive). (differently than with borg 1.x you must not give repo::archive).
- the series name or archive id is either given as a positional parameter, - the series name or archive id is either given as a positional parameter,