Skip to content

Commit

Permalink
docs: add example for generic service and custom data fields
Browse files Browse the repository at this point in the history
  • Loading branch information
Knapoc authored Jul 27, 2024
1 parent 76f9cea commit 390ba1c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,21 @@ Simple templates are used unless the `notification-report` flag is specified:

- `--notification-report` (env. `WATCHTOWER_NOTIFICATION_REPORT`): Use the session report as the notification template data.

Whenever the `$` character is being used, for example in the case of [custom data fields](https://containrrr.dev/shoutrrr/v0.8/services/generic/#custom_data_fields) of a `generic` service url, the `$` character needs to be
escaped with docker compose:
``` yaml
version: "3"
services:
watchtower:
image: containrrr/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
env:
WATCHTOWER_NOTIFICATION_URL: 'generic://signal-cli-rest-api:8080/v2/send?template=json&disabletls=yes&$$number=%2b123456&$$recipient=%2b123456'
```
## Simple templates
The default value if not set is `{{range .}}{{.Message}}{{println}}{{end}}`. The example below uses a template that also
Expand Down

0 comments on commit 390ba1c

Please sign in to comment.