From 6da554d1e5ff071488d1eb9ca508154542a7fc95 Mon Sep 17 00:00:00 2001 From: OneWeekNotice <3814277+OneWeekNotice@users.noreply.github.com> Date: Fri, 26 Jul 2024 22:43:08 -0400 Subject: [PATCH 1/5] adding documentation for caddy WebSockets --- docs/config.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/config.md b/docs/config.md index 5fc1b6e5..82236c54 100644 --- a/docs/config.md +++ b/docs/config.md @@ -777,6 +777,7 @@ or the root domain: ``` # Note that this config is most certainly incomplete. Please help out and let me know what's missing # via Discord/Matrix or in a GitHub issue. + # Note: Caddy automatically handles both HTTP and WebSockets with reverse_proxy ntfy.sh, http://nfty.sh { reverse_proxy 127.0.0.1:2586 From 6562ba698786171094491699ee1f285383cb14e0 Mon Sep 17 00:00:00 2001 From: OneWeekNotice <3814277+OneWeekNotice@users.noreply.github.com> Date: Fri, 26 Jul 2024 22:48:14 -0400 Subject: [PATCH 2/5] adding Watchtower - shoutrrr authentication with auth token utilizing ntfy url --- docs/examples.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/examples.md b/docs/examples.md index 73a58836..3004ed3c 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -173,7 +173,14 @@ Or, if you only want to send notifications using shoutrrr: shoutrrr send -u "ntfy://ntfy.sh/my_watchtower_topic?title=WatchtowerUpdates" -m "testMessage" ``` -Authentication tokens are also supported via the generic webhook and authorization header using this url format (replace the domain, topic and token with your own): +Authentication tokens are also supported: + +- (Recommended) Ntfy url format (replace the domain, topic and token with your own): +``` +ntfy://:TOKEN@DOMAIN/TOPIC +``` + +- Generic webhook and authorization header using this url format (replace the domain, topic and token with your own): ``` generic+https://DOMAIN/TOPIC?@authorization=Bearer+TOKEN` From a4cf40907b4ad309af3ab6db68424a4f042516bc Mon Sep 17 00:00:00 2001 From: OneWeekNotice <3814277+OneWeekNotice@users.noreply.github.com> Date: Fri, 26 Jul 2024 22:50:27 -0400 Subject: [PATCH 3/5] removing WATCHTOWER_NOTIFICATIONS as this is Legacy notifications --- docs/examples.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/examples.md b/docs/examples.md index 3004ed3c..d6f83f30 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -161,7 +161,6 @@ services: watchtower: image: containrrr/watchtower environment: - - WATCHTOWER_NOTIFICATIONS=shoutrrr - WATCHTOWER_NOTIFICATION_SKIP_TITLE=True - WATCHTOWER_NOTIFICATION_URL=ntfy://ntfy.sh/my_watchtower_topic?title=WatchtowerUpdates ``` From be2bebf517ae48ab141507b47b92ac07390df518 Mon Sep 17 00:00:00 2001 From: OneWeekNotice <3814277+OneWeekNotice@users.noreply.github.com> Date: Fri, 26 Jul 2024 23:01:35 -0400 Subject: [PATCH 4/5] adding logging configurations to Config options table --- docs/config.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/config.md b/docs/config.md index 82236c54..1fdc5a8d 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1428,6 +1428,9 @@ variable before running the `ntfy` command (e.g. `export NTFY_LISTEN_HTTP=:80`). | `web-push-file` | `NTFY_WEB_PUSH_FILE` | *string* | - | Web Push: Database file that stores subscriptions | | `web-push-email-address` | `NTFY_WEB_PUSH_EMAIL_ADDRESS` | *string* | - | Web Push: Sender email address | | `web-push-startup-queries` | `NTFY_WEB_PUSH_STARTUP_QUERIES` | *string* | - | Web Push: SQL queries to run against subscription database at startup | +| `log-format` | `NTFY_LOG_FORMAT` | *string* | `text` | Defines the output format, can be text or json | +| `log-file` | `NTFY_LOG_FILE` | *string* | - | Defines the filename to write logs to. If this is not set, ntfy logs to stderr | +| `log-level` | `NTFY_LOG_LEVEL` | *string* | `info` | Defines the default log level, can be one of trace, debug, info, warn or error | The format for a *duration* is: `(smhd)`, e.g. 30s, 20m, 1h or 3d. The format for a *size* is: `(GMK)`, e.g. 1G, 200M or 4000k. From 61bb8a0286f97093782d59bf47daf3bc0a688bed Mon Sep 17 00:00:00 2001 From: OneWeekNotice <3814277+OneWeekNotice@users.noreply.github.com> Date: Fri, 26 Jul 2024 23:16:49 -0400 Subject: [PATCH 5/5] adding Scrutiny project to integrations documentation --- docs/integrations.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/integrations.md b/docs/integrations.md index 55bf4a9d..762fee3a 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -35,6 +35,7 @@ I've added a ⭐ to projects or posts that have a significant following, or had - [Tautulli](https://github.com/Tautulli/Tautulli) ⭐ - Monitoring and tracking tool for Plex (integration [via webhook](https://github.com/Tautulli/Tautulli/wiki/Notification-Agents-Guide#webhook)) - [Mailrise](https://github.com/YoRyan/mailrise) - An SMTP gateway (integration via [Apprise](https://github.com/caronc/apprise/wiki/Notify_ntfy)) - [Proxmox-Ntfy](https://github.com/qtsone/proxmox-ntfy) - Python script that monitors Proxmox tasks and sends notifications using the Ntfy service. +- [Scrutiny](https://github.com/AnalogJ/scrutiny) - WebUI for smartd S.M.A.R.T monitoring. Scrutiny includes shoutrrr/ntfy integration ([see integration README](https://github.com/AnalogJ/scrutiny?tab=readme-ov-file#notifications)) ## [UnifiedPush](https://unifiedpush.org/users/apps/) integrations