mirror of
https://github.com/containrrr/watchtower.git
synced 2025-09-22 05:40:50 +02:00
2fa8a2ad0c
* Fix docker-compose syntax in quick-start. GH #1105 * use new mkdocs tabs * fix indentation for tabs Co-authored-by: nils måsén <nils@piksel.se>
65 lines
2.7 KiB
Markdown
65 lines
2.7 KiB
Markdown
<p style="text-align: center; margin-left: 1.6rem;">
|
|
<img alt="Logotype depicting a lighthouse" src="./images/logo-450px.png" width="450" />
|
|
</p>
|
|
<h1 align="center">
|
|
Watchtower
|
|
</h1>
|
|
|
|
<p align="center">
|
|
A container-based solution for automating Docker container base image updates.
|
|
<br/><br/>
|
|
<a href="https://circleci.com/gh/containrrr/watchtower">
|
|
<img alt="Circle CI" src="https://circleci.com/gh/containrrr/watchtower.svg?style=shield" />
|
|
</a>
|
|
<a href="https://codecov.io/gh/containrrr/watchtower">
|
|
<img alt="Codecov" src="https://codecov.io/gh/containrrr/watchtower/branch/main/graph/badge.svg">
|
|
</a>
|
|
<a href="https://godoc.org/github.com/containrrr/watchtower">
|
|
<img alt="GoDoc" src="https://godoc.org/github.com/containrrr/watchtower?status.svg" />
|
|
</a>
|
|
<a href="https://goreportcard.com/report/github.com/containrrr/watchtower">
|
|
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/containrrr/watchtower" />
|
|
</a>
|
|
<a href="https://github.com/containrrr/watchtower/releases">
|
|
<img alt="latest version" src="https://img.shields.io/github/tag/containrrr/watchtower.svg" />
|
|
</a>
|
|
<a href="https://www.apache.org/licenses/LICENSE-2.0">
|
|
<img alt="Apache-2.0 License" src="https://img.shields.io/github/license/containrrr/watchtower.svg" />
|
|
</a>
|
|
<a href="https://www.codacy.com/gh/containrrr/watchtower/dashboard?utm_source=github.com&utm_medium=referral&utm_content=containrrr/watchtower&utm_campaign=Badge_Grade">
|
|
<img alt="Codacy Badge" src="https://app.codacy.com/project/badge/Grade/1c48cfb7646d4009aa8c6f71287670b8"/>
|
|
</a>
|
|
<a href="https://github.com/containrrr/watchtower/#contributors">
|
|
<img alt="All Contributors" src="https://img.shields.io/github/all-contributors/containrrr/watchtower" />
|
|
</a>
|
|
<a href="https://hub.docker.com/r/containrrr/watchtower">
|
|
<img alt="Pulls from DockerHub" src="https://img.shields.io/docker/pulls/containrrr/watchtower.svg" />
|
|
</a>
|
|
</p>
|
|
|
|
## 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"
|
|
|
|
```bash
|
|
$ docker run -d \
|
|
--name watchtower \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
containrrr/watchtower
|
|
```
|
|
|
|
=== "docker-compose.yml"
|
|
|
|
```yaml
|
|
version: "3"
|
|
services:
|
|
watchtower:
|
|
image: containrrr/watchtower
|
|
volumes:
|
|
- /var/run/docker.sock:/var/run/docker.sock
|
|
```
|