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

fix format

Browse source
This commit is contained in:
Simon Aronsson 2019-05-25 14:26:42 +02:00
parent 22dc77efb2
commit f47dbfed49
1 changed files with 164 additions and 137 deletions
Download patch file Download diff file Expand all files Collapse all files

275
README.md
View file

@ -40,6 +40,38 @@
</a> </a>
</p> </p>
## Table of Contents
- [Overview](#overview)
- [Usage](#usage)
- [Arguments](#arguments)
- [Available Options](#available-options)
* [Help](#help)
* [Cleanup](#cleanup)
* [Debug](#debug)
* [Docker host](#docker-host)
* [Include stopped](#include-stopped)
* [Poll Interval](#poll-interval)
* [Filter by enable label](#filter-by-enable-label)
* [Without updating containers](#without-updating-containers)
* [Without pulling new images](#without-pulling-new-images)
* [Run once](#run-once)
* [Scheduling](#scheduling)
* [Wait until timeout](#wait-until-timeout)
* [TLS Verification](#tls-verification)
- [Linked Containers](#linked-containers)
- [Stopping Containers](#stopping-containers)
- [Selectively Watching Containers](#selectively-watching-containers)
- [Remote Hosts](#remote-hosts)
* [Secure Connections](#secure-connections)
- [Updating Watchtower](#updating-watchtower)
- [Notifications](#notifications)
* [Settings](#settings)
* [Notifications via E-Mail](#notifications-via-e-mail)
* [Notifications through Slack webhook](#notifications-through-slack-webhook)
* [Notifications via MSTeams incoming webhook](#notifications-via-msteams-incoming-webhook)
- [Contributors](#contributors)
## Overview ## Overview
Watchtower is an application that will monitor your running Docker containers and watch for changes to the images that those containers were originally started from. If watchtower detects that an image has changed, it will automatically restart the container using the new image. Watchtower is an application that will monitor your running Docker containers and watch for changes to the images that those containers were originally started from. If watchtower detects that an image has changed, it will automatically restart the container using the new image.
@ -116,7 +148,7 @@ services:
command: --interval 30 command: --interval 30
``` ```
### Arguments ## Arguments
By default, watchtower will monitor all containers running within the Docker daemon to which it is pointed (in most cases this will be the local Docker daemon, but you can override it with the `--host` option described in the next section). However, you can restrict watchtower to monitoring a subset of the running containers by specifying the container names as arguments when launching watchtower. By default, watchtower will monitor all containers running within the Docker daemon to which it is pointed (in most cases this will be the local Docker daemon, but you can override it with the `--host` option described in the next section). However, you can restrict watchtower to monitoring a subset of the running containers by specifying the container names as arguments when launching watchtower.
@ -141,7 +173,7 @@ In the example above, watchtower will execute an upgrade attempt on the containe
When no arguments are specified, watchtower will monitor all running containers. When no arguments are specified, watchtower will monitor all running containers.
### Options ## Available options
Any of the options described below can be passed to the watchtower process by setting them after the image name in the `docker run` string, for example: Any of the options described below can be passed to the watchtower process by setting them after the image name in the `docker run` string, for example:
@ -149,143 +181,138 @@ Any of the options described below can be passed to the watchtower process by se
docker run --rm containrrr/watchtower --help docker run --rm containrrr/watchtower --help
``` ```
### Help
Shows documentation about the supported flags.
#### Help ```
Argument: --help
Environment Variable: N/A
Type: N/A
Default: N/A
```
<table width="100%"> ### Cleanup
<thead> Removes old images after updating. When this flag is specified, watchtower will remove the old image after restarting a container with a new image. Use this option to prevent the accumulation of orphaned images on your system as containers are updated.
<tr>
<th>Argument</th> ```
<th>Environment Variable</th> Argument: --cleanup
<th>Type</th> Environment Variable: WATCHTOWER_CLEANUP
<th>Default</th> Type: Boolean
<th>Description</th> Default: false
</tr> ```
</thead>
<tbody> ### Debug
<tr>
<td>--help</td>
<td>-</td>
<td>-</td>
<td>-</td>
<td>Shows documentation about the supported flags</td>
</tr>
<tr>
<td>--cleanup</td>
<td>WATCHTOWER_CLEANUP</td>
<td>Boolean</td>
<td>false</td>
<td>
Removes old images after updating. When this flag is specified, watchtower will remove the old image after
restarting a container with a new image. Use this option to prevent the accumulation of orphaned images on
your system as containers are updated.
</td>
</tr>
<tr>
<td>--debug</td>
<td>-</td>
<td>Boolean</td>
<td>false</td>
<td>
Enable debug mode with verbose logging. Enable debug mode with verbose logging.
</td>
</tr> ```
<tr> Argument: --debug
<td>--host, -h</td> Environment Variable: N/A
<td>DOCKER_HOST</td> Type: Boolean
<td>String</td> Default: false
<td>"unix:///var/run/docker.sock"</td> ```
<td>
Docker daemon socket to connect to. Can be pointed at a remote Docker host by specifying a TCP endpoint ### Docker host
as "tcp://hostname:port". Docker daemon socket to connect to. Can be pointed at a remote Docker host by specifying a TCP endpoint as "tcp://hostname:port".
</td>
</tr> ```
<tr> Argument: --host, -h
<td>--include-stopped</td> Environment Variable: DOCKER_HOST
<td>WATCHTOWER_INCLUDE_STOPPED</td> Type: String
<td>Boolean</td> Default: "unix:///var/run/docker.sock"
<td>false</td> ```
<td>
### Include stopped
Will also include created and exited containers. Will also include created and exited containers.
</td>
</tr> ```
<tr> Argument: --include-stopped
<td>---interval, -i</td> Environment Variable: WATCHTOWER_INCLUDE_STOPPED
<td>WATCHTOWER_POLL_INTERVAL</td> Type: Boolean
<td>Integer</td> Default: false
<td>300</td> ```
<td>
### Poll Interval
Poll interval (in seconds). This value controls how frequently watchtower will poll for new images. Poll interval (in seconds). This value controls how frequently watchtower will poll for new images.
</td>
</tr> ```
<tr> Argument: ---interval, -i
<td>--label-enable</td> Environment Variable: WATCHTOWER_POLL_INTERVAL
<td>WATCHTOWER_LABEL_ENABLE</td> Type: Integer
<td>Boolean</td> Default: 300
<td>False</td> ```
<td>
### Filter by enable label
Watch containers where the `com.centurylinklabs.watchtower.enable` label is set to true. Watch containers where the `com.centurylinklabs.watchtower.enable` label is set to true.
</td>
</tr> ```
<tr> Argument: --label-enable
<td>--monitor-only</td> Environment Variable: WATCHTOWER_LABEL_ENABLE
<td>WATCHTOWER_MONITOR_ONLY</td> Type: Boolean
<td>Boolean</td> Default: false
<td>False</td> ```
<td>
### Without updating containers
Will only monitor for new images, not update the containers. Will only monitor for new images, not update the containers.
</td>
</tr> ```
<tr> Argument: --monitor-only
<td>--no-pull</td> Environment Variable: WATCHTOWER_MONITOR_ONLY
<td>WATCHTOWER_NO_PULL</td> Type: Boolean
<td>Boolean</td> Default: false
<td>False</td> ```
<td>
### Without pulling new images
Do not pull new images. When this flag is specified, watchtower will not attempt to pull Do not pull new images. When this flag is specified, watchtower will not attempt to pull
new images from the registry. Instead it will only monitor the local image cache for changes. new images from the registry. Instead it will only monitor the local image cache for changes.
Use this option if you are building new images directly on the Docker host without pushing Use this option if you are building new images directly on the Docker host without pushing
them to a registry. them to a registry.
</td>
</tr> ```
<tr> Argument: --no-pull
<td>--run-once</td> Environment Variable: WATCHTOWER_NO_PULL
<td>WATCHTOWER_RUN_ONCE</td> Type: Boolean
<td>Boolean</td> Default: false
<td>False</td> ```
<td>
### Run once
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.
</td>
</tr> ```
<tr> Argument: --run-once
<td>--schedule, -s</td> Environment Variable: WATCHTOWER_RUN_ONCE
<td>WATCHTOWER_SCHEDULE</td> Type: Boolean
<td>String</td> Default: false
<td>-</td> ```
<td>
### Scheduling
[Cron expression](https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format) in 6 fields (rather than the traditional 5) which defines when and how often to check for new images. Either `--interval` or the schedule expression could be defined, but not both. An example: `--schedule "0 0 4 * * *"` [Cron expression](https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format) in 6 fields (rather than the traditional 5) which defines when and how often to check for new images. Either `--interval` or the schedule expression could be defined, but not both. An example: `--schedule "0 0 4 * * *"`
</td>
</tr> ```
<tr> Argument: --schedule, -s
<td>--stop-timeout</td> Environment Variable: WATCHTOWER_SCHEDULE
<td>WATCHTOWER_TIMEOUT</td> Type: String
<td>Duration</td> Default: -
<td>10s</td> ```
<td>
### Wait until timeout
Timeout before the container is forcefully stopped. When set, this option will change the default (`10s`) wait time to the given value. An example: `--stop-timeout 30s` will set the timeout to 30 seconds. Timeout before the container is forcefully stopped. When set, this option will change the default (`10s`) wait time to the given value. An example: `--stop-timeout 30s` will set the timeout to 30 seconds.
</td>
</tr> ```
<tr> Argument: --stop-timeout
<td>--tlsverify</td> Environment Variable: WATCHTOWER_TIMEOUT
<td>DOCKER_TLS_VERIFY</td> Type: Duration
<td>Boolean</td> Default: 10s
<td>false</td> ```
<td>
### TLS Verification
Use TLS when connecting to the Docker socket and verify the server's certificate. See below for options used to configure notifications. Use TLS when connecting to the Docker socket and verify the server's certificate. See below for options used to configure notifications.
</td>
</tr> ```
</tbody> Argument: --tlsverify
</table> Environment Variable: DOCKER_TLS_VERIFY
Type: Boolean
Default: false
```
## Linked Containers ## Linked Containers