add doc/mod/notification-matrix

14 files changed, 73 insertions, 11 deletions

diff --git a/README.md b/README.md
index 69461a9..78925bb 100644
--- a/README.md
+++ b/README.md
@@ -224,6 +224,7 @@ Available modules
 
 * [Manage ports in bridge](doc/mod/bridge-port-to.md)
 * [Manage VLANs on bridge ports](doc/mod/bridge-port-vlan.md)
+* [Send notifications via Matrix](doc/mod/notification-matrix.md)
 * [Send notifications via Telegram](doc/mod/notification-telegram.md)
 
 Contact
diff --git a/doc/backup-cloud.md b/doc/backup-cloud.md
index c768be1..0761982 100644
--- a/doc/backup-cloud.md
+++ b/doc/backup-cloud.md
@@ -30,7 +30,8 @@ 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, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Usage and invocation
diff --git a/doc/backup-upload.md b/doc/backup-upload.md
index cbda74e..72781ba 100644
--- a/doc/backup-upload.md
+++ b/doc/backup-upload.md
@@ -36,7 +36,8 @@ 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, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 ### Issues with SFTP client
diff --git a/doc/check-certificates.md b/doc/check-certificates.md
index bddcd5a..a553e6a 100644
--- a/doc/check-certificates.md
+++ b/doc/check-certificates.md
@@ -27,7 +27,8 @@ Configuration
 -------------
 
 The expiry notifications just require notification settings for e-mail,
-matrix and/or [telegram](mod/notification-telegram.md).
+[matrix](mod/notification-matrix.md) and/or
+[telegram](mod/notification-telegram.md).
 
 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 81a9f75..f6900ce 100644
--- a/doc/check-health.md
+++ b/doc/check-health.md
@@ -56,7 +56,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
 * `CheckHealthVoltageLow`: value (in volt*10) giving a hard lower limit
 * `CheckHealthVoltagePercent`: percentage value to trigger voltage jumps
 
-Also notification settings are required for e-mail, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 ---
diff --git a/doc/check-lte-firmware-upgrade.md b/doc/check-lte-firmware-upgrade.md
index e5027a8..704a86b 100644
--- a/doc/check-lte-firmware-upgrade.md
+++ b/doc/check-lte-firmware-upgrade.md
@@ -35,7 +35,8 @@ Just install the script:
 Configuration
 -------------
 
-Notification setting are required for e-mail, matrix and/or
+Notification setting are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 See also
diff --git a/doc/check-routeros-update.md b/doc/check-routeros-update.md
index b8f6183..cac1850 100644
--- a/doc/check-routeros-update.md
+++ b/doc/check-routeros-update.md
@@ -47,7 +47,8 @@ safe versions from a web server. The configuration goes to
 * `SafeUpdateUrl`: url to check for safe update, the channel (`long-term`,
 `stable` or `testing`) is appended
 
-Also notification settings are required for e-mail, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Usage and invocation
diff --git a/doc/collect-wireless-mac.md b/doc/collect-wireless-mac.md
index 4e629a5..5425f76 100644
--- a/doc/collect-wireless-mac.md
+++ b/doc/collect-wireless-mac.md
@@ -40,7 +40,8 @@ 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, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Usage and invocation
diff --git a/doc/daily-psk.md b/doc/daily-psk.md
index 0d6ddef..d204691 100644
--- a/doc/daily-psk.md
+++ b/doc/daily-psk.md
@@ -51,7 +51,8 @@ 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, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 ---
diff --git a/doc/log-forward.md b/doc/log-forward.md
index 6ff652f..1ac6a04 100644
--- a/doc/log-forward.md
+++ b/doc/log-forward.md
@@ -46,7 +46,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
 * `LogForwardIncludeMessage`: define message text to be forwarded (even if
   filter matches)
 
-Also notification settings are required for e-mail, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md)m.
 
 ---
diff --git a/doc/mod/notification-matrix.md b/doc/mod/notification-matrix.md
new file mode 100644
index 0000000..e357b5b
--- /dev/null
+++ b/doc/mod/notification-matrix.md
@@ -0,0 +1,45 @@
+Send notifications via Matrix
+=============================
+
+[◀ Go back to main README](../../README.md)
+
+> ℹ️️ **Info**: This module can not be used on its own but requires the base
+> installation. See [main README](../../README.md) for details.
+
+Description
+-----------
+
+This module adds support for sending notifications via
+[Matrix](https://matrix.org/) via client server api. A queue is used to
+make sure notifications are not lost on failure but sent later.
+
+Requirements and installation
+-----------------------------
+
+Just install the module:
+
+    $ScriptInstallUpdate mod/notification-matrix;
+
+Also install a Matrix client on at least one of your mobile and/or desktop
+devices and create an account.
+
+Configuration
+-------------
+
+Edit `global-config-overlay`, add `MatrixHomeServer`, `MatrixAccessToken` and
+`MatrixRoom`. Then reload the configuration.
+
+Usage and invocation
+--------------------
+
+There's nothing special to do. Every script or function sending a notification
+will now send it to your Matrix account.
+
+See also
+--------
+
+* [Send notifications via Telegram](notification-telegram.md)
+
+---
+[◀ Go back to main README](../../README.md)  
+[▲ Go back to top](#top)
diff --git a/doc/mod/notification-telegram.md b/doc/mod/notification-telegram.md
index 511d9a2..435694e 100644
--- a/doc/mod/notification-telegram.md
+++ b/doc/mod/notification-telegram.md
@@ -53,6 +53,11 @@ Usage and invocation
 There's nothing special to do. Every script or function sending a notification
 will now send it to your Telegram account.
 
+See also
+--------
+
+* [Send notifications via Matrix](notification-matrix.md)
+
 ---
 [◀ Go back to main README](../../README.md)  
 [▲ Go back to top](#top)
diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md
index 47fa5f3..b2f6dd0 100644
--- a/doc/netwatch-notify.md
+++ b/doc/netwatch-notify.md
@@ -88,7 +88,8 @@ powered off, but accessibility is of interest.
 
 Go and get your coffee ☕️ before sending the print job.
 
-Also notification settings are required for e-mail, matrix and/or
+Also notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Tips & Tricks
diff --git a/doc/sms-forward.md b/doc/sms-forward.md
index 9028045..9ebae69 100644
--- a/doc/sms-forward.md
+++ b/doc/sms-forward.md
@@ -31,7 +31,8 @@ Just install the script:
 Configuration
 -------------
 
-Notification settings are required for e-mail, matrix and/or
+Notification settings are required for e-mail,
+[matrix](mod/notification-matrix.md) and/or
 [telegram](mod/notification-telegram.md). Also you have to enable receiving
 of SMS: