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-контейнеров: вы публикуете новый образ в своём registry, а он сам его скачивает, останавливает старый контейнер и запускает вместо него новую версию.
Как он обновляет мои контейнеры — настройки не слетят?Он скачивает новый образ, аккуратно останавливает работающий контейнер и перезапускает его с теми же параметрами, с которыми он был развёрнут изначально, так что вся конфигурация сохраняется.
Как его запустить?Сам Watchtower запускается как Docker-контейнер на том же хосте, где работают ваши приложения — в Quick Start это одна команда docker run, а в репозитории лежит и compose-файл. Нужен только сам Docker.
А в проде его можно использовать?Авторы говорят, что нет: он рассчитан на домашние серверы, медиацентры и локальные среды разработки, а для продакшена предлагают Kubernetes, MicroK8s или k3s. К тому же репозиторий уже заархивирован и больше не поддерживается.
Он работает только с образами из Docker Hub?Нет — подойдёт любой registry, куда вы публикуете образы: в README в качестве источников обновлений названы Docker Hub или ваш собственный image registry.
У нас всё крутится через docker-compose — он справится?Он перезапускает каждый контейнер с теми параметрами, с которыми тот был изначально развёрнут, поэтому контейнеры под управлением compose сохраняют свою конфигурацию. В репозитории есть и compose-файл для запуска самого Watchtower.
Буду ли я получать уведомления, когда он что-то обновляет?Да, в проекте есть поддержка уведомлений — среди его GitHub-тем значатся notifications и receive-notifications, а настройка описана в документации.
Проект заархивирован — что делать, если я от него завислю?Для продакшена 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