diff options
Diffstat (limited to 'watchtower/README.md')
| -rw-r--r-- | watchtower/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/watchtower/README.md b/watchtower/README.md new file mode 100644 index 0000000..1d3bc8b --- /dev/null +++ b/watchtower/README.md @@ -0,0 +1,25 @@ +# Watchtower + +Automatically updates running Docker containers to the latest image versions. + +## Setup + +1. Copy `.env.example` to `.env`: + ``` + cp .env.example .env + ``` + +2. Edit `.env` with your SMTP credentials for email notifications. + +3. Start: + ``` + docker compose up -d + ``` + +## What to Configure + +- **`.env`** — All SMTP settings. Watchtower will send email notifications after updates (or if updates fail). +- **Schedule** — `WATCHTOWER_SCHEDULE=0 0 4 * * 0` runs every Sunday at 4 AM. Uses 6-field cron. Change as desired. +- **Docker socket** — Mounts `/var/run/docker.sock`. Required for Watchtower to manage containers. +- **Cleanup** — `WATCHTOWER_CLEANUP=true` removes old images after updates. Set to `false` if you want to keep them. +- **Scope labels** — To exclude a container from auto-updates, add `com.centurylinklabs.watchtower.scope=ignore` to its container labels. |