diff --git a/.gitbook/assets/ntfy-logo.png b/.gitbook/assets/ntfy-logo.png new file mode 100644 index 0000000..ad57c98 Binary files /dev/null and b/.gitbook/assets/ntfy-logo.png differ diff --git a/.gitbook/assets/ntfy_alert.jpg b/.gitbook/assets/ntfy_alert.jpg new file mode 100644 index 0000000..4c6a052 Binary files /dev/null and b/.gitbook/assets/ntfy_alert.jpg differ diff --git a/.gitbook/assets/ntfy_subscribe.png b/.gitbook/assets/ntfy_subscribe.png new file mode 100644 index 0000000..f676292 Binary files /dev/null and b/.gitbook/assets/ntfy_subscribe.png differ diff --git a/alerts/ntfy.md b/alerts/ntfy.md new file mode 100644 index 0000000..387f97b --- /dev/null +++ b/alerts/ntfy.md @@ -0,0 +1,29 @@ +# ntfy + +![](../.gitbook/assets/ntfy-logo.png) + +[ntfy] (pronounced notify) is a simple HTTP-based pub-sub notification service. It allows you to send notifications to your phone or desktop via scripts from any computer, and/or using a REST API. + +## Configuring ntfy Alerts + +1. **Subscribe to a topic**: for example, on desktop: + + ![ntfy Topic Subscription](../.gitbook/assets/ntfy_subscribe.png) + +2. **Turn on ntfy alerts** in the [LinuxGSM settings](../configuration/linuxgsm-config.md). \(`~/lgsm/config-lgsm//common.cfg`\) + +_Note: The only required setting is to turn on `ntfyalert`, and set `ntfytopic` a unique topic if you are not selfhosting ntfy._ + +```text +# ntfy Alerts | https://docs.linuxgsm.com/alerts/ntfy +ntfyalert="on" +ntfytopic="your-topic-name" # Defaults to "LinuxGSM", you should use something unique. +ntfyserver="selfhosted-ntfy-url" # Defaults to "https://ntfy.sh", set if self-hosting ntfy. +ntfypriority="" +ntfytags="" + +# If publishing to topics behind auth: https://docs.ntfy.sh/publish/#authentication +ntfytoken="" +ntfyusername="" +ntfypassword="" +```