From 0ae2f08e331adab263e64c6c62ff4c8b923d0a60 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 2 Jan 2025 08:54:13 -0500 Subject: [PATCH 1/2] Update docs/configuring-playbook-ntfy.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-ntfy.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index 12bc7fc61..711685dc6 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -30,10 +30,6 @@ ntfy_enabled: true # log_level: DEBUG ``` -For a more complete list of variables that you could override, see the [`defaults/main.yml` file](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/defaults/main.yml) of the ntfy Ansible role. - -For a complete list of ntfy config options that you could put in `ntfy_configuration_extension_yaml`, see the [ntfy config documentation](https://ntfy.sh/docs/config/#config-options). - ### Adjusting the ntfy URL (optional) By tweaking the `ntfy_hostname` variable, you can easily make the service available at a **different hostname** than the default one. @@ -47,6 +43,16 @@ ntfy_hostname: push.example.com After changing the domain, **you may need to adjust your DNS** records to point the ntfy domain to the Matrix server. +### Extending the configuration + +There are some additional things you may wish to configure about the component. + +Take a look at: + +- [ntfy role](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `ntfy_configuration_extension_yaml` variable + +For a complete list of ntfy config options that you could put in `ntfy_configuration_extension_yaml`, see the [ntfy config documentation](https://ntfy.sh/docs/config/#config-options). + ## 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: From 64672bfa703c3e34a47ee4f47b3a7ec96911df07 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Wed, 29 Jan 2025 00:05:49 +0900 Subject: [PATCH 2/2] Update docs/configuring-playbook-ntfy.md: add the instruction for checking logs to the section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-ntfy.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index 711685dc6..cbf67c7c3 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -24,10 +24,6 @@ ntfy_enabled: true # 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 ``` ### Adjusting the ntfy URL (optional) @@ -113,9 +109,9 @@ The web app is disabled in this playbook by default as the expectation is that m ## Troubleshooting -First check that the Matrix client app you are using supports UnifiedPush. There may well be different variants of the app. +### Check a client application -Set the ntfy server's log level to 'DEBUG', as shown in the example settings above, and watch the server's logs with `sudo journalctl -fu matrix-ntfy`. +First check that the Matrix client app you are using supports UnifiedPush. There may well be different variants of the app. To check if UnifiedPush is correctly configured on the client device, look at "Settings -> Notifications -> Notification Targets" in Element Android or SchildiChat Android, or "Settings -> Notifications -> Devices" in FluffyChat. There should be one entry for each Matrix client app that has enabled push notifications, and when that client is using UnifiedPush you should see a URL that begins with your ntfy server's URL. @@ -124,3 +120,16 @@ In the "Notification Targets" screen in Element Android or SchildiChat Android, If it is not working, useful tools are "Settings -> Notifications -> Re-register push distributor" and "Settings -> Notifications -> Troubleshoot Notifications" in SchildiChat Android (possibly also Element Android). In particular the "Endpoint/FCM" step of that troubleshooter should display your ntfy server's URL that it has discovered from the ntfy client app. The simple [UnifiedPush troubleshooting](https://unifiedpush.org/users/troubleshooting/) app [UP-Example](https://f-droid.org/en/packages/org.unifiedpush.example/) can be used to manually test UnifiedPush registration and operation on an Android device. + +### Check the service's logs + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-ntfy`. + +#### Increase logging verbosity + +If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +ntfy_configuration_extension_yaml: | + log_level: DEBUG +```