'\" t
.\"     Title: snapper-backup-configs
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024-11-05
.\"    Manual: Filesystem Snapshot Management
.\"    Source: 0.12.0
.\"  Language: English
.\"
.TH "SNAPPER\-BACKUP\-CON" "5" "2024\-11\-05" "0\&.12\&.0" "Filesystem Snapshot Management"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
snapper-backup-configs \- Configuration files for snapper backup configs
.SH "DESCRIPTION"
.PP
Each file
/etc/snapper/backup\-configs/*\&.json
describes a snapper backup config\&.
.PP
The file uses JSON syntax containing a single object with key\-value pairs\&.
.SH "KEY VALUE PAIRS"
.PP
The following is a list of keys that can be present in the configuration file\&.
.PP
\fBconfig\fR
.RS 4
Name of the snapper config\&.
.RE
.PP
\fBtarget\-mode\fR
.RS 4
Either local or ssh\-push\&.
.RE
.PP
\fBsource\-path\fR
.RS 4
Path of the subvolume or mount point\&.
.RE
.PP
\fBtarget\-path\fR
.RS 4
Path of the subvolume or mount point\&.
.RE
.PP
\fBautomatic\fR
.RS 4
Boolean for enabling automatic transfer and delete for the backup config using a systemd timer service\&.
.RE
.PP
\fBssh\-host\fR
.RS 4
Name of the target host\&. Required for target mode ssh\-push\&.
.RE
.PP
\fBssh\-port\fR
.RS 4
Port of the target host\&. Optional for target mode ssh\-push\&.
.RE
.PP
\fBssh\-user\fR
.RS 4
User on the target host\&. Optional for target mode ssh\-push\&.
.RE
.PP
\fBssh\-identity\fR
.RS 4
An ssh\-identity to access the host without requiring a password or passphrase\&. Optional for target mode ssh\-push\&.
.RE
.SH "EXAMPLES"
.PP
An example backup config for local backups:
.sp
.if n \{\
.RS 4
.\}
.nf
{
    "config": "root",
    "target\-mode": "local",
    "automatic": true,
    "source\-path": "/",
    "target\-path": "/backups/root"
}
    
.fi
.if n \{\
.RE
.\}
.PP
An example backup config for remote backups via ssh\-push:
.sp
.if n \{\
.RS 4
.\}
.nf
{
    "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"
}
    
.fi
.if n \{\
.RE
.\}
.sp
.SH "HOMEPAGE"
.PP
\m[blue]\fBhttp://snapper\&.io/\fR\m[]
.SH "AUTHORS"
.PP
Arvin Schnell
<aschnell@suse\&.com>
.SH "SEE ALSO"
.PP
\fBsnbk\fR(8),
\fBsnapper\fR(8)