1. Manuals
  2. Tumbleweed
  3. snapper-backup
  4. snapper-backup-configs(5)

Scroll to navigation

SNAPPER-BACKUP-CON(5) Filesystem Snapshot Management SNAPPER-BACKUP-CON(5)

NAME

snapper-backup-configs - Configuration files for snapper backup configs

DESCRIPTION

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.

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.

send-compressed-data

Per default snbk will add the option --compressed-data iff supported by the source and target system. This can be disable by setting this value to false.

send-options

Extra options for the btrfs send command as an array of strings. Optional.

Per default snbk automatically adds --proto and --compressed-data iff supported by both the source and target.

receive-options

Extra options for the btrfs receive command as an array of strings. Optional.

target-btrfs-bin

Location of the btrfs binary on the target. Can also be used to install wrapper scripts. Optional.

target-ls-bin

Location of the ls 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-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

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

HOMEPAGE

http://snapper.io/

AUTHORS

Arvin Schnell <aschnell@suse.com>

SEE ALSO

snbk(8), snapper(8)

2025-10-13 0.13.0