From e211764590f8bfa52038b78faf18df78ddbc0e74 Mon Sep 17 00:00:00 2001 From: admin Date: Mon, 18 May 2026 15:10:49 +0000 Subject: [PATCH] config: add example configuration file --- config/config.yml.example | 49 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 config/config.yml.example diff --git a/config/config.yml.example b/config/config.yml.example new file mode 100644 index 0000000..7cca08c --- /dev/null +++ b/config/config.yml.example @@ -0,0 +1,49 @@ +# ns8-backup-monitor configuration + +# SMTP settings for notification emails +smtp: + host: localhost + port: 25 + use_tls: false + use_starttls: false + username: "" + password: "" + +# Notification recipients +mail: + from: "ns8-backup-monitor@yourdomain.com" + to: + - "admin@yourdomain.com" + subject_prefix: "[NS8 Backup]" + +# Webhook receiver settings +receiver: + host: "127.0.0.1" + port: 9099 + +# Timing: how many seconds to wait after alert before checking +# (allows all modules to finish writing their status) +correlator: + wait_seconds: 30 + # Time window (seconds) to consider a backup "recent" after alert + recent_window: 3600 + +# Redis connection (NS8 cluster state) +redis: + socket: "/var/lib/nethserver/cluster/state/redis.sock" + # Alternatively use host/port if not using unix socket + # host: "127.0.0.1" + # port: 6379 + +# Repository check: commands to run to verify backup destination +# These are run as root and should return exit code 0 on success +repo_check: + # Maximum seconds to wait for repo check + timeout: 60 + # Additional restic flags if needed + restic_flags: "" + +# Logging +logging: + level: INFO + file: "/var/log/ns8-backup-monitor.log"