snapper-backup-configs - Man Page

Each file /etc/snapper/backup-configs/*.json describes a snapper backup config.

The file uses JSON syntax containing a single object with key-value pairs.

The following is a list of keys that can be present in the configuration file.

config

Name of the snapper config.

target-mode

Either local or ssh-push.

source-path

Path of the source subvolume. This must match the subvolume of the corresponding snapper config.

target-path

Path of the target subvolume or mount point.

automatic

Boolean for enabling automatic transfer and delete for the backup config using a systemd timer service.

ssh-host

Name of the target host. Required for target mode ssh-push.

ssh-port

Port of the target host. Optional for target mode ssh-push.

ssh-user

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.

An example backup config for local backups:

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

An example backup config for remote backups via ssh-push:

{
    "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"
}

http://snapper.io/

Arvin Schnell <aschnell@suse.com>

snbk(8), snapper(8)

snbk(8).