SNAPPER-BACKUP-CON(5)

💖 SNAPPER-BACKUP-CON(5) 💖

okay bestie, welcome to the Filesystem Snapshot Management corner of the manual, this one's called SNAPPER-BACKUP-CON(5) and it's literally all about how you tell snapper where to send your backups 🦋

---

✨ NAME ✨

snapper-backup-configs — configuration files for snapper backup configs 🎀

---

🌸 DESCRIPTION 🌸

So every single file living at /etc/snapper/backup-configs/*.json is describing one snapper backup config. That's it, that's the whole job. One file, one config, no cap.

Each file uses JSON syntax and contains a single object made of key-value pairs. Simple. Clean. Iconic. 💅

---

👑 KEY VALUE PAIRS 👑

Here's the whole list of keys that can show up in the config file. No skipping, we're doing all of them, periodt.

• config — the name of the snapper config. 🫶
• target-mode — either local or ssh-push.
• source-path — the path of the source subvolume. bestie this must match the subvolume of the corresponding snapper config, fr fr, no vibe-checking your way around it.
• target-path — the path of the target subvolume or mount point. 📁
• automatic — a boolean that enables automatic transfer and delete for the backup config using a systemd timer service. set it and forget it energy ✨
• ssh-host — the name of the target host. Required for target mode ssh-push.
• ssh-port — the port of the target host. Optional for target mode ssh-push.
• ssh-user — the user on the target host. Optional for target mode ssh-push.
• ssh-identity — an ssh-identity to access the host without requiring a password or passphrase. Optional for target mode ssh-push. 🔑
• target-btrfs-bin — location of the btrfs binary on the target. can also be used to install wrapper scripts. Optional.
• target-findmnt-bin — location of the findmnt binary on the target. can also be used to install wrapper scripts. Optional.
• target-mkdir-bin — location of the mkdir binary on the target. can also be used to install wrapper scripts. Optional.
• target-realpath-bin — location of the realpath binary on the target. can also be used to install wrapper scripts. Optional.
• target-rm-bin — location of the rm binary on the target. can also be used to install wrapper scripts. Optional.
• target-rmdir-bin — location of the rmdir binary on the target. can also be used to install wrapper scripts. Optional.

---

🌈 EXAMPLES 🌈

💜 local backups

an example backup config for local backups, look at her:

{
    "config": "root",
    "target-mode": "local",
    "automatic": true,
    "source-path": "/",
    "target-path": "/backups/root"
}

💜 remote backups via ssh-push

an example backup config for remote backups via ssh-push, she's a little extra but we love her:

{
    "config": "root",
    "target-mode": "ssh-push",
    "automatic": false,
    "source-path": "/",
    "target-path": "/backups/eberich/root",
    "ssh-host": "backups.example.com",
    "ssh-identity": "/etc/snapper/certs/id_ecdsa"
}

---

🧚 HOMEPAGE 🧚

http://snapper.io/ — go be nosy, bestie 💖

---

⭐ AUTHORS ⭐

Arvin Schnell <aschnell@suse.com> — the icon, the moment, the main character 👑

---

🦋 SEE ALSO 🦋

• snbk(8)
• snapper(8)

---

and that's the whole page, you ate it up 🎀 this was version 0.13.0, dated 2025-04-09, from the SNAPPER-BACKUP-CON(5) era — go forth and back up your subvolumes, ily 💅✨