README
¶
Watchtower
Automate Docker container image updates
Quick Start
With watchtower you can update the running version of your containerized app simply by pushing a new image to the Docker Hub or your own image registry.
Watchtower will pull down your new image, gracefully shut down your existing container and restart it with the same options that were used when it was deployed initially. Run the watchtower container with the following command:
$ docker run --detach \
--name watchtower \
--volume /var/run/docker.sock:/var/run/docker.sock \
nickfedor/watchtower
Watchtower is intended to be used in homelabs, media centers, local dev environments, and similar. We do not recommend using Watchtower in a commercial or production environment. If that is you, you should be looking into using Kubernetes enabled with CI/CD, such as onedr0p's Talos Linux with FluxCD setup here.
⚠️ Note: It is recommended to use the latest version of Docker. You can check your host's Docker version using the CLI command docker version.
This version of Watchtower has been tested to support v1.43 and higher; however, don't be surprised if you experience unexpected behavior when attempting to use newer features on older versions of Docker.
This version autonegotiates the API version by default. If the DOCKER_API_VERSION variable is explicitly set, Watchtower validates the version and falls back to autonegotiation on failure.
Supported Architectures
Watchtower supports the following architectures for its Docker images:
- amd64
- i386
- armhf
- arm64v8
- riscv64
Documentation
The full documentation is available at https://watchtower.nickfedor.com/.
Star History
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd contains the command-line interface (CLI) definitions and execution logic for Watchtower.
|
Package cmd contains the command-line interface (CLI) definitions and execution logic for Watchtower. |
|
examples
|
|
|
lifecycle-hooks/synology-stop
command
Package synology-stop is a Watchtower "stop" lifecycle hook that performs graceful Docker container shutdown on Synology DSM using the official Web API.
|
Package synology-stop is a Watchtower "stop" lifecycle hook that performs graceful Docker container shutdown on Synology DSM using the official Web API. |
|
internal
|
|
|
actions
Package actions provides core logic for Watchtower’s container update operations.
|
Package actions provides core logic for Watchtower’s container update operations. |
|
actions/mocks
Package mocks provides mock implementations for testing Watchtower components.
|
Package mocks provides mock implementations for testing Watchtower components. |
|
api
Package api provides application-specific HTTP API orchestration for Watchtower, coordinating the setup and management of API endpoints with business logic integration.
|
Package api provides application-specific HTTP API orchestration for Watchtower, coordinating the setup and management of API endpoints with business logic integration. |
|
config
Package config provides configuration structures for Watchtower's core operations.
|
Package config provides configuration structures for Watchtower's core operations. |
|
flags
Package flags manages command-line flags and environment variables for Watchtower configuration.
|
Package flags manages command-line flags and environment variables for Watchtower configuration. |
|
logging
Package logging provides functions for logging startup information and configuring startup logging in Watchtower.
|
Package logging provides functions for logging startup information and configuring startup logging in Watchtower. |
|
scheduling
Package scheduling provides functionality for scheduling and executing container updates in Watchtower.
|
Package scheduling provides functionality for scheduling and executing container updates in Watchtower. |
|
util
Package util provides utility functions for Watchtower operations.
|
Package util provides utility functions for Watchtower operations. |
|
pkg
|
|
|
api
Package api provides an HTTP server for Watchtower’s API endpoints.
|
Package api provides an HTTP server for Watchtower’s API endpoints. |
|
api/update
Package update provides an HTTP API handler for triggering Watchtower container updates.
|
Package update provides an HTTP API handler for triggering Watchtower container updates. |
|
compose
Package compose provides functionality for handling Docker Compose-specific logic, including parsing depends_on labels and extracting service names for dependency management.
|
Package compose provides functionality for handling Docker Compose-specific logic, including parsing depends_on labels and extracting service names for dependency management. |
|
container
Package container provides functionality for managing Docker containers within Watchtower.
|
Package container provides functionality for managing Docker containers within Watchtower. |
|
filters
Package filters provides filtering logic for Watchtower containers.
|
Package filters provides filtering logic for Watchtower containers. |
|
lifecycle
Package lifecycle manages execution of lifecycle hooks for Watchtower containers.
|
Package lifecycle manages execution of lifecycle hooks for Watchtower containers. |
|
metrics
Package metrics provides tracking and exposure of Watchtower scan metrics.
|
Package metrics provides tracking and exposure of Watchtower scan metrics. |
|
notifications
Package notifications provides notification templates and utilities for Watchtower container updates.
|
Package notifications provides notification templates and utilities for Watchtower container updates. |
|
notifications/preview
Package preview provides the core functionality for rendering notification template previews in Watchtower.
|
Package preview provides the core functionality for rendering notification template previews in Watchtower. |
|
notifications/preview/data
Package data provides utilities for generating simulated data used in the Watchtower template preview tool.
|
Package data provides utilities for generating simulated data used in the Watchtower template preview tool. |
|
notifications/templates
Package templates provides utility functions for use in Watchtower notification templates.
|
Package templates provides utility functions for use in Watchtower notification templates. |
|
registry
Package registry provides functionality for interacting with container registries in Watchtower.
|
Package registry provides functionality for interacting with container registries in Watchtower. |
|
registry/auth
Package auth provides functionality for authenticating with container registries.
|
Package auth provides functionality for authenticating with container registries. |
|
registry/digest
Package digest provides functionality for retrieving and comparing Docker image digests in Watchtower.
|
Package digest provides functionality for retrieving and comparing Docker image digests in Watchtower. |
|
registry/manifest
Package manifest provides functionality for constructing URLs to access container image manifests in Watchtower.
|
Package manifest provides functionality for constructing URLs to access container image manifests in Watchtower. |
|
session
Package session manages container states and reporting during a Watchtower update session.
|
Package session manages container states and reporting during a Watchtower update session. |
|
sorter
Package sorter provides sorting functionality for Watchtower containers.
|
Package sorter provides sorting functionality for Watchtower containers. |
|
sorter/mocks
Package mocks provides mock implementations for container interfaces used in testing.
|
Package mocks provides mock implementations for container interfaces used in testing. |
|
types
Package types provides core types for Watchtower operations.
|
Package types provides core types for Watchtower operations. |
|
tools
|
|
|
tplprev
command
|
