archive
/
watchtower
mirror of https://github.com/containrrr/watchtower
1
0
Fork 0
Code Releases Activity
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.
dependabot/go_modules/github.com/docker/cli-26.0.0incompatible
dependabot/go_modules/github.com/docker/docker-26.0.0incompatible
dependabot/github_actions/dominikh/staticcheck-action-1.3.1
dependabot/go_modules/github.com/docker/docker-24.0.9incompatible
dependabot/go_modules/github.com/onsi/gomega-1.32.0
dependabot/github_actions/docker/login-action-3.1.0
dependabot/go_modules/google.golang.org/protobuf-1.33.0
dependabot/go_modules/golang.org/x/net-0.22.0
dependabot/github_actions/hmarr/auto-approve-action-4
dependabot/github_actions/codecov/codecov-action-4
dependabot/docker/dockerfiles/alpine-3.19.1
dependabot/go_modules/github.com/docker/go-connections-0.5.0
refactor-update
main
dependabot/github_actions/actions/setup-go-5
gh-pages
feat/extended-api
feat/opencontainers-labels
feat/registry-client
fix/snakeswap
fix/image-tag-from-hash
feat/api-report
feature/http-overhaul
feat/graph-updates
fix/avoid-rate-limits
feature/urls-from-file
v1.7.0
v1.6.0
v1.5.3
v1.5.2
v1.3.0
v1.1.6
v1.1.5
v0.1.0
CenturyLink
v0.1.1
v0.2.0
v0.2.1
v0.2.2
v0.3.0
v0.3.1
v0.3.10
v0.3.11
v0.3.2
v0.3.3
v0.3.4
v0.3.5
v0.3.6
v0.3.7
v0.3.8
v0.3.9
v1.0.0
v1.0.1
v1.0.2
v1.0.3
v1.1.0
v1.1.1
v1.1.2
v1.1.3
v1.1.4
v1.2.0
v1.2.1
v1.4.0
v1.5.0
v1.5.1
v1.7.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ee86a7b3bf'
${ noResults }
watchtower/arguments/index.html

