Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add example for generic service and custom data fields #2005

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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