Andreas/watchtower
1
0
Fork 0
mirror of https://github.com/containrrr/watchtower.git synced 2025-12-16 15:10:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add missing flag usage

Browse source
This commit is contained in:
nils måsén 2023-09-16 16:51:37 +02:00
parent 8457887f37
commit 1b0eaa45b5
2 changed files with 20 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/arguments.md
View file

@ -178,7 +178,7 @@ Environment Variable: WATCHTOWER_INCLUDE_RESTARTING
Will also include created and exited containers. Will also include created and exited containers.
```text ```text
Argument: --include-stopped Argument: --include-stopped, -S
Environment Variable: WATCHTOWER_INCLUDE_STOPPED Environment Variable: WATCHTOWER_INCLUDE_STOPPED
Type: Boolean Type: Boolean
Default: false Default: false
@ -278,7 +278,7 @@ Environment Variable: WATCHTOWER_NO_STARTUP_MESSAGE
Run an update attempt against a container name list one time immediately and exit. Run an update attempt against a container name list one time immediately and exit.
```text ```text
Argument: --run-once Argument: --run-once, -R
Environment Variable: WATCHTOWER_RUN_ONCE Environment Variable: WATCHTOWER_RUN_ONCE
Type: Boolean Type: Boolean
Default: false Default: false
@ -392,3 +392,20 @@ Environment Variable: WATCHTOWER_WARN_ON_HEAD_FAILURE
Possible values: always, auto, never Possible values: always, auto, never
Default: auto Default: auto
``` ```
## Programatic Output (porcelain)
Writes the session results to STDOUT using a stable, machine-readable format (indicated by the argument VERSION).
Alias for:
```text
--notification-url logger://
--notification-log-stdout
--notification-report
--notification-template porcelain.VERSION.summary-no-log
Argument: --porcelain, -P
Environment Variable: WATCHTOWER_PORCELAIN
Possible values: v1
Default: -
```

1
docs/notifications.md
View file

@ -22,6 +22,7 @@ system, [logrus](http://github.com/sirupsen/logrus).
- 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://containrrr.github.io/watchtower/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-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-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.
## [shoutrrr](https://github.com/containrrr/shoutrrr) notifications ## [shoutrrr](https://github.com/containrrr/shoutrrr) notifications