system-helpers/usr/share/man/man1/system-helpers.1

.\" Automatically generated by Pandoc 3.0.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "system-helpers" "1" "January 2023" "system-helpers" ""
.hy
.SH NAME
.PP
system-helpers - Collection of helper systemd services, systemd timers
and shell scripts for common tasks.
.SH DESCRIPTION
.PP
\f[B]system-helpers\f[R] collection provides the following helpers
.IP \[bu] 2
checking if systemd services and timers are running (see \f[B]man
systemd_check\f[R])
.IP \[bu] 2
borgmatic backup (see exposed systemd services \f[I]borgmatic\[at]\f[R]
which require a valid \f[I]borgmatic.yml\f[R] file in
\f[I]/etc/borgmatic\f[R] or your \f[B]$HOME/.config/borgmatic\f[R])
.IP \[bu] 2
restic backup (see \f[I]/usr/share/doc/system-helpers/restic\f[R] for an
example \f[I]mybackup\f[R])
.IP \[bu] 2
checking if docker containers are running (see \f[B]man
docker_check\f[R])
.IP \[bu] 2
batch docker-compose upgrades (see \f[B]man docker_compose_update\f[R])
.IP \[bu] 2
dynamic dns update (see \f[B]man docker_compose_update\f[R])
.IP \[bu] 2
memory and disk checks (see \f[B]man disk_space_alert\f[R] and \f[B]man
memory_usage_alert\f[R])
.IP \[bu] 2
docker housekeeping for removing unused docker containers, volumes and
images
.IP \[bu] 2
update check for pacman (ArchLinux specific, see \f[B]man
check_updates\f[R])
.PP
Provided systemd services mostly support notifications if they have
failed via \f[B]systemd_failure_notify\f[R] which uses
\f[B]notifier\f[R] (see \f[B]man notifier\f[R]).
.PP
See \f[I]/usr/share/doc/system-helpers/system-helpers\f[R] for example
configurations which should be copied inside \f[B]$HOME\f[R] or
\f[B]/etc\f[R] depending on the helper script.
.SH AUTHORS
Alexander Schäferdiek.