watchtower README

The project's README from github.com/containrrr/watchtower. As one markdown file: README.md.

⚠️ This project is no longer maintained

See https://github.com/containrrr/watchtower/discussions/2135 for details.


Watchtower

A process for automating Docker container base image updates.

Circle CI codecov GoDoc Go Report Card latest version Apache-2.0 License Codacy Badge All Contributors Pulls from DockerHub

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 \
    containrrr/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. If that feels like too big a step for you, please look into solutions like MicroK8s and k3s that take away a lot of the toil of running a Kubernetes cluster.

Documentation

The full documentation is available at https://containrrr.dev/watchtower.

Contributors

Thanks goes to these wonderful people (emoji key):

nils måsén
nils måsén

💻 📖 🚧 👀
Simon Aronsson
Simon Aronsson

💻 📖 🚧 👀
James
James

⚠️ 🤔
Florian
Florian

👀 📖
Brian DeHamer
Brian DeHamer

💻 🚧
Ross Cadogan
Ross Cadogan

💻
stffabi
stffabi

💻 🚧
Austin
Austin

📖
David Gardner
David Gardner

👀 📖
Tanguy ⧓ Herrmann
Tanguy ⧓ Herrmann

💻
Rodrigo Damazio Bovendorp
Rodrigo Damazio Bovendorp

💻 📖
Ryan Kuba
Ryan Kuba

🚇
cnrmck
cnrmck

📖
Harry Walter
Harry Walter

💻
Robotex
Robotex

📖
Gerald Pape
Gerald Pape

📖
fomk
fomk

💻
Sven Gottwald
Sven Gottwald

🚇
techknowlogick
techknowlogick

💻
waja
waja

📖
Scott Albertson
Scott Albertson

📖
Jason Huddleston
Jason Huddleston

📖
Napster
Napster

💻
Maxim
Maxim

💻 📖
Max Schmitt
Max Schmitt

📖
cron410
cron410

📖
Paulo Henrique
Paulo Henrique

📖
Kaleb Elwert
Kaleb Elwert

📖
Bill Butler
Bill Butler

📖
Mario Tacke
Mario Tacke

💻
Mark Woodbridge
Mark Woodbridge

💻
Ansem93
Ansem93

📖
Luka Peschke
Luka Peschke

💻 📖
Zois Pagoulatos
Zois Pagoulatos

💻 👀 🚧
Alexandre Menif
Alexandre Menif

💻
Andrey
Andrey

📖
Armando Lüscher
Armando Lüscher

📖
Ryan Budke
Ryan Budke

📖
Kaloyan Raev
Kaloyan Raev

💻 ⚠️
sixth
sixth

📖
Gina Häußge
Gina Häußge

💻
Max H.
Max H.

💻
Jungkook Park
Jungkook Park

📖
Jan Kristof Nidzwetzki
Jan Kristof Nidzwetzki

📖
lukas
lukas

watchtower (containrrr/watchtower)

continuous-deployment
Searching Database…

24.6K ·GitHub
archived
What is this?Watchtower automates Docker container updates: push a new image to your registry and it pulls it, stops the old container and starts the new version in its place.
How does it update my containers — will my settings survive?It pulls the new image, gracefully shuts down your running container and restarts it with the same options used at initial deployment, so the configuration carries over.
How do I get it running?You run Watchtower itself as a Docker container on the same host as your apps — the Quick Start is a single docker run command, and a compose file is included in the repo. Docker is all you need.
Can I use it in production?The authors say no: it is intended for homelabs, media centers and local dev environments, with Kubernetes, MicroK8s or k3s suggested instead — and the repo is now archived, so it gets no further maintenance.
Does it only work with images on Docker Hub?No — any registry you push to works: the README names Docker Hub or your own image registry as sources for the updates it pulls.
We run everything with docker-compose — will it cope?It restarts each container with the options it was originally deployed with, so compose-managed containers keep their configuration. A compose file for running Watchtower itself is also in the repo.
Will I get notified when it updates something?The project ships notification support — notifications and receive-notifications are among its GitHub topics — with setup described in the documentation.
It's archived — what should I do if I depend on it?For production needs the README points to Kubernetes, with MicroK8s and k3s as friendlier entry points. In a homelab it keeps working as-is, but expect no fixes going forward.
What are similar projects?jenkins, walle-web, argo-cd, unleash, harness, containerd, harbor, dokku
Creator
containrrr
Size
17.6 MB
Stars
24.6K
Age
11y
Commits · 90 Days