mirror of
https://github.com/eworm-de/routeros-scripts
synced 2024-05-14 10:04:19 +02:00
add doc/mod/notification-matrix
This commit is contained in:
Christian Hesse
parent
e6a686187c
commit
07fc5c898a
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
---
|
||||
|
|
|
|||
45
doc/mod/notification-matrix.md
Normal file
45
doc/mod/notification-matrix.md
Normal file
|
|
@ -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)
|
||||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue