aboutsummaryrefslogtreecommitdiffstats
path: root/lifeboat.1
diff options
context:
space:
mode:
authorWynn Wolf Arbor2020-02-01 17:56:32 +0100
committerWynn Wolf Arbor2020-02-01 17:56:32 +0100
commitb7149e7449462850de07733be9dae325b17057ef (patch)
tree6428a97beccd262e1bc3447ac57be4c5bc9ebdc4 /lifeboat.1
parentbfe5d41289b57b5a03fbc1c8981f4be9a7b2378e (diff)
downloadlifeboat-b7149e7449462850de07733be9dae325b17057ef.tar.gz
Introduce default fallback jobs
When before lifeboat was expecting the user to populate the run, post, and sync scripts, now it includes a sane default for each step of the backup process, making deployments much more simple. The post script was split up into retain and clean.
Diffstat (limited to '')
-rw-r--r--lifeboat.161
1 files changed, 48 insertions, 13 deletions
diff --git a/lifeboat.1 b/lifeboat.1
index 76837f4..5b4e904 100644
--- a/lifeboat.1
+++ b/lifeboat.1
@@ -42,34 +42,69 @@ In that directory, the program expects the following:
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
+.Xr rclone 1
+destination, then optionally a tab character and a size limit in kibibytes.
.It Sy credentials/restic
A file containing the password for the
.Xr restic 1
repository.
.It Sy run
-A shell script containing backup jobs.
-.It Sy post
-A shell script containing post-backup jobs, optional.
+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
-When
+If any of the optional scripts exist,
.Nm
-is invoked with the
-.Em run
-command, it will change the current directory to the backup directory, and execute the
-.Em run
-script, followed by executing
-.Em post
+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
-.Em sync ,
-if they exist.
+.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 post ,
+.Em retain ,
+.Em clean ,
and
.Em sync
scripts: