Getting Started¶
KARTOZA · ZFS BACKUP
The shortest path from "I have a fresh USB drive" to "I have an encrypted, incremental, multi-host backup pool that I trust."
The five-minute tour¶
- Install the binary. Either drop the release binary into
/usr/local/bin/zfs-backupor run straight from the flake withnix run github:timlinux/zfs-backup. See Installation. - Plug in a fresh USB drive and run
sudo zfs-backup. Choose Prepare Backup Device from the menu and follow the prompts — the tool will create an encryptedNIXBACKUPSpool with AES-256-GCM. - Run a backup. Choose Backup ZFS. The tool snapshots the source pool, sends only the changes, prunes old snapshots to bookmarks, exports the pool and powers off the drive when it's done.
- Watch it work. The per-snapshot dot matrix lights up as each snapshot lands on the destination. You see real progress, not a spinner.
- Read the report. A markdown + PDF report lands in
~/.local/share/zfs-backup/reports/after every run with every timing, every size, and the full pool inventory.
Next stops¶
-
User Guide
Full walkthroughs for every menu — backup, restore, pool info, maintenance.
-
Administrator Guide
Encryption, retention policies, ZFS delegation, packaging.
-
Developer Guide
Architecture, build instructions, contributing.