Skip to content

Commit 81f05b3

Browse files
Merge pull request #1161 from OneWeekNotice/documentation-update
Updating Docs - configuration table, shoutrr, Scrutiny, etc
2 parents eb700b4 + 61bb8a0 commit 81f05b3

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

docs/config.md

+4
Original file line numberDiff line numberDiff line change
@@ -777,6 +777,7 @@ or the root domain:
777777
```
778778
# Note that this config is most certainly incomplete. Please help out and let me know what's missing
779779
# via Discord/Matrix or in a GitHub issue.
780+
# Note: Caddy automatically handles both HTTP and WebSockets with reverse_proxy
780781

781782
ntfy.sh, http://nfty.sh {
782783
reverse_proxy 127.0.0.1:2586
@@ -1427,6 +1428,9 @@ variable before running the `ntfy` command (e.g. `export NTFY_LISTEN_HTTP=:80`).
14271428
| `web-push-file` | `NTFY_WEB_PUSH_FILE` | *string* | - | Web Push: Database file that stores subscriptions |
14281429
| `web-push-email-address` | `NTFY_WEB_PUSH_EMAIL_ADDRESS` | *string* | - | Web Push: Sender email address |
14291430
| `web-push-startup-queries` | `NTFY_WEB_PUSH_STARTUP_QUERIES` | *string* | - | Web Push: SQL queries to run against subscription database at startup |
1431+
| `log-format` | `NTFY_LOG_FORMAT` | *string* | `text` | Defines the output format, can be text or json |
1432+
| `log-file` | `NTFY_LOG_FILE` | *string* | - | Defines the filename to write logs to. If this is not set, ntfy logs to stderr |
1433+
| `log-level` | `NTFY_LOG_LEVEL` | *string* | `info` | Defines the default log level, can be one of trace, debug, info, warn or error |
14301434

14311435
The format for a *duration* is: `<number>(smhd)`, e.g. 30s, 20m, 1h or 3d.
14321436
The format for a *size* is: `<number>(GMK)`, e.g. 1G, 200M or 4000k.

docs/examples.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,6 @@ services:
161161
watchtower:
162162
image: containrrr/watchtower
163163
environment:
164-
- WATCHTOWER_NOTIFICATIONS=shoutrrr
165164
- WATCHTOWER_NOTIFICATION_SKIP_TITLE=True
166165
- WATCHTOWER_NOTIFICATION_URL=ntfy://ntfy.sh/my_watchtower_topic?title=WatchtowerUpdates
167166
```
@@ -173,7 +172,14 @@ Or, if you only want to send notifications using shoutrrr:
173172
shoutrrr send -u "ntfy://ntfy.sh/my_watchtower_topic?title=WatchtowerUpdates" -m "testMessage"
174173
```
175174

176-
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):
175+
Authentication tokens are also supported:
176+
177+
- (Recommended) Ntfy url format (replace the domain, topic and token with your own):
178+
```
179+
ntfy://:TOKEN@DOMAIN/TOPIC
180+
```
181+
182+
- Generic webhook and authorization header using this url format (replace the domain, topic and token with your own):
177183

178184
```
179185
generic+https://DOMAIN/TOPIC?@authorization=Bearer+TOKEN`

docs/integrations.md

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ I've added a ⭐ to projects or posts that have a significant following, or had
3535
- [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))
3636
- [Mailrise](https://github.com/YoRyan/mailrise) - An SMTP gateway (integration via [Apprise](https://github.com/caronc/apprise/wiki/Notify_ntfy))
3737
- [Proxmox-Ntfy](https://github.com/qtsone/proxmox-ntfy) - Python script that monitors Proxmox tasks and sends notifications using the Ntfy service.
38+
- [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))
3839

3940
## [UnifiedPush](https://unifiedpush.org/users/apps/) integrations
4041

0 commit comments

Comments
 (0)