From 57decfa4db425b29a172e6e0a1e4b1b60570500a Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Sat, 16 Nov 2024 16:45:49 -0800 Subject: [PATCH] Document the fact that the config bootstrap feature writes to the runtime directory (#934). --- docs/how-to/extract-a-backup.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/how-to/extract-a-backup.md b/docs/how-to/extract-a-backup.md index cc68824d..f6909110 100644 --- a/docs/how-to/extract-a-backup.md +++ b/docs/how-to/extract-a-backup.md @@ -156,12 +156,19 @@ borgmatic umount --mount-point /mnt ## Extract the configuration files used to create an archive -New in version 1.7.15 borgmatic -automatically stores all the configuration files used to create an archive -inside the archive itself. They are stored in the archive using their full -paths from the machine being backed up. This is useful in cases where you've -lost a configuration file or you want to see what configurations were used to -create a particular archive. +New in version 1.7.15 As part +of creating a backup archive, borgmatic automatically includes all of the +configuration files used when creating it, storing them inside the archive +itself with their full paths from the machine being backed up. This is useful +in cases where you've lost a configuration file or you want to see what +configurations were used to create a particular archive. + +To support this, borgmatic creates a manifest file that records the paths of +all the borgmatic configuration files stored within an archive. The file gets +written to borgmatic's runtime directory on disk and then stored within the +archive. See the [runtime directory +documentation](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#runtime-directory) +for how and where that happens. To extract the configuration files from an archive, use the `config bootstrap` action. For example: