2023-10-11 05:40:55 +00:00
Send notifications via Ntfy
===========================
2024-03-06 13:30:18 +00:00
[](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)
2023-10-11 05:40:55 +00:00
[⬅️ Go back to main README ](../../README.md )
> ℹ ️ ️
> installation. See [main README](../../README.md) for details.
Description
-----------
This module adds support for sending notifications via
[Ntfy ](https://ntfy.sh/ ). 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-ntfy;
Also install the Ntfy app on your mobile device or use the
[web app ](https://ntfy.sh/app ) in a browser of your choice.
Configuration
-------------
Creating an account is not required. Just choose a topic and you are good
to go.
> ⚠️ **Warning**: If you use ntfy without sign-up, the topic is essentially
> a password, so pick something that's not easily guessable.
Edit `global-config-overlay` , add `NtfyServer` (leave it unchanged, unless
you are self-hosting the service) and `NtfyTopic` with your choosen topic.
Then reload the configuration.
> ℹ ️
> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
> your local `global-config-overlay` and modify it to your specific needs.
Usage and invocation
--------------------
There's nothing special to do. Every script or function sending a notification
will now send it to your Ntfy topic.
But of course you can use the function to send notifications directly. Give
it a try:
2023-11-08 16:30:35 +00:00
$SendNtfy "Subject..." "Body...";
2023-10-11 05:40:55 +00:00
Alternatively this sends a notification with all available and configured
methods:
2023-11-08 16:30:35 +00:00
$SendNotification "Subject..." "Body...";
2023-10-11 05:40:55 +00:00
To use the functions in your own scripts you have to declare them first.
Place this before you call them:
:global SendNtfy;
:global SendNotification;
In case there is a situation when the queue needs to be purged there is a
function available:
$PurgeNtfyQueue;
See also
--------
* [Send notifications via e-mail ](notification-email.md )
* [Send notifications via Matrix ](notification-matrix.md )
* [Send notifications via Telegram ](notification-telegram.md )
---
[⬅️ Go back to main README ](../../README.md )
[⬆️ Go back to top ](#top )
