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)

Searching Database…

24.6K ·GitHub
archived
这是干什么用的?Watchtower 可以自动更新 Docker 容器:只要你把新镜像推送到镜像仓库,它就会拉取新镜像,停掉旧容器,并用新版本取代它启动。
它是怎么更新我的容器的——我的配置会保留吗?它会拉取新镜像,平稳地关掉正在运行的容器,然后按照最初部署时使用的同样参数重新启动,所以配置都能保留下来。
我怎么把它跑起来?把 Watchtower 本身也作为一个 Docker 容器,运行在你的应用所在的同一台主机上就行——快速上手只需要一条 docker run 命令,仓库里也附带了 compose 文件。你只需要有 Docker。
可以用在生产环境吗?作者明确不建议:它面向的是家庭实验室、媒体中心和本地开发环境,生产环境建议改用 Kubernetes、MicroK8s 或 k3s——而且这个仓库现在已经归档,不会再有后续维护了。
它只能用于 Docker Hub 上的镜像吗?不是——你推送到哪个镜像仓库都可以:README 里写明更新来源可以是 Docker Hub,也可以是你自己的镜像仓库。
我们全都是用 docker-compose 跑的,它能正常工作吗?它会按照每个容器最初部署时的参数重新启动,所以由 compose 管理的容器能保留原有配置。仓库里也提供了运行 Watchtower 本身的 compose 文件。
它更新了什么东西时,我会收到通知吗?这个项目自带通知功能——notifications 和 receive-notifications 就是它的 GitHub 话题标签之一——具体设置方法在文档里有说明。
它已经归档了,如果我依赖它该怎么办?如果是生产需求,README 推荐转向 Kubernetes,并把 MicroK8s 和 k3s 作为更容易上手的入门选择。在家庭实验室里它照常能用,但别指望以后还会有修复了。
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