You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
899 lines
26 KiB
HTML
899 lines
26 KiB
HTML
|
|
|
|
|
|
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
|
|
|
|
<link rel="canonical" href="http://containrrr.github.io/watchtower/arguments/">
|
|
|
|
|
|
|
|
<meta name="lang:clipboard.copy" content="Copy to clipboard">
|
|
|
|
<meta name="lang:clipboard.copied" content="Copied to clipboard">
|
|
|
|
<meta name="lang:search.language" content="en">
|
|
|
|
<meta name="lang:search.pipeline.stopwords" content="True">
|
|
|
|
<meta name="lang:search.pipeline.trimmer" content="True">
|
|
|
|
<meta name="lang:search.result.none" content="No matching documents">
|
|
|
|
<meta name="lang:search.result.one" content="1 matching document">
|
|
|
|
<meta name="lang:search.result.other" content="# matching documents">
|
|
|
|
<meta name="lang:search.tokenizer" content="[\s\-]+">
|
|
|
|
<link rel="shortcut icon" href="../assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
|
|
|
|
|
|
|
|
<title>Arguments - Watchtower</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/application.1b62728e.css">
|
|
|
|
|
|
|
|
|
|
<script src="../assets/javascripts/modernizr.268332fc.js"></script>
|
|
|
|
|
|
|
|
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/fonts/material-icons.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body dir="ltr">
|
|
|
|
<svg class="md-svg">
|
|
<defs>
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
|
|
|
|
</defs>
|
|
</svg>
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
|
|
|
|
<a href="#help" tabindex="1" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header-nav md-grid">
|
|
<div class="md-flex">
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<a href="http://containrrr.github.io/watchtower/" title="Watchtower" class="md-header-nav__button md-logo">
|
|
|
|
<i class="md-icon"></i>
|
|
|
|
</a>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--stretch">
|
|
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
|
|
|
|
<span class="md-header-nav__topic">
|
|
Watchtower
|
|
</span>
|
|
<span class="md-header-nav__topic">
|
|
|
|
Arguments
|
|
|
|
</span>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
|
|
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
|
|
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
|
|
<label class="md-icon md-search__icon" for="__search"></label>
|
|
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
|
|

