Fix phrasing

This commit is contained in:
Simon Aronsson 2019-08-27 08:16:43 +02:00 committed by GitHub
parent 04d9ca39d5
commit 285f84af71
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,10 +6,10 @@
It is possible to execute _pre/post\-check_ and _pre/post\-update_ commands
**inside** every container updated by watchtower.
- The _pre-check_ command is executed before checking the container for updates.
- The _pre-check_ command is executed for each container prior to every update cycle.
- The _pre-update_ command is executed before stopping the container when an update is about to start.
- The _post-update_ command is executed after restarting the updated container
- The _post-check_ command is executed last after a updated container is started or no update was needed.
- The _post-check_ command is executed for each container post every update cycle.
This feature is disabled by default. To enable it, you need to set the option
`--enable-lifecycle-hooks` on the command line, or set the environment variable
@ -19,10 +19,12 @@ This feature is disabled by default. To enable it, you need to set the option
The commands are specified using docker container labels, the following are currently available:
- `com.centurylinklabs.watchtower.lifecycle.pre-check` - _pre-check_
- `com.centurylinklabs.watchtower.lifecycle.pre-update-command` - _pre-update_
- `com.centurylinklabs.watchtower.lifecycle.post-update` - _post-update_
- `com.centurylinklabs.watchtower.lifecycle.post-check` - _post-check_
| Type | Docker Container Label |
| ----------- | ------------------------------------------------------ |
| Pre Check | `com.centurylinklabs.watchtower.lifecycle.pre-check` |
| Pre Update | `com.centurylinklabs.watchtower.lifecycle.pre-update` |
| Post Update | `com.centurylinklabs.watchtower.lifecycle.post-update` |
| Post Check | `com.centurylinklabs.watchtower.lifecycle.post-check` |
These labels can be declared as instructions in a Dockerfile (with some example .sh files):