psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document limitation about using database hooks and "one_file_system" (#853).

Browse source
This commit is contained in:
Dan Helfman 2024-04-20 14:53:41 -07:00
parent 54facdc391
commit 058af95d70
1 changed files with 21 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/how-to/backup-your-databases.md
View file

@ -437,19 +437,27 @@ borgmatic's own configuration file. So include your configuration file in
backups to avoid getting caught without a way to restore a database. backups to avoid getting caught without a way to restore a database.
3. borgmatic does not currently support backing up or restoring multiple 3. borgmatic does not currently support backing up or restoring multiple
databases that share the exact same name on different hosts. databases that share the exact same name on different hosts.
4. Because database hooks implicitly enable the `read_special` configuration, 4. Because database hooks implicitly enable the `read_special` option, any
any special files are excluded from backups (named pipes, block devices, special files are excluded from backups (named pipes, block devices,
character devices, and sockets) to prevent hanging. Try a command like `find character devices, and sockets) to prevent hanging. Try a command like
/your/source/path -type b -or -type c -or -type p -or -type s` to find such `find /your/source/path -type b -or -type c -or -type p -or -type s` to
files. Common directories to exclude are `/dev` and `/run`, but that may not find such files. Common directories to exclude are `/dev` and `/run`, but
be exhaustive. <span class="minilink minilink-addedin">New in version that may not be exhaustive. <span class="minilink minilink-addedin">New in
1.7.3</span> When database hooks are enabled, borgmatic automatically excludes version 1.7.3</span> When database hooks are enabled, borgmatic
special files (and symlinks to special files) that may cause Borg to hang, so automatically excludes special files (and symlinks to special files) that
generally you no longer need to manually exclude them. There are potential may cause Borg to hang, so generally you no longer need to manually exclude
edge cases though in which applications on your system create new special files them. There are potential edge cases though in which applications on your
*after* borgmatic constructs its exclude list, resulting in Borg hangs. If that system create new special files *after* borgmatic constructs its exclude
occurs, you can resort to the manual excludes described above. And to opt out list, resulting in Borg hangs. If that occurs, you can resort to the manual
of the auto-exclude feature entirely, explicitly set `read_special` to true. excludes described above. And to opt out of the auto-exclude feature
entirely, explicitly set `read_special` to true.
5. Database hooks also implicitly enable the `one_file_system` option, which
means Borg won't cross filesystem boundaries when looking for files to backup.
This is especially important when running borgmatic in a container, as
container volumes are mounted as separate filesystems. One work-around is to
explicitly add each mounted volume you'd like to backup to
`source_directories` instead of relying on Borg to include them implicitly via
a parent directory.
### Manual restoration ### Manual restoration