chore(docs): Update docs

This commit is contained in:
Jan Rundshagen 2024-07-09 09:22:02 +02:00
parent 7382727c74
commit 156d25ccea
No known key found for this signature in database
GPG key ID: D39ECE260D6616C7
12 changed files with 55 additions and 58 deletions

View file

@ -19,7 +19,7 @@ system, [logrus](http://github.com/sirupsen/logrus).
- `--notifications-level` (env. `WATCHTOWER_NOTIFICATIONS_LEVEL`): Controls the log level which is used for the notifications. If omitted, the default log level is `info`. Possible values are: `panic`, `fatal`, `error`, `warn`, `info`, `debug` or `trace`.
- `--notifications-hostname` (env. `WATCHTOWER_NOTIFICATIONS_HOSTNAME`): Custom hostname specified in subject/title. Useful to override the operating system hostname.
- `--notifications-delay` (env. `WATCHTOWER_NOTIFICATIONS_DELAY`): Delay before sending notifications expressed in seconds.
- Watchtower will post a notification every time it is started. This behavior [can be changed](https://containrrr.github.io/watchtower/arguments/#without_sending_a_startup_message) with an argument.
- Watchtower will post a notification every time it is started. This behavior [can be changed](https://watchtower.devcdn.net/arguments/#without_sending_a_startup_message) with an argument.
- `--notification-title-tag` (env. `WATCHTOWER_NOTIFICATION_TITLE_TAG`): Prefix to include in the title. Useful when running multiple watchtowers.
- `--notification-skip-title` (env. `WATCHTOWER_NOTIFICATION_SKIP_TITLE`): Do not pass the title param to notifications. This will not pass a dynamic title override to notification services. If no title is configured for the service, it will remove the title all together.
- `--notification-log-stdout` (env. `WATCHTOWER_NOTIFICATION_LOG_STDOUT`): Enable output from `logger://` shoutrrr service to stdout.
@ -69,7 +69,7 @@ docker run -d \
-v /var/run/docker.sock:/var/run/docker.sock \
-e WATCHTOWER_NOTIFICATION_URL="discord://token@channel slack://watchtower@token-a/token-b/token-c" \
-e WATCHTOWER_NOTIFICATION_TEMPLATE="{{range .}}{{.Time.Format \"2006-01-02 15:04:05\"}} ({{.Level}}): {{.Message}}{{println}}{{end}}" \
containrrr/watchtower
beatkind/watchtower
```
## Report templates
@ -138,7 +138,7 @@ Example using a custom report template that always sends a session report after
{{range .Entries -}}{{.Message}}{{\"\n\"}}{{- end -}}
{{- end -}}
" \
containrrr/watchtower
beatkind/watchtower
```
=== "docker-compose"
@ -147,7 +147,7 @@ Example using a custom report template that always sends a session report after
version: "3"
services:
watchtower:
image: containrrr/watchtower
image: beatkind/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
env:
@ -199,7 +199,7 @@ If watchtower is started with `notify-upgrade` as it's first argument, it will g
-v /var/run/docker.sock:/var/run/docker.sock \
-e WATCHTOWER_NOTIFICATIONS=slack \
-e WATCHTOWER_NOTIFICATION_SLACK_HOOK_URL="https://hooks.slack.com/services/xxx/yyyyyyyyyyyyyyy" \
containrrr/watchtower \
beatkind/watchtower \
notify-upgrade
```
@ -209,7 +209,7 @@ If watchtower is started with `notify-upgrade` as it's first argument, it will g
version: "3"
services:
watchtower:
image: containrrr/watchtower
image: beatkind/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
env:
@ -228,7 +228,7 @@ You can then copy this file from the container (a message with the full command
--name watchtower \
-v /var/run/docker.sock:/var/run/docker.sock \
--env-file watchtower-notifications.env \
containrrr/watchtower
beatkind/watchtower
```
=== "docker-compose.yml"
@ -237,7 +237,7 @@ You can then copy this file from the container (a message with the full command
version: "3"
services:
watchtower:
image: containrrr/watchtower
image: beatkind/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
env_file:
@ -272,7 +272,7 @@ docker run -d \
-e WATCHTOWER_NOTIFICATION_EMAIL_SERVER_USER=fromaddress@gmail.com \
-e WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PASSWORD=app_password \
-e WATCHTOWER_NOTIFICATION_EMAIL_DELAY=2 \
containrrr/watchtower
beatkind/watchtower
```
The previous example assumes, that you already have an SMTP server up and running you can connect to. If you don't or you want to bring up watchtower with your own simple SMTP relay the following `docker-compose.yml` might be a good start for you.
@ -285,7 +285,7 @@ Example including an SMTP relay:
version: '3.8'
services:
watchtower:
image: containrrr/watchtower:latest
image: beatkind/watchtower:latest
container_name: watchtower
environment:
WATCHTOWER_MONITOR_ONLY: 'true'
@ -347,7 +347,7 @@ docker run -d \
-e WATCHTOWER_NOTIFICATION_SLACK_HOOK_URL="https://hooks.slack.com/services/xxx/yyyyyyyyyyyyyyy" \
-e WATCHTOWER_NOTIFICATION_SLACK_IDENTIFIER=watchtower-server-1 \
-e WATCHTOWER_NOTIFICATION_SLACK_CHANNEL=#my-custom-channel \
containrrr/watchtower
beatkind/watchtower
```
### Microsoft Teams
@ -367,7 +367,7 @@ docker run -d \
-e WATCHTOWER_NOTIFICATIONS=msteams \
-e WATCHTOWER_NOTIFICATION_MSTEAMS_HOOK_URL="https://outlook.office.com/webhook/xxxxxxxx@xxxxxxx/IncomingWebhook/yyyyyyyy/zzzzzzzzzz" \
-e WATCHTOWER_NOTIFICATION_MSTEAMS_USE_LOG_DATA=true \
containrrr/watchtower
beatkind/watchtower
```
### Gotify
@ -381,7 +381,7 @@ docker run -d \
-e WATCHTOWER_NOTIFICATIONS=gotify \
-e WATCHTOWER_NOTIFICATION_GOTIFY_URL="https://my.gotify.tld/" \
-e WATCHTOWER_NOTIFICATION_GOTIFY_TOKEN="SuperSecretToken" \
containrrr/watchtower
beatkind/watchtower
```
`-e WATCHTOWER_NOTIFICATION_GOTIFY_TOKEN` or `--notification-gotify-token` can also reference a file, in which case the contents of the file are used.