aboutsummaryrefslogtreecommitdiffstats
path: root/doc/mod
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2021-11-16 16:03:25 +0100
committerGravatar Christian Hesse <mail@eworm.de>2022-02-21 12:44:28 +0100
commit10bb0a9f52a9dbd4a92c72f444ed5b831c91e4df (patch)
tree7d493a3bf84350ca66c5f5496bf8e2eeed8f2b7f /doc/mod
parentcd1de8145b9000f0adec87c1a991007043ef5171 (diff)
add doc/mod/notification-matrix
(cherry picked from commit 07fc5c898ad36debad96d06e3a65fa06ccdadde8)
Diffstat (limited to 'doc/mod')
-rw-r--r--doc/mod/notification-matrix.md45
-rw-r--r--doc/mod/notification-telegram.md5
2 files changed, 50 insertions, 0 deletions
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)