|
|
</button>
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="result">
|
|
<div class="md-search-result__meta">
|
|
Type to start searching
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<div class="md-header-nav__source">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source" data-md-source="github">
|
|
|
|
<div class="md-source__icon">
|
|
<svg viewBox="0 0 24 24" width="24" height="24">
|
|
<use xlink:href="#__github" width="24" height="24"></use>
|
|
</svg>
|
|
</div>
|
|
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<div class="md-container">
|
|
|
|
|
|
|
|
|
|
<main class="md-main" role="main">
|
|
<div class="md-main__inner md-grid" data-md-component="container">
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
<nav class="md-nav md-nav--primary" data-md-level="0">
|
|
<label class="md-nav__title md-nav__title--site" for="__drawer">
|
|
<a href="http://containrrr.github.io/watchtower/" title="Watchtower" class="md-nav__button md-logo">
|
|
|
|
<i class="md-icon"></i>
|
|
|
|
</a>
|
|
Watchtower
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source" data-md-source="github">
|
|
|
|
<div class="md-source__icon">
|
|
<svg viewBox="0 0 24 24" width="24" height="24">
|
|
<use xlink:href="#__github" width="24" height="24"></use>
|
|
</svg>
|
|
</div>
|
|
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href=".." title="Home" class="md-nav__link">
|
|
Home
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../introduction/" title="Introduction" class="md-nav__link">
|
|
Introduction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../usage-overview/" title="Usage overview" class="md-nav__link">
|
|
Usage overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
Arguments
|
|
</label>
|
|
|
|
<a href="./" title="Arguments" class="md-nav__link md-nav__link--active">
|
|
Arguments
|
|
</a>
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary">
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">Table of contents</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#help" class="md-nav__link">
|
|
Help
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cleanup" class="md-nav__link">
|
|
Cleanup
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remove_attached_volumes" class="md-nav__link">
|
|
Remove attached volumes
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#debug" class="md-nav__link">
|
|
Debug
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#docker_host" class="md-nav__link">
|
|
Docker host
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#docker_api_version" class="md-nav__link">
|
|
Docker API version
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#include_stopped" class="md-nav__link">
|
|
Include stopped
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#revive_stopped" class="md-nav__link">
|
|
Revive stopped
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#poll_interval" class="md-nav__link">
|
|
Poll interval
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#filter_by_enable_label" class="md-nav__link">
|
|
Filter by enable label
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#without_updating_containers" class="md-nav__link">
|
|
Without updating containers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#without_restarting_containers" class="md-nav__link">
|
|
Without restarting containers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#without_pulling_new_images" class="md-nav__link">
|
|
Without pulling new images
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#run_once" class="md-nav__link">
|
|
Run once
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#scheduling" class="md-nav__link">
|
|
Scheduling
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#wait_until_timeout" class="md-nav__link">
|
|
Wait until timeout
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tls_verification" class="md-nav__link">
|
|
TLS Verification
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../notifications/" title="Notifications" class="md-nav__link">
|
|
Notifications
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../container-selection/" title="Container selection" class="md-nav__link">
|
|
Container selection
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../private-registries/" title="Private registries" class="md-nav__link">
|
|
Private registries
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../linked-containers/" title="Linked containers" class="md-nav__link">
|
|
Linked containers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../remote-hosts/" title="Remote hosts" class="md-nav__link">
|
|
Remote hosts
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../secure-connections/" title="Secure connections" class="md-nav__link">
|
|
Secure connections
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../stop-signals/" title="Stop signals" class="md-nav__link">
|
|
Stop signals
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../lifecycle-hooks/" title="Lifecycle hooks" class="md-nav__link">
|
|
Lifecycle hooks
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<nav class="md-nav md-nav--secondary">
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">Table of contents</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#help" class="md-nav__link">
|
|
Help
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#cleanup" class="md-nav__link">
|
|
Cleanup
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remove_attached_volumes" class="md-nav__link">
|
|
Remove attached volumes
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#debug" class="md-nav__link">
|
|
Debug
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#docker_host" class="md-nav__link">
|
|
Docker host
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#docker_api_version" class="md-nav__link">
|
|
Docker API version
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#include_stopped" class="md-nav__link">
|
|
Include stopped
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#revive_stopped" class="md-nav__link">
|
|
Revive stopped
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#poll_interval" class="md-nav__link">
|
|
Poll interval
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#filter_by_enable_label" class="md-nav__link">
|
|
Filter by enable label
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#without_updating_containers" class="md-nav__link">
|
|
Without updating containers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#without_restarting_containers" class="md-nav__link">
|
|
Without restarting containers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#without_pulling_new_images" class="md-nav__link">
|
|
Without pulling new images
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#run_once" class="md-nav__link">
|
|
Run once
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#scheduling" class="md-nav__link">
|
|
Scheduling
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#wait_until_timeout" class="md-nav__link">
|
|
Wait until timeout
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tls_verification" class="md-nav__link">
|
|
TLS Verification
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/containrrr/watchtower/edit/master/docs/arguments.md" title="Edit this page" class="md-icon md-content__icon"></a>
|
|
|
|
|
|
<h1>Arguments</h1>
|
|
|
|
<p>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 <code>--host</code> 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.</p>
|
|
<pre><code class="bash">$ docker run -d \
|
|
--name watchtower \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
containrrr/watchtower \
|
|
nginx redis
|
|
</code></pre>
|
|
|
|
<p>In the example above, watchtower will only monitor the containers named "nginx" and "redis" for updates -- all of the other
|
|
running containers will be ignored. If you do not want watchtower to run as a daemon you can pass the <code>--run-once</code> flag and remove
|
|
the watchtower container after its execution.</p>
|
|
<pre><code class="bash">$ docker run --rm \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
containrrr/watchtower \
|
|
--run-once \
|
|
nginx redis
|
|
</code></pre>
|
|
|
|
<p>In the example above, watchtower will execute an upgrade attempt on the containers named "nginx" and "redis". Using this mode will enable debugging output showing all actions performed, as usage is intended for interactive users. Once the attempt is completed, the container will exit and remove itself due to the <code>--rm</code> flag.</p>
|
|
<p>When no arguments are specified, watchtower will monitor all running containers.</p>
|
|
<h2 id="help">Help<a class="headerlink" href="#help" title="Permanent link">¶</a></h2>
|
|
<p>Shows documentation about the supported flags.</p>
|
|
<pre><code> Argument: --help
|
|
Environment Variable: N/A
|
|
Type: N/A
|
|
Default: N/A
|
|
</code></pre>
|
|
|
|
<h2 id="cleanup">Cleanup<a class="headerlink" href="#cleanup" title="Permanent link">¶</a></h2>
|
|
<p>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.</p>
|
|
<pre><code> Argument: --cleanup
|
|
Environment Variable: WATCHTOWER_CLEANUP
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="remove_attached_volumes">Remove attached volumes<a class="headerlink" href="#remove_attached_volumes" title="Permanent link">¶</a></h2>
|
|
<p>Removes attached volumes after updating. When this flag is specified, watchtower will remove all attached volumes from the container before restarting with a new image. Use this option to force new volumes to be populated as containers are updated.</p>
|
|
<pre><code> Argument: --remove-volumes
|
|
Environment Variable: WATCHTOWER_REMOVE_VOLUMES
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="debug">Debug<a class="headerlink" href="#debug" title="Permanent link">¶</a></h2>
|
|
<p>Enable debug mode with verbose logging.</p>
|
|
<pre><code> Argument: --debug
|
|
Environment Variable: WATCHTOWER_DEBUG
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="docker_host">Docker host<a class="headerlink" href="#docker_host" title="Permanent link">¶</a></h2>
|
|
<p>Docker daemon socket to connect to. Can be pointed at a remote Docker host by specifying a TCP endpoint as "tcp://hostname:port".</p>
|
|
<pre><code> Argument: --host, -h
|
|
Environment Variable: DOCKER_HOST
|
|
Type: String
|
|
Default: "unix:///var/run/docker.sock"
|
|
</code></pre>
|
|
|
|
<h2 id="docker_api_version">Docker API version<a class="headerlink" href="#docker_api_version" title="Permanent link">¶</a></h2>
|
|
<p>The API version to use by the Docker client for connecting to the Docker daemon. The minimum supported version is 1.24.</p>
|
|
<pre><code> Argument: --api-version, -a
|
|
Environment Variable: DOCKER_API_VERSION
|
|
Type: String
|
|
Default: "1.24"
|
|
</code></pre>
|
|
|
|
<h2 id="include_stopped">Include stopped<a class="headerlink" href="#include_stopped" title="Permanent link">¶</a></h2>
|
|
<p>Will also include created and exited containers.</p>
|
|
<pre><code> Argument: --include-stopped
|
|
Environment Variable: WATCHTOWER_INCLUDE_STOPPED
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="revive_stopped">Revive stopped<a class="headerlink" href="#revive_stopped" title="Permanent link">¶</a></h2>
|
|
<p>Start any stopped containers that have had their image updated. This argument is only usable with the <code>--include-stopped</code> argument.</p>
|
|
<pre><code> Argument: --revive-stopped
|
|
Environment Variable: WATCHTOWER_REVIVE_STOPPED
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="poll_interval">Poll interval<a class="headerlink" href="#poll_interval" title="Permanent link">¶</a></h2>
|
|
<p>Poll interval (in seconds). This value controls how frequently watchtower will poll for new images.</p>
|
|
<pre><code> Argument: --interval, -i
|
|
Environment Variable: WATCHTOWER_POLL_INTERVAL
|
|
Type: Integer
|
|
Default: 300
|
|
</code></pre>
|
|
|
|
<h2 id="filter_by_enable_label">Filter by enable label<a class="headerlink" href="#filter_by_enable_label" title="Permanent link">¶</a></h2>
|
|
<p>Update containers that have a <code>com.centurylinklabs.watchtower.enable</code> label set to true.</p>
|
|
<pre><code> Argument: --label-enable
|
|
Environment Variable: WATCHTOWER_LABEL_ENABLE
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="without_updating_containers">Without updating containers<a class="headerlink" href="#without_updating_containers" title="Permanent link">¶</a></h2>
|
|
<p>Will only monitor for new images, not update the containers.</p>
|
|
<pre><code> Argument: --monitor-only
|
|
Environment Variable: WATCHTOWER_MONITOR_ONLY
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="without_restarting_containers">Without restarting containers<a class="headerlink" href="#without_restarting_containers" title="Permanent link">¶</a></h2>
|
|
<p>Do not restart containers after updating. This option can be useful when the start of the containers
|
|
is managed by an external system such as systemd.</p>
|
|
<pre><code> Argument: --no-restart
|
|
Environment Variable: WATCHTOWER_NO_RESTART
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="without_pulling_new_images">Without pulling new images<a class="headerlink" href="#without_pulling_new_images" title="Permanent link">¶</a></h2>
|
|
<p>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.</p>
|
|
<pre><code> Argument: --no-pull
|
|
Environment Variable: WATCHTOWER_NO_PULL
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="run_once">Run once<a class="headerlink" href="#run_once" title="Permanent link">¶</a></h2>
|
|
<p>Run an update attempt against a container name list one time immediately and exit.</p>
|
|
<pre><code> Argument: --run-once
|
|
Environment Variable: WATCHTOWER_RUN_ONCE
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
<h2 id="scheduling">Scheduling<a class="headerlink" href="#scheduling" title="Permanent link">¶</a></h2>
|
|
<p><a href="https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format">Cron expression</a> in 6 fields (rather than the traditional 5) which defines when and how often to check for new images. Either <code>--interval</code> or the schedule expression could be defined, but not both. An example: <code>--schedule "0 0 4 * * *"</code></p>
|
|
<pre><code> Argument: --schedule, -s
|
|
Environment Variable: WATCHTOWER_SCHEDULE
|
|
Type: String
|
|
Default: -
|
|
</code></pre>
|
|
|
|
<h2 id="wait_until_timeout">Wait until timeout<a class="headerlink" href="#wait_until_timeout" title="Permanent link">¶</a></h2>
|
|
<p>Timeout before the container is forcefully stopped. When set, this option will change the default (<code>10s</code>) wait time to the given value. An example: <code>--stop-timeout 30s</code> will set the timeout to 30 seconds.</p>
|
|
<pre><code> Argument: --stop-timeout
|
|
Environment Variable: WATCHTOWER_TIMEOUT
|
|
Type: Duration
|
|
Default: 10s
|
|
</code></pre>
|
|
|
|
<h2 id="tls_verification">TLS Verification<a class="headerlink" href="#tls_verification" title="Permanent link">¶</a></h2>
|
|
<p>Use TLS when connecting to the Docker socket and verify the server's certificate. See below for options used to configure notifications.</p>
|
|
<pre><code> Argument: --tlsverify
|
|
Environment Variable: DOCKER_TLS_VERIFY
|
|
Type: Boolean
|
|
Default: false
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-nav">
|
|
<nav class="md-footer-nav__inner md-grid">
|
|
|
|
<a href="../usage-overview/" title="Usage overview" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
|
<span class="md-flex__ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Previous
|
|
</span>
|
|
Usage overview
|
|
</span>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../notifications/" title="Notifications" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
|
<span class="md-flex__ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Next
|
|
</span>
|
|
Notifications
|
|
</span>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
powered by
|
|
<a href="https://www.mkdocs.org">MkDocs</a>
|
|
and
|
|
<a href="https://squidfunk.github.io/mkdocs-material/">
|
|
Material for MkDocs</a>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
|
|
<script src="../assets/javascripts/application.808e90bb.js"></script>
|
|
|
|
<script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
|
|
|
|
|
|
</body>
|
|
</html> |