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

fix format

Browse source
This commit is contained in:
Simon Aronsson 2019-05-25 14:26:42 +02:00
parent 445db33f96
commit 9bbc2a2812
1 changed files with 144 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

218
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,108 +173,146 @@ 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: 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:
```bash ```bash
docker run --rm containrrr/watchtower --help docker run --rm containrrr/watchtower --help
``` ```
HELP ### Help
Type: - Shows documentation about the supported flags.
Command Line: --help
Environment Variable: -
Default: -
Show documentation about the supported flags
```
Argument: --help
Environment Variable: N/A
Type: N/A
Default: N/A
```
CLEANUP ### Cleanup
Type: --cleanup 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.
Command Line: Boolean
```
Argument: --cleanup
Environment Variable: WATCHTOWER_CLEANUP Environment Variable: WATCHTOWER_CLEANUP
Default: False Type: Boolean
Remove 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. Default: false
```
DEBUG ### Debug
Type: Boolean Enable debug mode with verbose logging.
Command Line: --debug
Environment Variable: -
Default: False
enable debug mode with verbose logging
HOST ```
Type: String Argument: --debug
Command Line: --host, -h Environment Variable: N/A
Environment Variable: DOCKER_HOST Type: Boolean
Default: "unix:///var/run/docker.sock" Default: false
```
### Docker host
Docker daemon socket to connect to. Can be pointed at a remote Docker host by specifying a TCP endpoint 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".
INCLUDE STOPPED ```
Type: Boolean Argument: --host, -h
Command Line: --include-stopped Environment Variable: DOCKER_HOST
Environment Variable: WATCHTOWER_INCLUDE_STOPPED Type: String
Default:False Default: "unix:///var/run/docker.sock"
```
### Include stopped
Will also include created and exited containers. Will also include created and exited containers.
INTERVAL ```
Type: Integer Argument: --include-stopped
Command Line: --interval, -i Environment Variable: WATCHTOWER_INCLUDE_STOPPED
Environment Variable: WATCHTOWER_POLL_INTERVAL Type: Boolean
Default: 300 Default: false
```
### 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.
LABEL ENABEL ```
Type: Boolean Argument: ---interval, -i
Command Line: --label-enable Environment Variable: WATCHTOWER_POLL_INTERVAL
Environment Variable: WATCHTOWER_LABEL_ENABLE Type: Integer
Default: False Default: 300
```
### 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.
MONITOR ONLY ```
Type: Boolean Argument: --label-enable
Command Line: --monitor-only Environment Variable: WATCHTOWER_LABEL_ENABLE
Environment Variable: WATCHTOWER_MONITOR_ONLY Type: Boolean
Default: False Default: false
```
### Without updating containers
Will only monitor for new images, not update the containers. Will only monitor for new images, not update the containers.
NO PULL ```
Type: Boolean Argument: --monitor-only
Command Line: --no-pull Environment Variable: WATCHTOWER_MONITOR_ONLY
Environment Variable: WATCHTOWER_NO_PULL Type: Boolean
Default: False Default: false
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. Use this option if you are building new images directly on the Docker host without pushing them to a registry. ```
RUN ONCE ### Without pulling new images
Type: Boolean Do not pull new images. When this flag is specified, watchtower will not attempt to pull
Command Line: new images from the registry. Instead it will only monitor the local image cache for changes.
Environment Variable: WATCHTOWER_RUN_ONCE Use this option if you are building new images directly on the Docker host without pushing
Default: False them to a registry.
```
Argument: --no-pull
Environment Variable: WATCHTOWER_NO_PULL
Type: Boolean
Default: false
```
### 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.
SCHEDULE ```
Type: String Argument: --run-once
Command Line: --schedule, -s Environment Variable: WATCHTOWER_RUN_ONCE
Environment Variable: WATCHTOWER_SCHEDULE Type: Boolean
Default: - Default: false
```
### 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 * * *"`
STOP TIMEOUT ```
Type: Duration Argument: --schedule, -s
Command Line: --stop-timeout Environment Variable: WATCHTOWER_SCHEDULE
Environment Variable: WATCHTOWER_TIMEOUT Type: String
Default: 10s Default: -
```
### 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.
TLS VERIFY ```
Type: Boolean Argument: --stop-timeout
Command Line: --tlsverify Environment Variable: WATCHTOWER_TIMEOUT
Type: Duration
Default: 10s
```
### TLS Verification
Use TLS when connecting to the Docker socket and verify the server's certificate. See below for options used to configure notifications.
```
Argument: --tlsverify
Environment Variable: DOCKER_TLS_VERIFY Environment Variable: DOCKER_TLS_VERIFY
Default: False Type: Boolean
Use TLS when connecting to the Docker socket and verify the server's certificate. Default: false
```
See below for options used to configure notifications.
## Linked Containers ## Linked Containers