From 87b74e6c3e01f488b2ade1e1998f4e737c73b842 Mon Sep 17 00:00:00 2001 From: Felix Stupp Date: Wed, 22 Mar 2023 09:14:36 +0000 Subject: [PATCH] ntfy doc: Describe web app & how to enable it See #2529 --- docs/configuring-playbook-ntfy.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index 27d2fb12..1311afc9 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -21,6 +21,9 @@ ntfy_enabled: true # Uncomment the line below and change it, if you'd like. # matrix_server_fqn_ntfy: "ntfy.{{ matrix_domain }}" +# Uncomment to enable the ntfy web app (disabled by default) +# ntfy_web_root: app # defaults to "disable" + # Uncomment and change to inject additional configuration options. # ntfy_configuration_extension_yaml: | # log_level: DEBUG @@ -81,6 +84,12 @@ If the matrix app asks, "Choose a distributor: FCM Fallback or ntfy", then choos If the matrix app doesn't seem to pick it up, try restarting it and try the Troubleshooting section below. +### Web App + +ntfy has also an web app to subscribe and push to topics from the browser. This may be helpful to further troubleshoot UnifiedPush problems or to use ntfy for other purposes. The web app only runs in the browser locally (after downloading the JavaScript). + +The web app is disabled in this playbook by default as the expectation is that most users won't use it. You can either use the [official hosted one](https://ntfy.sh/app) (it supports using other public reachable ntfy instances) or host it yourself by setting `ntfy_web_root: "app"` and re-running Ansible. + ## Troubleshooting