Skip to content

Commit 8bc96ba

Browse files
committed
docs: usage of btrbk
1 parent 68629e9 commit 8bc96ba

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

modules/nixos/base/btrbk.nix

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
{
2+
# ==================================================================
3+
#
24
# Tool for creating snapshots and remote backups of btrfs subvolumes
3-
# https://github.com/digint/btrbk
5+
# https://github.com/digint/btrbk
6+
#
7+
# Usage:
8+
# 1. btrbk will create snapshots on schedule
9+
# 2. we can use `btrbk run` command to create a backup manually
10+
#
11+
# How to restore a snapshot:
12+
# 1. Find the snapshot you want to restore in /snapshots
13+
# 2. Use `btrfs subvol delete /btr_pool/@persistent` to delete the current subvolume
14+
# 3. Use `btrfs subvol snapshot /snapshots/2021-01-01 /btr_pool/@persistent` to restore the snapshot
15+
# 4. reboot the system or remount the filesystem to see the changes
16+
#
17+
# ==================================================================
18+
419
services.btrbk.instances.btrbk = {
520
# How often this btrbk instance is started. See systemd.time(7) for more information about the format.
621
onCalendar = "daily";

0 commit comments

Comments
 (0)