mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-21 23:33:07 +00:00
Code Issues Releases Wiki Activity

check: improve docs

Browse source
This commit is contained in:
Thomas Waldmann 2024-11-05 21:38:46 +01:00
parent 7cd048f53a
commit 142a739105
No known key found for this signature in database
GPG key ID: 243ACFA951F78E01
1 changed files with 20 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
src/borg/archiver/check_cmd.py
View file

@ -85,12 +85,14 @@ def build_parser_check(self, subparsers, common_parser, mid_common_parser):
archive data (requires ``--verify-data``). This includes ensuring that the
repository manifest exists, the archive metadata chunk is present, and that
all chunks referencing files (items) in the archive exist. This requires
reading archive and file metadata, but not data. To cryptographically verify
the file (content) data integrity pass ``--verify-data``, but keep in mind
that this requires reading all data and is hence very time consuming. When
checking archives of a remote repository, archive checks run on the client
machine because they require decrypting data and therefore the encryption
key.
reading archive and file metadata, but not data. To scan for archives whose
entries were lost from the archive directory, pass ``--find-lost-archives``.
It requires reading all data and is hence very time consuming.
To additionally cryptographically verify the file (content) data integrity,
pass ``--verify-data``, which is even more time consuming.
When checking archives of a remote repository, archive checks run on the client
machine because they require decrypting data and therefore the encryption key.
Both steps can also be run independently. Pass ``--repository-only`` to run the
repository checks only, or pass ``--archives-only`` to run the archive checks
@ -122,6 +124,15 @@ def build_parser_check(self, subparsers, common_parser, mid_common_parser):
encrypted repositories against attackers without access to the keys. You can
not use ``--verify-data`` with ``--repository-only``.
The ``--find-lost-archives`` option will also scan the whole repository, but
tells Borg to search for lost archive metadata. If Borg encounters any archive
metadata that doesn't match with an archive directory entry, it means that an
entry was lost.
Unless ``borg compact`` is called, these archives can be fully restored with
``--repair``. Please note that ``--find-lost-archives`` must read a lot of
data from the repository and is thus very time consuming. You can not use
``--find-lost-archives`` with ``--repository-only``.
About repair mode
+++++++++++++++++
@ -180,12 +191,9 @@ def build_parser_check(self, subparsers, common_parser, mid_common_parser):
Consequently, if lost chunks were repaired earlier, it is advised to run
``--repair`` a second time after creating some new backups.
If ``--repair --find-lost-archives`` is given, Borg will scan the repository
for archive metadata and if it finds some where no corresponding archives
directory entry exists, it will create one.
This will make archives reappear for which the directory entry was lost.
This is only possible before ``borg compact`` would remove the archives'
data completely.
If ``--repair --find-lost-archives`` is given, previously lost entries will
be recreated in the archive directory. This is only possible before
``borg compact`` would remove the archives' data completely.
"""
)
subparser = subparsers.add_parser(