1544 lines
52 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://containrrr.dev/watchtower/arguments/">
<link rel="prev" href="../usage-overview/">
<link rel="next" href="../notifications/">
<link rel="icon" href="../images/favicon.ico">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.8">
<title>Arguments - Watchtower</title>
<link rel="stylesheet" href="../assets/stylesheets/main.4b4a2bd9.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.356b1318.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../stylesheets/theme.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="containrrr" data-md-color-primary="indigo" data-md-color-accent="indigo">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<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" for="__drawer"></label>
<div data-md-component="skip">
<a href="#secretsfiles" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Watchtower" class="md-header__button md-logo" aria-label="Watchtower" data-md-component="logo">
<img src="../images/logo-450px.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Watchtower
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Arguments
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="containrrr" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="containrrr-dark" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
</label>
</form>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</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" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Watchtower" class="md-nav__button md-logo" aria-label="Watchtower" data-md-component="logo">
<img src="../images/logo-450px.png" alt="logo">
</a>
Watchtower
</label>
<div class="md-nav__source">
<a href="https://github.com/containrrr/watchtower/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></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=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../introduction/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../usage-overview/" class="md-nav__link">
<span class="md-ellipsis">
Usage overview
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Arguments
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Arguments
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#secretsfiles" class="md-nav__link">
Secrets/Files
</a>
<nav class="md-nav" aria-label="Secrets/Files">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example_docker-compose_usage" class="md-nav__link">
Example docker-compose usage
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#help" class="md-nav__link">
Help
</a>
</li>
<li class="md-nav__item">
<a href="#time_zone" class="md-nav__link">
Time Zone
</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_anonymous_volumes" class="md-nav__link">
Remove anonymous 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="#trace" class="md-nav__link">
Trace
</a>
</li>
<li class="md-nav__item">
<a href="#maximum_log_level" class="md-nav__link">
Maximum log level
</a>
</li>
<li class="md-nav__item">
<a href="#logging_format" class="md-nav__link">
Logging format
</a>
</li>
<li class="md-nav__item">
<a href="#ansi_colors" class="md-nav__link">
ANSI colors
</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_restarting" class="md-nav__link">
Include restarting
</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="#filter_by_disable_label" class="md-nav__link">
Filter by disable label
</a>
</li>
<li class="md-nav__item">
<a href="#filter_by_disabling_specific_container_names" class="md-nav__link">
Filter by disabling specific container names
</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="#with_label_taking_precedence_over_arguments" class="md-nav__link">
With label taking precedence over arguments
</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="#without_sending_a_startup_message" class="md-nav__link">
Without sending a startup message
</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="#http_api_mode" class="md-nav__link">
HTTP API Mode
</a>
</li>
<li class="md-nav__item">
<a href="#http_api_token" class="md-nav__link">
HTTP API Token
</a>
</li>
<li class="md-nav__item">
<a href="#http_api_periodic_polls" class="md-nav__link">
HTTP API periodic polls
</a>
</li>
<li class="md-nav__item">
<a href="#filter_by_scope" class="md-nav__link">
Filter by scope
</a>
</li>
<li class="md-nav__item">
<a href="#http_api_metrics" class="md-nav__link">
HTTP API Metrics
</a>
</li>
<li class="md-nav__item">
<a href="#scheduling" class="md-nav__link">
Scheduling
</a>
</li>
<li class="md-nav__item">
<a href="#rolling_restart" class="md-nav__link">
Rolling restart
</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>
<li class="md-nav__item">
<a href="#head_failure_warnings" class="md-nav__link">
HEAD failure warnings
</a>
</li>
<li class="md-nav__item">
<a href="#health_check" class="md-nav__link">
Health check
</a>
</li>
<li class="md-nav__item">
<a href="#programatic_output_porcelain" class="md-nav__link">
Programatic Output (porcelain)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../notifications/" class="md-nav__link">
<span class="md-ellipsis">
Notifications
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../container-selection/" class="md-nav__link">
<span class="md-ellipsis">
Container selection
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../private-registries/" class="md-nav__link">
<span class="md-ellipsis">
Private registries
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../linked-containers/" class="md-nav__link">
<span class="md-ellipsis">
Linked containers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../remote-hosts/" class="md-nav__link">
<span class="md-ellipsis">
Remote hosts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../secure-connections/" class="md-nav__link">
<span class="md-ellipsis">
Secure connections
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../stop-signals/" class="md-nav__link">
<span class="md-ellipsis">
Stop signals
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../lifecycle-hooks/" class="md-nav__link">
<span class="md-ellipsis">
Lifecycle hooks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../running-multiple-instances/" class="md-nav__link">
<span class="md-ellipsis">
Running multiple instances
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../http-api-mode/" class="md-nav__link">
<span class="md-ellipsis">
HTTP API Mode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../metrics/" class="md-nav__link">
<span class="md-ellipsis">
Metrics
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#secretsfiles" class="md-nav__link">
Secrets/Files
</a>
<nav class="md-nav" aria-label="Secrets/Files">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example_docker-compose_usage" class="md-nav__link">
Example docker-compose usage
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#help" class="md-nav__link">
Help
</a>
</li>
<li class="md-nav__item">
<a href="#time_zone" class="md-nav__link">
Time Zone
</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_anonymous_volumes" class="md-nav__link">
Remove anonymous 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="#trace" class="md-nav__link">
Trace
</a>
</li>
<li class="md-nav__item">
<a href="#maximum_log_level" class="md-nav__link">
Maximum log level
</a>
</li>
<li class="md-nav__item">
<a href="#logging_format" class="md-nav__link">
Logging format
</a>
</li>
<li class="md-nav__item">
<a href="#ansi_colors" class="md-nav__link">
ANSI colors
</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_restarting" class="md-nav__link">
Include restarting
</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="#filter_by_disable_label" class="md-nav__link">
Filter by disable label
</a>
</li>
<li class="md-nav__item">
<a href="#filter_by_disabling_specific_container_names" class="md-nav__link">
Filter by disabling specific container names
</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="#with_label_taking_precedence_over_arguments" class="md-nav__link">
With label taking precedence over arguments
</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="#without_sending_a_startup_message" class="md-nav__link">
Without sending a startup message
</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="#http_api_mode" class="md-nav__link">
HTTP API Mode
</a>
</li>
<li class="md-nav__item">
<a href="#http_api_token" class="md-nav__link">
HTTP API Token
</a>
</li>
<li class="md-nav__item">
<a href="#http_api_periodic_polls" class="md-nav__link">
HTTP API periodic polls
</a>
</li>
<li class="md-nav__item">
<a href="#filter_by_scope" class="md-nav__link">
Filter by scope
</a>
</li>
<li class="md-nav__item">
<a href="#http_api_metrics" class="md-nav__link">
HTTP API Metrics
</a>
</li>
<li class="md-nav__item">
<a href="#scheduling" class="md-nav__link">
Scheduling
</a>
</li>
<li class="md-nav__item">
<a href="#rolling_restart" class="md-nav__link">
Rolling restart
</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>
<li class="md-nav__item">
<a href="#head_failure_warnings" class="md-nav__link">
HEAD failure warnings
</a>
</li>
<li class="md-nav__item">
<a href="#health_check" class="md-nav__link">
Health check
</a>
</li>
<li class="md-nav__item">
<a href="#programatic_output_porcelain" class="md-nav__link">
Programatic Output (porcelain)
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<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>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--name<span class="w"> </span>watchtower<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-v<span class="w"> </span>/var/run/docker.sock:/var/run/docker.sock<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>containrrr/watchtower<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>nginx<span class="w"> </span>redis
</code></pre></div>
<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>
<div class="highlight"><pre><span></span><code>$<span class="w"> </span>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-v<span class="w"> </span>/var/run/docker.sock:/var/run/docker.sock<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>containrrr/watchtower<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--run-once<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>nginx<span class="w"> </span>redis
</code></pre></div>
<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="secretsfiles">Secrets/Files<a class="headerlink" href="#secretsfiles" title="Permanent link">&para;</a></h2>
<p>Some arguments can also reference a file, in which case the contents of the file are used as the value.
This can be used to avoid putting secrets in the configuration file or command line.</p>
<p>The following arguments are currently supported (including their corresponding <code>WATCHTOWER_</code> environment variables):
- <code>notification-url</code>
- <code>notification-email-server-password</code>
- <code>notification-slack-hook-url</code>
- <code>notification-msteams-hook</code>
- <code>notification-gotify-token</code>
- <code>http-api-token</code></p>
<h3 id="example_docker-compose_usage">Example docker-compose usage<a class="headerlink" href="#example_docker-compose_usage" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="nt">secrets</span><span class="p">:</span>
<span class="w"> </span><span class="nt">access_token</span><span class="p">:</span>
<span class="w"> </span><span class="nt">file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access_token</span>
<span class="nt">services</span><span class="p">:</span>
<span class="w"> </span><span class="nt">watchtower</span><span class="p">:</span>
<span class="w"> </span><span class="nt">secrets</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access_token</span>
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">WATCHTOWER_HTTP_API_TOKEN=/run/secrets/access_token</span>
</code></pre></div>
<h2 id="help">Help<a class="headerlink" href="#help" title="Permanent link">&para;</a></h2>
<p>Shows documentation about the supported flags.</p>
<div class="highlight"><pre><span></span><code> Argument: --help
Environment Variable: N/A
Type: N/A
Default: N/A
</code></pre></div>
<h2 id="time_zone">Time Zone<a class="headerlink" href="#time_zone" title="Permanent link">&para;</a></h2>
<p>Sets the time zone to be used by WatchTower's logs and the optional Cron scheduling argument (--schedule). If this environment variable is not set, Watchtower will use the default time zone: UTC.
To find out the right value, see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">this list</a>, find your location and use the value in <em>TZ Database Name</em>, e.g <em>Europe/Rome</em>. The timezone can alternatively be set by volume mounting your hosts /etc/localtime file. <code>-v /etc/localtime:/etc/localtime:ro</code></p>
<div class="highlight"><pre><span></span><code> Argument: N/A
Environment Variable: TZ
Type: String
Default: &quot;UTC&quot;
</code></pre></div>
<h2 id="cleanup">Cleanup<a class="headerlink" href="#cleanup" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --cleanup
Environment Variable: WATCHTOWER_CLEANUP
Type: Boolean
Default: false
</code></pre></div>
<h2 id="remove_anonymous_volumes">Remove anonymous volumes<a class="headerlink" href="#remove_anonymous_volumes" title="Permanent link">&para;</a></h2>
<p>Removes anonymous volumes after updating. When this flag is specified, watchtower will remove all anonymous volumes from the container before restarting with a new image. Named volumes will not be removed!</p>
<div class="highlight"><pre><span></span><code> Argument: --remove-volumes
Environment Variable: WATCHTOWER_REMOVE_VOLUMES
Type: Boolean
Default: false
</code></pre></div>
<h2 id="debug">Debug<a class="headerlink" href="#debug" title="Permanent link">&para;</a></h2>
<p>Enable debug mode with verbose logging.</p>
<div class="admonition note">
<p class="admonition-title">Notes</p>
<p>Alias for <code>--log-level debug</code>. See <a href="#maximum-log-level">Maximum log level</a>.<br />
Does <em>not</em> take an argument when used as an argument. Using <code>--debug true</code> will <strong>not</strong> work.</p>
</div>
<div class="highlight"><pre><span></span><code> Argument: --debug, -d
Environment Variable: WATCHTOWER_DEBUG
Type: Boolean
Default: false
</code></pre></div>
<h2 id="trace">Trace<a class="headerlink" href="#trace" title="Permanent link">&para;</a></h2>
<p>Enable trace mode with very verbose logging. Caution: exposes credentials!</p>
<div class="admonition note">
<p class="admonition-title">Notes</p>
<p>Alias for <code>--log-level trace</code>. See <a href="#maximum-log-level">Maximum log level</a>.<br />
Does <em>not</em> take an argument when used as an argument. Using <code>--trace true</code> will <strong>not</strong> work.</p>
</div>
<div class="highlight"><pre><span></span><code> Argument: --trace
Environment Variable: WATCHTOWER_TRACE
Type: Boolean
Default: false
</code></pre></div>
<h2 id="maximum_log_level">Maximum log level<a class="headerlink" href="#maximum_log_level" title="Permanent link">&para;</a></h2>
<p>The maximum log level that will be written to STDERR (shown in <code>docker log</code> when used in a container).</p>
<div class="highlight"><pre><span></span><code> Argument: --log-level
Environment Variable: WATCHTOWER_LOG_LEVEL
Possible values: panic, fatal, error, warn, info, debug or trace
Default: info
</code></pre></div>
<h2 id="logging_format">Logging format<a class="headerlink" href="#logging_format" title="Permanent link">&para;</a></h2>
<p>Sets what logging format to use for console output.</p>
<div class="highlight"><pre><span></span><code> Argument: --log-format, -l
Environment Variable: WATCHTOWER_LOG_FORMAT
Possible values: Auto, LogFmt, Pretty or JSON
Default: Auto
</code></pre></div>
<h2 id="ansi_colors">ANSI colors<a class="headerlink" href="#ansi_colors" title="Permanent link">&para;</a></h2>
<p>Disable ANSI color escape codes in log output.</p>
<div class="highlight"><pre><span></span><code> Argument: --no-color
Environment Variable: NO_COLOR
Type: Boolean
Default: false
</code></pre></div>
<h2 id="docker_host">Docker host<a class="headerlink" href="#docker_host" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --host, -H
Environment Variable: DOCKER_HOST
Type: String
Default: &quot;unix:///var/run/docker.sock&quot;
</code></pre></div>
<h2 id="docker_api_version">Docker API version<a class="headerlink" href="#docker_api_version" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --api-version, -a
Environment Variable: DOCKER_API_VERSION
Type: String
Default: &quot;1.24&quot;
</code></pre></div>
<h2 id="include_restarting">Include restarting<a class="headerlink" href="#include_restarting" title="Permanent link">&para;</a></h2>
<p>Will also include restarting containers.</p>
<div class="highlight"><pre><span></span><code> Argument: --include-restarting
Environment Variable: WATCHTOWER_INCLUDE_RESTARTING
Type: Boolean
Default: false
</code></pre></div>
<h2 id="include_stopped">Include stopped<a class="headerlink" href="#include_stopped" title="Permanent link">&para;</a></h2>
<p>Will also include created and exited containers.</p>
<div class="highlight"><pre><span></span><code> Argument: --include-stopped, -S
Environment Variable: WATCHTOWER_INCLUDE_STOPPED
Type: Boolean
Default: false
</code></pre></div>
<h2 id="revive_stopped">Revive stopped<a class="headerlink" href="#revive_stopped" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --revive-stopped
Environment Variable: WATCHTOWER_REVIVE_STOPPED
Type: Boolean
Default: false
</code></pre></div>
<h2 id="poll_interval">Poll interval<a class="headerlink" href="#poll_interval" title="Permanent link">&para;</a></h2>
<p>Poll interval (in seconds). This value controls how frequently watchtower will poll for new images. Either <code>--schedule</code> or a poll interval can be defined, but not both.</p>
<div class="highlight"><pre><span></span><code> Argument: --interval, -i
Environment Variable: WATCHTOWER_POLL_INTERVAL
Type: Integer
Default: 86400 (24 hours)
</code></pre></div>
<h2 id="filter_by_enable_label">Filter by enable label<a class="headerlink" href="#filter_by_enable_label" title="Permanent link">&para;</a></h2>
<p>Monitor and update containers that have a <code>com.centurylinklabs.watchtower.enable</code> label set to true.</p>
<div class="highlight"><pre><span></span><code> Argument: --label-enable
Environment Variable: WATCHTOWER_LABEL_ENABLE
Type: Boolean
Default: false
</code></pre></div>
<h2 id="filter_by_disable_label">Filter by disable label<a class="headerlink" href="#filter_by_disable_label" title="Permanent link">&para;</a></h2>
<p><strong>Do not</strong> Monitor and update containers that have <code>com.centurylinklabs.watchtower.enable</code> label set to false and
no <code>--label-enable</code> argument is passed. Note that only one or the other (targeting by enable label) can be
used at the same time to target containers.</p>
<h2 id="filter_by_disabling_specific_container_names">Filter by disabling specific container names<a class="headerlink" href="#filter_by_disabling_specific_container_names" title="Permanent link">&para;</a></h2>
<p>Monitor and update containers whose names are not in a given set of names.</p>
<p>This can be used to exclude specific containers, when setting labels is not an option.
The listed containers will be excluded even if they have the enable filter set to true.</p>
<div class="highlight"><pre><span></span><code> Argument: --disable-containers, -x
Environment Variable: WATCHTOWER_DISABLE_CONTAINERS
Type: Comma- or space-separated string list
Default: &quot;&quot;
</code></pre></div>
<h2 id="without_updating_containers">Without updating containers<a class="headerlink" href="#without_updating_containers" title="Permanent link">&para;</a></h2>
<p>Will only monitor for new images, send notifications and invoke
the <a href="https://containrrr.dev/watchtower/lifecycle-hooks/">pre-check/post-check hooks</a>, but will <strong>not</strong> update the
containers.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Due to Docker API limitations the latest image will still be pulled from the registry.
The HEAD digest checks allows watchtower to skip pulling when there are no changes, but to know <em>what</em> has changed it
will still do a pull whenever the repository digest doesn't match the local image digest.</p>
</div>
<div class="highlight"><pre><span></span><code> Argument: --monitor-only
Environment Variable: WATCHTOWER_MONITOR_ONLY
Type: Boolean
Default: false
</code></pre></div>
<p>Note that monitor-only can also be specified on a per-container basis with the <code>com.centurylinklabs.watchtower.monitor-only</code> label set on those containers.</p>
<p>See <a href="#With-label-taking-precedence-over-arguments">With label taking precedence over arguments</a> for behavior when both argument and label are set</p>
<h2 id="with_label_taking_precedence_over_arguments">With label taking precedence over arguments<a class="headerlink" href="#with_label_taking_precedence_over_arguments" title="Permanent link">&para;</a></h2>
<p>By default, arguments will take precedence over labels. This means that if you set <code>WATCHTOWER_MONITOR_ONLY</code> to true or use <code>--monitor-only</code>, a container with <code>com.centurylinklabs.watchtower.monitor-only</code> set to false will not be updated. If you set <code>WATCHTOWER_LABEL_TAKE_PRECEDENCE</code> to true or use <code>--label-take-precedence</code>, then the container will also be updated. This also apply to the no pull option. if you set <code>WATCHTOWER_NO_PULL</code> to true or use <code>--no-pull</code>, a container with <code>com.centurylinklabs.watchtower.no-pull</code> set to false will not pull the new image. If you set <code>WATCHTOWER_LABEL_TAKE_PRECEDENCE</code> to true or use <code>--label-take-precedence</code>, then the container will pull image</p>
<div class="highlight"><pre><span></span><code> Argument: --label-take-precedence
Environment Variable: WATCHTOWER_LABEL_TAKE_PRECEDENCE
Type: Boolean
Default: false
</code></pre></div>
<h2 id="without_restarting_containers">Without restarting containers<a class="headerlink" href="#without_restarting_containers" title="Permanent link">&para;</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.
<div class="highlight"><pre><span></span><code> Argument: --no-restart
Environment Variable: WATCHTOWER_NO_RESTART
Type: Boolean
Default: false
</code></pre></div></p>
<h2 id="without_pulling_new_images">Without pulling new images<a class="headerlink" href="#without_pulling_new_images" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --no-pull
Environment Variable: WATCHTOWER_NO_PULL
Type: Boolean
Default: false
</code></pre></div>
<p>Note that no-pull can also be specified on a per-container basis with the
<code>com.centurylinklabs.watchtower.no-pull</code> label set on those containers.</p>
<p>See <a href="#With-label-taking-precedence-over-arguments">With label taking precedence over arguments</a> for behavior when both argument and label are set</p>
<h2 id="without_sending_a_startup_message">Without sending a startup message<a class="headerlink" href="#without_sending_a_startup_message" title="Permanent link">&para;</a></h2>
<p>Do not send a message after watchtower started. Otherwise there will be an info-level notification.</p>
<div class="highlight"><pre><span></span><code> Argument: --no-startup-message
Environment Variable: WATCHTOWER_NO_STARTUP_MESSAGE
Type: Boolean
Default: false
</code></pre></div>
<h2 id="run_once">Run once<a class="headerlink" href="#run_once" title="Permanent link">&para;</a></h2>
<p>Run an update attempt against a container name list one time immediately and exit.</p>
<div class="highlight"><pre><span></span><code> Argument: --run-once, -R
Environment Variable: WATCHTOWER_RUN_ONCE
Type: Boolean
Default: false
</code></pre></div>
<h2 id="http_api_mode">HTTP API Mode<a class="headerlink" href="#http_api_mode" title="Permanent link">&para;</a></h2>
<p>Runs Watchtower in HTTP API mode, only allowing image updates to be triggered by an HTTP request.
For details see <a href="https://containrrr.dev/watchtower/http-api-mode">HTTP API</a>.</p>
<div class="highlight"><pre><span></span><code> Argument: --http-api-update
Environment Variable: WATCHTOWER_HTTP_API_UPDATE
Type: Boolean
Default: false
</code></pre></div>
<h2 id="http_api_token">HTTP API Token<a class="headerlink" href="#http_api_token" title="Permanent link">&para;</a></h2>
<p>Sets an authentication token to HTTP API requests.
Can also reference a file, in which case the contents of the file are used.</p>
<div class="highlight"><pre><span></span><code> Argument: --http-api-token
Environment Variable: WATCHTOWER_HTTP_API_TOKEN
Type: String
Default: -
</code></pre></div>
<h2 id="http_api_periodic_polls">HTTP API periodic polls<a class="headerlink" href="#http_api_periodic_polls" title="Permanent link">&para;</a></h2>
<p>Keep running periodic updates if the HTTP API mode is enabled, otherwise the HTTP API would prevent periodic polls. </p>
<div class="highlight"><pre><span></span><code> Argument: --http-api-periodic-polls
Environment Variable: WATCHTOWER_HTTP_API_PERIODIC_POLLS
Type: Boolean
Default: false
</code></pre></div>
<h2 id="filter_by_scope">Filter by scope<a class="headerlink" href="#filter_by_scope" title="Permanent link">&para;</a></h2>
<p>Update containers that have a <code>com.centurylinklabs.watchtower.scope</code> label set with the same value as the given argument.
This enables <a href="https://containrrr.dev/watchtower/running-multiple-instances">running multiple instances</a>.</p>
<div class="admonition note">
<p class="admonition-title">Filter by lack of scope</p>
<p>If you want other instances of watchtower to ignore the scoped containers, set this argument to <code>none</code>.
When omitted, watchtower will update all containers regardless of scope.</p>
</div>
<div class="highlight"><pre><span></span><code> Argument: --scope
Environment Variable: WATCHTOWER_SCOPE
Type: String
Default: -
</code></pre></div>
<h2 id="http_api_metrics">HTTP API Metrics<a class="headerlink" href="#http_api_metrics" title="Permanent link">&para;</a></h2>
<p>Enables a metrics endpoint, exposing prometheus metrics via HTTP. See <a href="../metrics/">Metrics</a> for details. </p>
<div class="highlight"><pre><span></span><code> Argument: --http-api-metrics
Environment Variable: WATCHTOWER_HTTP_API_METRICS
Type: Boolean
Default: false
</code></pre></div>
<h2 id="scheduling">Scheduling<a class="headerlink" href="#scheduling" title="Permanent link">&para;</a></h2>
<p><a href="https://pkg.go.dev/github.com/robfig/cron@v1.2.0?tab=doc#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
can be defined, but not both. An example: <code>--schedule "0 0 4 * * *"</code></p>
<div class="highlight"><pre><span></span><code> Argument: --schedule, -s
Environment Variable: WATCHTOWER_SCHEDULE
Type: String
Default: -
</code></pre></div>
<h2 id="rolling_restart">Rolling restart<a class="headerlink" href="#rolling_restart" title="Permanent link">&para;</a></h2>
<p>Restart one image at time instead of stopping and starting all at once. Useful in conjunction with lifecycle hooks
to implement zero-downtime deploy.</p>
<div class="highlight"><pre><span></span><code> Argument: --rolling-restart
Environment Variable: WATCHTOWER_ROLLING_RESTART
Type: Boolean
Default: false
</code></pre></div>
<h2 id="wait_until_timeout">Wait until timeout<a class="headerlink" href="#wait_until_timeout" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --stop-timeout
Environment Variable: WATCHTOWER_TIMEOUT
Type: Duration
Default: 10s
</code></pre></div>
<h2 id="tls_verification">TLS Verification<a class="headerlink" href="#tls_verification" title="Permanent link">&para;</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>
<div class="highlight"><pre><span></span><code> Argument: --tlsverify
Environment Variable: DOCKER_TLS_VERIFY
Type: Boolean
Default: false
</code></pre></div>
<h2 id="head_failure_warnings">HEAD failure warnings<a class="headerlink" href="#head_failure_warnings" title="Permanent link">&para;</a></h2>
<p>When to warn about HEAD pull requests failing. Auto means that it will warn when the registry is known to handle the
requests and may rate limit pull requests (mainly docker.io).</p>
<div class="highlight"><pre><span></span><code> Argument: --warn-on-head-failure
Environment Variable: WATCHTOWER_WARN_ON_HEAD_FAILURE
Possible values: always, auto, never
Default: auto
</code></pre></div>
<h2 id="health_check">Health check<a class="headerlink" href="#health_check" title="Permanent link">&para;</a></h2>
<p>Returns a success exit code to enable usage with docker <code>HEALTHCHECK</code>. This check is naive and only returns checks whether there is another process running inside the container, as it is the only known form of failure state for watchtowers container.</p>
<div class="admonition note">
<p class="admonition-title">Only for HEALTHCHECK use</p>
<p>Never put this on the main container executable command line as it is only meant to be run from docker HEALTHCHECK.</p>
</div>
<div class="highlight"><pre><span></span><code> Argument: --health-check
</code></pre></div>
<h2 id="programatic_output_porcelain">Programatic Output (porcelain)<a class="headerlink" href="#programatic_output_porcelain" title="Permanent link">&para;</a></h2>
<p>Writes the session results to STDOUT using a stable, machine-readable format (indicated by the argument VERSION). </p>
<p>Alias for:</p>
<div class="highlight"><pre><span></span><code> --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: -
</code></pre></div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.81fa17fe.min.js"></script>
</body>
</html>
View Git Blame Copy Permalink