From 9c9dfee6619ba172a0bc9c8a078778ca02e98227 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Sch=C3=A4ferdiek?= Date: Tue, 21 Mar 2023 19:08:47 +0100 Subject: [PATCH] Improve documentation about notifier per-command with examples --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7444c2..e43085a 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,12 @@ Server = https://aur.myservermanager.com ## Usage +Services and scripts don't depend on each other, except for `notifier` which is commonly used. See more about `notifier` in the next section. All scripts include hints that they can be combined (out-commented line in service files for `systemd_failure_notify@.service` for example). + +Examples are given inside `usr/share/doc/system-helpers` and *man pages* are also available. + +### Making use of notifier + Scripts make heavy use the bundled **notifier** script (see `man notifier`) which should be configured properly, e.g. add a `/etc/notifier.conf`: ```shell @@ -75,10 +81,16 @@ Environment="NOTIFIER_MAIL_ADDRESS=another-mail-different-from-your-global-confi # ... ``` +Another option is to set those inside the respective config files of another script. Let's have an example with the `check_updates` script. -Otherwise, services and scripts don't depend on each other, but have hints that they can be combined (out-commented line in service files for `systemd_failure_notify@.service` for example). +```shell +# /etc/check_updates.conf +NOTIFIER_GOTIFY_ENABLED=false +NOTIFIER_MAIL_ENABLED=true +NOTIFIER_MAIL_ADDRESS=updatemail@domain.tld +``` -Examples are given inside `usr/share/doc/system-helpers` and *man pages* are also available. +This will not send gotify messages for `check_updates` and send a mail to a different address `updatemail@domain.tld`. ## FAQ