Andreas/watchtower
1
0
Fork 0
mirror of https://github.com/containrrr/watchtower.git synced 2026-01-02 15:18:49 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(docs): Update docs

Browse source
This commit is contained in:
Jan Rundshagen 2024-07-09 09:22:02 +02:00
parent 7382727c74
commit 156d25ccea
No known key found for this signature in database
GPG key ID: D39ECE260D6616C7
12 changed files with 55 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/usage-overview.md
View file

@ -1,4 +1,4 @@
Watchtower is itself packaged as a Docker container so installation is as simple as pulling the `containrrr/watchtower` image. If you are using ARM based architecture, pull the appropriate `containrrr/watchtower:armhf-<tag>` image from the [containrrr Docker Hub](https://hub.docker.com/r/containrrr/watchtower/tags/).
Watchtower is itself packaged as a Docker container so installation is as simple as pulling the `beatkind/watchtower` image. If you are using ARM based architecture, pull the appropriate `beatkind/watchtower:armhf-<tag>` image from the [beatkind Docker Hub](https://hub.docker.com/r/beatkind/watchtower/tags/).
Since the watchtower code needs to interact with the Docker API in order to monitor the running containers, you need to mount _/var/run/docker.sock_ into the container with the `-v` flag when you run it.
@ -8,7 +8,7 @@ Run the `watchtower` container with the following command:
docker run -d \
--name watchtower \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower
beatkind/watchtower
```
If pulling images from private Docker registries, supply registry authentication credentials with the environment variables `REPO_USER` and `REPO_PASS`
@ -22,7 +22,7 @@ docker run -d \
-e REPO_USER=username \
-e REPO_PASS=password \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower container_to_watch --debug
beatkind/watchtower container_to_watch --debug
```
Also check out [this Stack Overflow answer](https://stackoverflow.com/a/30494145/7872793) for more options on how to pass environment variables.
@ -34,7 +34,7 @@ docker run -d \
--name watchtower \
-v $HOME/.docker/config.json:/config.json \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower container_to_watch --debug
beatkind/watchtower container_to_watch --debug
```
!!! note "Changes to config.json while running"
@ -60,7 +60,7 @@ services:
- "443:3443"
- "80:3080"
watchtower:
image: containrrr/watchtower
image: beatkind/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /root/.docker/config.json:/config.json