From 2670317baee5ee8a715b68665b919e00a598b0af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Sch=C3=A4ferdiek?= Date: Wed, 25 Jan 2023 23:31:14 +0100 Subject: [PATCH] Align examples --- README.md | 2 +- _man/src/system-helpers.1.md | 2 +- .../disk_space_alert/.disk_space_alert.conf.example | 4 ++-- .../docker_check/.docker_check.conf.example | 8 ++++---- ...cker_check.list.example => .docker_check.list.example} | 0 .../docker_compose_update/.docker_compose_update.conf | 1 + .../memory_usage_alert/.memory_usage_alert.conf.example | 2 +- usr/share/doc/system-helpers/notifier/.notifier.conf | 4 ++++ .../smartctl_tests_long/.smartctl_tests_long.conf.example | 2 +- usr/share/man/man1/system-helpers.1 | 2 +- 10 files changed, 16 insertions(+), 11 deletions(-) rename usr/share/doc/system-helpers/docker_check/{docker_check.list.example => .docker_check.list.example} (100%) create mode 100644 usr/share/doc/system-helpers/notifier/.notifier.conf diff --git a/README.md b/README.md index b7c1247..777c99c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # README system-helpers - Collection of helper systemd services, systemd timers and -shell scripts for common configuration. +shell scripts for common tasks. It can help you out for small servers where you think a proper monitoring and alerting system like [Prometheus](https://prometheus.io) and diff --git a/_man/src/system-helpers.1.md b/_man/src/system-helpers.1.md index eba39d1..3b09032 100644 --- a/_man/src/system-helpers.1.md +++ b/_man/src/system-helpers.1.md @@ -4,7 +4,7 @@ # NAME system-helpers - Collection of helper systemd services, systemd timers and -shell scripts for common configuration. +shell scripts for common tasks. # DESCRIPTION **system-helpers** collection provides the following helpers diff --git a/usr/share/doc/system-helpers/disk_space_alert/.disk_space_alert.conf.example b/usr/share/doc/system-helpers/disk_space_alert/.disk_space_alert.conf.example index 204f80a..7a575cd 100644 --- a/usr/share/doc/system-helpers/disk_space_alert/.disk_space_alert.conf.example +++ b/usr/share/doc/system-helpers/disk_space_alert/.disk_space_alert.conf.example @@ -1,4 +1,4 @@ #!/usr/bin/env bash DISK_SPACE_ALERT_MAIL_ADDRESS="alias@domain.tld" -#DISK_SPACE_ALERT_THRESHOLD=99 -#DISK_SPACE_ALERT_MOUNTPOINTS=("/", "/home") \ No newline at end of file +DISK_SPACE_ALERT_THRESHOLD=99 +DISK_SPACE_ALERT_MOUNTPOINTS=("/", "/home") \ No newline at end of file diff --git a/usr/share/doc/system-helpers/docker_check/.docker_check.conf.example b/usr/share/doc/system-helpers/docker_check/.docker_check.conf.example index 1fc9d7a..87de465 100644 --- a/usr/share/doc/system-helpers/docker_check/.docker_check.conf.example +++ b/usr/share/doc/system-helpers/docker_check/.docker_check.conf.example @@ -1,5 +1,5 @@ #!/usr/bin/env bash -#DOCKER_CHECK_LIST_FILE="/root/other/directory/prefix_docker_check.list" -#DOCKER_CHECK_NOTIFY_LEVELS=("UNKNOWN" "WARNING" "CRITICAL") -#DOCKER_CHECK_MAIL_ENABLED=true -#DOCKER_CHECK_MAIL_ADDRESS="alias@domain.tld" \ No newline at end of file +DOCKER_CHECK_LIST_FILE="/root/other/directory/prefix_docker_check.list" +DOCKER_CHECK_NOTIFY_LEVELS=("UNKNOWN" "WARNING" "CRITICAL") +DOCKER_CHECK_MAIL_ENABLED=true +DOCKER_CHECK_MAIL_ADDRESS="alias@domain.tld" \ No newline at end of file diff --git a/usr/share/doc/system-helpers/docker_check/docker_check.list.example b/usr/share/doc/system-helpers/docker_check/.docker_check.list.example similarity index 100% rename from usr/share/doc/system-helpers/docker_check/docker_check.list.example rename to usr/share/doc/system-helpers/docker_check/.docker_check.list.example diff --git a/usr/share/doc/system-helpers/docker_compose_update/.docker_compose_update.conf b/usr/share/doc/system-helpers/docker_compose_update/.docker_compose_update.conf index f44e8c9..97169a8 100644 --- a/usr/share/doc/system-helpers/docker_compose_update/.docker_compose_update.conf +++ b/usr/share/doc/system-helpers/docker_compose_update/.docker_compose_update.conf @@ -1 +1,2 @@ +#!/usr/bin/env bash DOCKER_COMPOSE_UPDATE_BASEDIR="/root/deployments" diff --git a/usr/share/doc/system-helpers/memory_usage_alert/.memory_usage_alert.conf.example b/usr/share/doc/system-helpers/memory_usage_alert/.memory_usage_alert.conf.example index ffe9f8b..51de8ca 100644 --- a/usr/share/doc/system-helpers/memory_usage_alert/.memory_usage_alert.conf.example +++ b/usr/share/doc/system-helpers/memory_usage_alert/.memory_usage_alert.conf.example @@ -1,3 +1,3 @@ #!/usr/bin/env bash MEMORY_USAGE_ALERT_MAIL_ADDRESS="alias@domain.tld" -#MEMORY_USAGE_ALERT_THRESHOLD=512 \ No newline at end of file +MEMORY_USAGE_ALERT_THRESHOLD=512 \ No newline at end of file diff --git a/usr/share/doc/system-helpers/notifier/.notifier.conf b/usr/share/doc/system-helpers/notifier/.notifier.conf new file mode 100644 index 0000000..8936595 --- /dev/null +++ b/usr/share/doc/system-helpers/notifier/.notifier.conf @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +NOTIFIER_MAIL_ADDRESS=test@domain.tld +NOTIFIER_MAIL_ENABLED=true +NOTIFIER_GOTIFY_ENABLED=true \ No newline at end of file diff --git a/usr/share/doc/system-helpers/smartctl_tests_long/.smartctl_tests_long.conf.example b/usr/share/doc/system-helpers/smartctl_tests_long/.smartctl_tests_long.conf.example index 0a05f97..b956001 100644 --- a/usr/share/doc/system-helpers/smartctl_tests_long/.smartctl_tests_long.conf.example +++ b/usr/share/doc/system-helpers/smartctl_tests_long/.smartctl_tests_long.conf.example @@ -1,3 +1,3 @@ #!/usr/bin/env bash SMARTCTL_TESTS_LONG_MAIL_ADDRESS="alias@domain.tld" -#SMARTCTL_TESTS_LONG_DEVICES=(sda sdb) \ No newline at end of file +SMARTCTL_TESTS_LONG_DEVICES=(sda sdb) \ No newline at end of file diff --git a/usr/share/man/man1/system-helpers.1 b/usr/share/man/man1/system-helpers.1 index b7fa3f7..0ae9eae 100644 --- a/usr/share/man/man1/system-helpers.1 +++ b/usr/share/man/man1/system-helpers.1 @@ -19,7 +19,7 @@ .SH NAME .PP system-helpers - Collection of helper systemd services, systemd timers -and shell scripts for common configuration. +and shell scripts for common tasks. .SH DESCRIPTION .PP \f[B]system-helpers\f[R] collection provides the following helpers