introduce mod/notification-ntfy...change-109

... for sending notifications via Ntfy (https://ntfy.sh/).

TODO: use proper formatting once supported in Android app:
https://github.com/binwiederhier/ntfy/issues/889

14 files changed, 102 insertions, 10 deletions

diff --git a/doc/backup-cloud.md b/doc/backup-cloud.md
index b612fc4..f084d5b 100644
--- a/doc/backup-cloud.md
+++ b/doc/backup-cloud.md
@@ -42,7 +42,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Usage and invocation
diff --git a/doc/backup-upload.md b/doc/backup-upload.md
index f9aaa29..b132e56 100644
--- a/doc/backup-upload.md
+++ b/doc/backup-upload.md
@@ -48,7 +48,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.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 58151f3..95ff534 100644
--- a/doc/check-certificates.md
+++ b/doc/check-certificates.md
@@ -44,7 +44,8 @@ subject alternative name (aka *Subject Alt Name* or *SAN*) can be used.
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Usage and invocation
diff --git a/doc/check-health.md b/doc/check-health.md
index 3f4c70f..34b5faf 100644
--- a/doc/check-health.md
+++ b/doc/check-health.md
@@ -80,7 +80,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 ---
diff --git a/doc/check-routeros-update.md b/doc/check-routeros-update.md
index 3b5c2bd..dbe83b8 100644
--- a/doc/check-routeros-update.md
+++ b/doc/check-routeros-update.md
@@ -66,7 +66,8 @@ The configuration goes to `global-config-overlay`, these are the parameters:
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.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 9ba1e3a..2b17055 100644
--- a/doc/collect-wireless-mac.md
+++ b/doc/collect-wireless-mac.md
@@ -47,7 +47,8 @@ entries are to be added.
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Usage and invocation
diff --git a/doc/daily-psk.md b/doc/daily-psk.md
index 60a645f..f551e46 100644
--- a/doc/daily-psk.md
+++ b/doc/daily-psk.md
@@ -72,7 +72,8 @@ For legacy local interface:
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[trix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 ---
diff --git a/doc/log-forward.md b/doc/log-forward.md
index 43ae897..4212381 100644
--- a/doc/log-forward.md
+++ b/doc/log-forward.md
@@ -67,7 +67,8 @@ To forward **all** (ignoring severity) log messages with topics `account`
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Tips & Tricks
diff --git a/doc/mod/notification-email.md b/doc/mod/notification-email.md
index 8dc2ecf..6b1142d 100644
--- a/doc/mod/notification-email.md
+++ b/doc/mod/notification-email.md
@@ -73,6 +73,7 @@ See also
 --------
 
 * [Send notifications via Matrix](notification-matrix.md)
+* [Send notifications via Ntfy](notification-ntfy.md)
 * [Send notifications via Telegram](notification-telegram.md)
 
 ---
diff --git a/doc/mod/notification-matrix.md b/doc/mod/notification-matrix.md
index ab8efc9..e9e3174 100644
--- a/doc/mod/notification-matrix.md
+++ b/doc/mod/notification-matrix.md
@@ -119,6 +119,7 @@ See also
 --------
 
 * [Send notifications via e-mail](notification-email.md)
+* [Send notifications via Ntfy](notification-ntfy.md)
 * [Send notifications via Telegram](notification-telegram.md)
 
 ---
diff --git a/doc/mod/notification-ntfy.md b/doc/mod/notification-ntfy.md
new file mode 100644
index 0000000..64e49f0
--- /dev/null
+++ b/doc/mod/notification-ntfy.md
@@ -0,0 +1,79 @@
+Send notifications via Ntfy
+===========================
+
+[⬅️ 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
+[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.
+
+> ℹ️ **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.
+
+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:
+
+    $SendNtfy "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 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)
diff --git a/doc/mod/notification-telegram.md b/doc/mod/notification-telegram.md
index 89659c8..387d511 100644
--- a/doc/mod/notification-telegram.md
+++ b/doc/mod/notification-telegram.md
@@ -98,6 +98,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 Matrix](notification-matrix.md)
+* [Send notifications via Ntfy](notification-ntfy.md)
 
 ---
 [⬅️ Go back to main README](../../README.md)  
diff --git a/doc/netwatch-notify.md b/doc/netwatch-notify.md
index 6df233b..b673af8 100644
--- a/doc/netwatch-notify.md
+++ b/doc/netwatch-notify.md
@@ -40,7 +40,8 @@ The hosts to be checked have to be added to netwatch with specific comment:
 
 Also notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 ### Hooks
diff --git a/doc/sms-forward.md b/doc/sms-forward.md
index 5967903..823805e 100644
--- a/doc/sms-forward.md
+++ b/doc/sms-forward.md
@@ -49,7 +49,8 @@ The configuration goes to `global-config-overlay`, this is the only parameter:
 
 Notification settings are required for
 [e-mail](mod/notification-email.md),
-[matrix](mod/notification-matrix.md) and/or
+[matrix](mod/notification-matrix.md),
+[ntfy](mod/notification-ntfy.md) and/or
 [telegram](mod/notification-telegram.md).
 
 Tips & Tricks