mirror of
https://github.com/eworm-de/routeros-scripts.git
synced 2026-01-13 12:39:32 +00:00
introduce mod/notification-gotify for sending notifications via Gotify (https://gotify.net).
This commit is contained in:
parent
469f783a92
commit
60fdf89637
9 changed files with 244 additions and 0 deletions
|
|
@ -79,6 +79,7 @@ function available:
|
|||
See also
|
||||
--------
|
||||
|
||||
* [Send notifications via Gotify](notification-gotify.md)
|
||||
* [Send notifications via Matrix](notification-matrix.md)
|
||||
* [Send notifications via Ntfy](notification-ntfy.md)
|
||||
* [Send notifications via Telegram](notification-telegram.md)
|
||||
|
|
|
|||
BIN
doc/mod/notification-gotify.d/appsetup.avif
Normal file
BIN
doc/mod/notification-gotify.d/appsetup.avif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
90
doc/mod/notification-gotify.md
Normal file
90
doc/mod/notification-gotify.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
Send notifications via Gotify
|
||||
===========================
|
||||
|
||||
[](https://github.com/eworm-de/routeros-scripts/stargazers)
|
||||
[](https://github.com/eworm-de/routeros-scripts/network)
|
||||
[](https://github.com/eworm-de/routeros-scripts/watchers)
|
||||
[](https://mikrotik.com/download/changelogs/)
|
||||
[](https://t.me/routeros_scripts)
|
||||
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)
|
||||
|
||||
[⬅️ 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
|
||||
[Gotify](https://gotify.net/). 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-gotify;
|
||||
|
||||
Also deploy the [Gotify server](https://github.com/gotify/server) and optionally install a Gotify client on your mobile device.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Follow the [installation instructions](https://gotify.net/docs/install) and the [First Login setup](https://gotify.net/docs/first-login). Once you have a user and account you can start creating apps. Each app is an independent notification feed for a device or application.
|
||||
|
||||

|
||||
|
||||
On creation apps are assigned a Token for authentification and you can also assign a default priority for each app.
|
||||
|
||||
Edit `global-config-overlay`, add `GotifyServer` with your server address and `GotifyToken` with the token from your configured app on the Gotify server.
|
||||
Then reload the configuration.
|
||||
|
||||
> ℹ️ **Info**: Copy relevant configuration from
|
||||
> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
|
||||
> your local `global-config-overlay` and modify it to your specific needs.
|
||||
|
||||
For a custom service installing an additional certificate may be required.
|
||||
You may want to install that certificate manually, after finding the
|
||||
[certificate name from browser](../../CERTIFICATES.md).
|
||||
|
||||
Usage and invocation
|
||||
--------------------
|
||||
|
||||
There's nothing special to do. Every script or function sending a notification
|
||||
will now send it to your Gotify application feed.
|
||||
|
||||
But of course you can use the function to send notifications directly. Give
|
||||
it a try:
|
||||
|
||||
$SendGotify "Subject..." "Body...";
|
||||
|
||||
Alternatively this sends a notification with all available and configured
|
||||
methods:
|
||||
|
||||
$SendNotification "Subject..." "Body...";
|
||||
|
||||
To use the functions in your own scripts you have to declare them first.
|
||||
Place this before you call them:
|
||||
|
||||
:global SendGotify;
|
||||
:global SendNotification;
|
||||
|
||||
In case there is a situation when the queue needs to be purged there is a
|
||||
function available:
|
||||
|
||||
$PurgeGotifyQueue;
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
* [Certificate name from browser](../../CERTIFICATES.md)
|
||||
* [Send notifications via e-mail](notification-email.md)
|
||||
* [Send notifications via Matrix](notification-matrix.md)
|
||||
* [Send notifications via Ntfy](notification-ntfy.md)
|
||||
* [Send notifications via Telegram](notification-telegram.md)
|
||||
|
||||
---
|
||||
[⬅️ Go back to main README](../../README.md)
|
||||
[⬆️ Go back to top](#top)
|
||||
|
|
@ -131,6 +131,7 @@ See also
|
|||
|
||||
* [Certificate name from browser](../../CERTIFICATES.md)
|
||||
* [Send notifications via e-mail](notification-email.md)
|
||||
* [Send notifications via Gotify](notification-gotify.md)
|
||||
* [Send notifications via Ntfy](notification-ntfy.md)
|
||||
* [Send notifications via Telegram](notification-telegram.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -90,6 +90,7 @@ See also
|
|||
|
||||
* [Certificate name from browser](../../CERTIFICATES.md)
|
||||
* [Send notifications via e-mail](notification-email.md)
|
||||
* [Send notifications via Gotify](notification-gotify.md)
|
||||
* [Send notifications via Matrix](notification-matrix.md)
|
||||
* [Send notifications via Telegram](notification-telegram.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -115,6 +115,7 @@ See also
|
|||
|
||||
* [Chat with your router and send commands via Telegram bot](../telegram-chat.md)
|
||||
* [Send notifications via e-mail](notification-email.md)
|
||||
* [Send notifications via Gotify](notification-gotify.md)
|
||||
* [Send notifications via Matrix](notification-matrix.md)
|
||||
* [Send notifications via Ntfy](notification-ntfy.md)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue