From 1eee2c0d2e81c4ee2a30cae63ec76bf325932866 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Sat, 24 Jul 2021 22:08:59 +0200 Subject: [PATCH] documentation: README.md: add non-volume examples --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0708d69..1ed15c9 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,8 @@ The examples below assume that the btrfs subvolume containing `home` and `rootfs` is mounted at `/mnt/btr_pool`. This is usually the btrfs root subvolume, which always has `subvolid=5`. -Note that mounting subvolid=5 is *mandatory* if you want to backup -your root filesystem `/`. +Mounting `subvolid=5` is *recommended* (mandatory for btrbk < v0.32.0) +if you want to backup your root filesystem `/`. /etc/fstab: @@ -139,6 +139,19 @@ be created manually: sudo mkdir /mnt/btr_pool/btrbk_snapshots +The "volume" section is merely used as a specifier for a base +directory, and can be skipped if you prefer to configure everything +using absolute paths. The above configuration can also be written as: + + snapshot_dir /mnt/btr_pool/btrbk_snapshots + subvolume /mnt/btr_pool/home + +If you don't want to mount the btrfs root filesystem to +`/mnt/btr_pool`, you might as well configure it like this: + + snapshot_dir /btrbk_snapshots + subvolume /home + Start a dry run: sudo btrbk run -n