.Dd April 30, 2021
.Dt LIFEBOAT 1
.Os
.Sh NAME
.Nm lifeboat
.Nd manage and automate local restic backups
.Sh SYNOPSIS
.Nm
.Ar name
.Ar command
.Sh DESCRIPTION
.Nm
is a program that manages a set of local
.Xr restic 1
repositories and provides a framework
for automating the creation and synchronization of backups.
.Pp
The name refers to any valid backup under
.Ev LIFEBOAT_ROOT .
.Pp
The command is any command recognized by
.Xr restic 1 ,
or as follows:
.Bl -tag -width Ds
.It Sy run
Create a snapshot for the specified repository.
.It Sy run-report
Like
.Sy run ,
but send any program output to the mail address specified in
.Pa config/recipient .
.El
.Sh DIRECTORY STRUCTURE
.Nm
keeps all its backups under one directory, specified by the
.Ev LIFEBOAT_ROOT
environment variable.
If unset,
.Nm
will fall back to
.Pa /srv/backup/lifeboat .
.Pp
Each backup managed by
.Nm
owns a directory under
.Ev LIFEBOAT_ROOT .
In that directory, the program expects the following:
.Bl -tag -width Ds
.It Sy repo/
A directory containing the actual
.Xr restic 1
repository.
.It Sy config/include
A file containing paths to include in the backup, one per line.
See the
.Em --files-from
option in
.Xr restic-backup 1 .
.It Sy config/exclude
A file containing paths that are excluded from the backup, one per line.
See the
.Em --exclude-file
option in
.Xr restic-backup 1 .
.It Sy config/sync
A file containing synchronization targets for
.Xr rclone 1 ,
one per line.
The format for a synchronization target is the base
.Xr rclone 1
destination, then optionally a tab character and a size limit in kibibytes.
.Pp
.Nm
will append the name of the backup
.Ev ( LIFEBOAT_REPO_NAME )
to the base destination.
.Pp
For example, the following configuration will synchronize a backup named
.Dq server
to
.Pa nas:backups/server
if the combined size of the repository is below 10G:
.Bd -literal -offset indent
nas:backups/ 10485760
.Ed
.It Sy config/recipient
A file containing the mail address of the recipient for backup reports.
Only needed for the
.Sy run-report
command.
.It Sy credentials/restic
A file containing the password for the
.Xr restic 1
repository.
.It Sy run
A shell script containing backup jobs, optional
.It Sy retain
A shell script pruning old backups or enforcing retainment policies, optional.
.It Sy clean
A shell script containing cleanup jobs, optional.
.It Sy sync
A shell script containing synchronization jobs, optional.
.El
.Pp
If any of the optional scripts exist,
.Nm
will execute those instead of its inbuilt defaults.
.Pp
By default,
.Nm
will honor the given include and exclude directives, retain 7 daily,
5 weekly, 12 monthly, and 2 yearly backups,
verify and clean up the repository using
.Xr restic-check 1
and
.Xr restic-prune 1 ,
and sync the repo to the given synchronization targets.
.Pp
Note that by default,
.Nm
will look for a binary named
.Em restic-priv
with which to run the backup job itself.
As per upstream recommendation this is the restic binary with the
.Em cap_dac_read_search
capability set.
This allows restic to access any file on the system without
needing root permissions.
.Sh ENVIRONMENT
.Nm
will export the following environment variables for use in the
.Em run ,
.Em retain ,
.Em clean ,
and
.Em sync
scripts:
.Bl -tag -width Ds
.It Sy LIFEBOAT_REPO_NAME
The name of the backup as specified on the command line.
.It Sy RESTIC_REPOSITORY
The path to the
.Xr restic 1
repository.
.It Sy RESTIC_PASSWORD_FILE
The path to the
.Xr restic 1
password file.
.El
.Sh SEE ALSO
.Xr restic 1
.Sh AUTHORS
.An -nosplit
.Nm
was written by
.An Wolfgang Müller Aq Mt wolf@oriole.systems
