From 5932586ee4c573903dbd40b4f422ffb2819b9ba2 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Wed, 11 Oct 2023 07:40:55 +0200
Subject: introduce mod/notification-ntfy...

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

TODO: use proper formatting once supported in Android app:
https://github.com/binwiederhier/ntfy/issues/889
---
 doc/mod/notification-email.md    |  1 +
 doc/mod/notification-matrix.md   |  1 +
 doc/mod/notification-ntfy.md     | 79 ++++++++++++++++++++++++++++++++++++++++
 doc/mod/notification-telegram.md |  1 +
 4 files changed, 82 insertions(+)
 create mode 100644 doc/mod/notification-ntfy.md

(limited to 'doc/mod')

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)  
-- 
cgit v1.2.3-54-g00ecf