From 8375673d93d5481cc575dcb61825eba9b08c1515 Mon Sep 17 00:00:00 2001 From: Michael Gisbers Date: Fri, 28 May 2021 17:30:37 +0200 Subject: global-functions: implement notifications via Matrix Matrix is an open network for secure, decentralized communication - and it has a web api. A warning on message type: Using 'm.notice' breaks rendering on Element for Android (no fixed width font) and does not pop up desktop notification. Thus we use 'm.text'. Should be safe as we do not send the messages in response to other messages. https://matrix.org/ --- doc/check-certificates.md | 4 ++-- doc/check-health.md | 2 +- doc/check-lte-firmware-upgrade.md | 2 +- doc/cloud-backup.md | 2 +- doc/collect-wireless-mac.md | 2 +- doc/daily-psk.md | 2 +- doc/log-forward.md | 2 +- doc/netwatch-notify.md | 2 +- doc/sms-forward.md | 4 ++-- doc/upload-backup.md | 2 +- 10 files changed, 12 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/check-certificates.md b/doc/check-certificates.md index 5b1e3b2..aa4a258 100644 --- a/doc/check-certificates.md +++ b/doc/check-certificates.md @@ -22,8 +22,8 @@ Just install the script: Configuration ------------- -The expiry notifications just require notification settings for e-mail and -telegram. +The expiry notifications just require notification settings for e-mail, +matrix and/or telegram. For automatic download and renewal of certificates you need configuration in `global-config-overlay`, these are the parameters: diff --git a/doc/check-health.md b/doc/check-health.md index f1b9d91..de7f9eb 100644 --- a/doc/check-health.md +++ b/doc/check-health.md @@ -39,7 +39,7 @@ The configuration goes to `global-config-overlay`, These are the parameters: * `CheckHealthTemperature`: an array specifying temperature thresholds for sensors * `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. --- [◀ Go back to main README](../README.md) diff --git a/doc/check-lte-firmware-upgrade.md b/doc/check-lte-firmware-upgrade.md index a145da8..dea6b82 100644 --- a/doc/check-lte-firmware-upgrade.md +++ b/doc/check-lte-firmware-upgrade.md @@ -31,7 +31,7 @@ Just install the script: Configuration ------------- -Notification setting are required for e-mail and telegram. +Notification setting are required for e-mail, matrix and/or telegram. See also -------- diff --git a/doc/cloud-backup.md b/doc/cloud-backup.md index 60e71c9..21d287f 100644 --- a/doc/cloud-backup.md +++ b/doc/cloud-backup.md @@ -26,7 +26,7 @@ The configuration goes to `global-config-overlay`, these are the parameters: * `BackupPassword`: password to encrypt the backup with * `BackupRandomDelay`: delay up to amount of seconds when run from scheduler -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. Usage and invocation -------------------- diff --git a/doc/collect-wireless-mac.md b/doc/collect-wireless-mac.md index 4da06b9..8f3ff6f 100644 --- a/doc/collect-wireless-mac.md +++ b/doc/collect-wireless-mac.md @@ -36,7 +36,7 @@ On first run a disabled access list entry acting as marker (with comment "`--- collected above ---`") is added. Move this entry to define where new entries are to be added. -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. Usage and invocation -------------------- diff --git a/doc/daily-psk.md b/doc/daily-psk.md index ec55c85..28f9afc 100644 --- a/doc/daily-psk.md +++ b/doc/daily-psk.md @@ -47,7 +47,7 @@ Then add an access list entry: / interface wireless access-list add comment="Daily PSK" interface=wl-daily private-pre-shared-key="ToBeChangedDaily"; -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. --- [◀ Go back to main README](../README.md) diff --git a/doc/log-forward.md b/doc/log-forward.md index 0993b52..68a6ca1 100644 --- a/doc/log-forward.md +++ b/doc/log-forward.md @@ -39,7 +39,7 @@ The configuration goes to `global-config-overlay`, these are the parameters: * `LogForwardFilter`: define topics *not* to be forwarded * `LogForwardFilterMessage`: define message text *not* to be forwarded -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. --- [◀ Go back to main README](../README.md) diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md index ff1eae9..2bba8d9 100644 --- a/doc/netwatch-notify.md +++ b/doc/netwatch-notify.md @@ -61,7 +61,7 @@ But be warned: Dynamic updates will probably cause issues if the name has more than one record in dns - a high rate of configuration changes (and flash writes) at least. -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. Tips & Tricks ------------- diff --git a/doc/sms-forward.md b/doc/sms-forward.md index d603daa..69ea5d0 100644 --- a/doc/sms-forward.md +++ b/doc/sms-forward.md @@ -27,8 +27,8 @@ Just install the script: Configuration ------------- -Notification settings are required for e-mail and telegram. Also you have -to enable receiving of SMS: +Notification settings are required for e-mail, matrix and/or telegram. Also +you have to enable receiving of SMS: / tool sms set receive-enabled=yes; diff --git a/doc/upload-backup.md b/doc/upload-backup.md index 4b656e4..f9a9b4f 100644 --- a/doc/upload-backup.md +++ b/doc/upload-backup.md @@ -32,7 +32,7 @@ The configuration goes to `global-config-overlay`, these are the parameters: * `BackupUploadUser`: username for server authentication * `BackupUploadPass`: password for server authentication -Also notification settings are required for e-mail and telegram. +Also notification settings are required for e-mail, matrix and/or telegram. ### Issues with SFTP client -- cgit v1.2.3-54-g00ecf