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

docs: mount: document on-demand loading, perf tips, fixes #7173

Browse source
This commit is contained in:
Thomas Waldmann 2024-10-05 14:35:21 +02:00
parent cf472302dc
commit cbbfc35db0
No known key found for this signature in database
GPG key ID: 243ACFA951F78E01
1 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/borg/archiver.py
View file

@ -3083,10 +3083,25 @@ class Archiver:
# borg mount # borg mount
mount_epilog = process_epilog(""" mount_epilog = process_epilog("""
This command mounts an archive as a FUSE filesystem. This can be useful for This command mounts a repository or an archive as a FUSE filesystem.
browsing an archive or restoring individual files. Unless the ``--foreground`` This can be useful for browsing or restoring individual files.
option is given the command will run in the background until the filesystem
is ``umounted``. When restoring, take into account that the current FUSE implementation does
not support special fs flags and ACLs.
When mounting a repository, the top directories will be named like the
archives and the directory structure below these will be loaded on-demand from
the repository when entering these directories, so expect some delay.
Unless the ``--foreground`` option is given the command will run in the
background until the filesystem is ``umounted``.
Performance tips:
- when doing a "whole repository" mount:
do not enter archive dirs if not needed, this avoids on-demand loading.
- only mount a specific archive, not the whole repository.
- only mount specific paths in a specific archive, not the complete archive.
The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be
used in fstab entries: used in fstab entries: