Update docs/configuring-playbook-ntfy.md: create a section for the web app
- Remove the reasoning on why the web app is disabled by default as it is uncommon among the playbook's documentation
- Add the link to the official documentation about using the web app
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
As the most of the necessary settings for the role have been taken care of by the playbook, you can enable ntfy on your Matrix server with this minimum configuration.
See the role's documentation for details about configuring ntfy per your preference (such as [its web app](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#enable-web-app-optional)).
See the role's documentation for details about configuring ntfy per your preference (such as [setting access control with authentication](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#enable-access-control-with-authentication-optional)).
After changing the domain, **you may need to adjust your DNS** records to point the ntfy domain to the Matrix server.
### Enable web app (optional)
ntfy also has a web app to subscribe to and push to topics from the browser. This may be helpful to troubleshoot notification issues or to use ntfy for other purposes than getting ntfy send UnifiedPush notifications to your Matrix-related services.
To enable the web app, add the following configuration to your `vars.yml` file:
```yaml
ntfy_web_root: app
```
See [the official documentation](https://docs.ntfy.sh/subscribe/web/) for details about how to use it.
## Installing
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
@@ -114,14 +126,6 @@ If the Matrix client asks, "Choose a distributor: FCM Fallback or ntfy", then ch
If the Matrix client doesn't seem to pick it up, try restarting it and try the Troubleshooting section below.
### Web App
ntfy also has a web app to subscribe to 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 is disabled in this playbook by default as the expectation is that most users won't use it. You can host it yourself or use the [official hosted one](https://ntfy.sh/app) if self-hosting is not possible (the official app supports using other public reachable ntfy instances).
See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#enable-web-app-optional) on the role's documentation for details about enabling the web app.