💡 About WUD

WUD (What's Up Docker?) is a lightweight, proactive container update monitoring and automation tool. It continuously scans your container environments, detects image updates across public and private registries, performs semantic version analysis, and alerts you via your favorite notification channels—or triggers automatic container updates seamlessly.

flowchart LR
    W["🔍 <b>WATCHERS</b><br/>Discover running containers<br/><i>Local/Remote Docker, Compose, Nomad</i>"]
    WUD{{"⚡ <b>WUD ENGINE</b><br/>Compare versions &amp; digests"}}
    R["📦 <b>REGISTRIES</b><br/>Inspect tags &amp; manifests<br/><i>Docker Hub, GHCR, Private OCI</i>"]
    T["🚀 <b>TRIGGERS</b><br/>Notify &amp; Auto-Update<br/><i>Discord, Slack, Compose, MQTT</i>"]

    W -->|"Scan"| WUD
    WUD <-->|"Inspect"| R
    WUD -->|"Execute"| T

---

✨ Features

• 🔍 Multi-Watcher Engine
  Monitor local Docker daemons, remote Docker engines over TLS, Docker Compose setups, or HashiCorp Nomad workloads.
• 📦 Multi-Registry Integration
  Zero-config & authenticated support for Docker Hub, GitHub Container Registry (GHCR), AWS ECR, Google GCR/GAR, Azure ACR, Quay, GitLab, Gitea, Forgejo, Codeberg, LinuxServer (LSCR), and any custom/self-hosted OCI registry.
• 🔔 15+ Notification & Automation Triggers
  Get notified or trigger webhooks instantly on Discord, Telegram, Slack, Ntfy, Gotify, Pushover, Apprise, Rocket.Chat, SMTP Email, IFTTT, MQTT (Home Assistant), Apache Kafka, HTTP Webhooks, and Shell Commands.
• 🔄 Automated Container Updates
  Automatically pull new images and recreate containers on demand (Docker, Docker Compose, Nomad).
• 🏷️ SemVer & Tag Filtering
  Flexible versioning strategies: target semver (major, minor, patch), match custom regular expressions, pin versions, or define include/exclude tag rules.
• 🖥️ Interactive Web UI & REST API
  Clean, responsive web dashboard to inspect container statuses, trigger manual update checks, and query data via a full-featured REST API.
• 📊 Prometheus & Grafana Ready
  Built-in Prometheus /metrics endpoint and pre-built Grafana dashboards for observability.
• 🔒 Enterprise-Grade Authentication
  Secure your WUD dashboard with OpenID Connect (OIDC) (Keycloak, Authentik, Authelia, Google, etc.) or HTTP Basic Auth.

---

⚡ Quick Start

1. Run with Docker

docker run -d \
  --name wud \
  -p 3000:3000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  getwud/wud:latest

2. Run with Docker Compose

services:
  whatsupdocker:
    image: getwud/wud:latest
    container_name: wud
    ports:
      - "3000:3000"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    restart: unless-stopped

🌐 Access the Web UI: Open http://localhost:3000 in your browser.

---

🧩 Supported Integrations

📦 Registries

Registry	Description	Authentication
Docker Hub	Public and private Docker Hub images	Anonymous / Token / Password
GitHub (GHCR)	GitHub Container Registry packages	Personal Access Token
AWS ECR	Amazon Elastic Container Registry	AWS IAM Keys / IAM Roles
Google GCR / Artifact Registry	GCP Container & Artifact Registry	Service Account Key (JSON)
Azure ACR	Azure Container Registry	Service Principal / Admin Secret
GitLab Registry	GitLab Container Registry	Deploy Token / PAT
Quay.io	Red Hat Quay	Robot Account / OAuth Token
Self-Hosted / OCI	Harbor, Nexus, Artifactory, Gitea, Forgejo, Codeberg	Basic Auth / Bearer Token

🔔 Triggers & Notifications

Category	Supported Channels
Chat & Messaging	Discord, Telegram, Slack, Rocket.Chat
Push Notifications	Ntfy, Gotify, Pushover, Apprise, IFTTT
Auto-Update & Orchestration	Docker Container, Docker Compose, HashiCorp Nomad
IoT & Message Queues	MQTT (Home Assistant auto-discovery), Apache Kafka
Automation & Custom	HTTP Webhooks, Shell Command Execution, SMTP Email

---

🏷️ Configuration via Docker Labels

WUD can be configured globally through environment variables or granularly per container using Docker labels:

services:
  my-app:
    image: myorg/myapp:1.2.0
    labels:
      # Only consider semver minor and patch updates (e.g. 1.2.1, 1.3.0, but not 2.0.0)
      - "wud.tag.include=^1\\.\\d+\\.\\d+$"
      - "wud.tag.transform=^v(.*)$$ => $$1"
      
      # Send update notifications to a specific Discord webhook
      - "wud.trigger.discord.mywebhook.enabled=true"
      
      # Automatically recreate this container when an update is available
      - "wud.trigger.docker.myupdater.enabled=true"

Explore all configuration options in the Configuration Hub.

---

📚 Documentation

For complete setup guides, advanced configurations, tutorials, and API references, check out our official documentation:

👉 https://getwud.github.io/wud/

• 🚀 Getting Started & Tutorials
• ⚙️ Configuration Reference
• 🔍 Docker Watcher & TLS
• 📦 Registry Authentication
• 🔔 Triggers & Automation Setup
• 📊 Prometheus & Grafana Monitoring
• 🔌 REST API Reference
• ❓ Frequently Asked Questions (FAQ)

---

🤝 Community & Support

• 🛠️ Want to contribute? Read our Developer & Contributing Guide.
• 🐛 Found a bug or need a feature? Submit an Issue.
• ⭐ Like WUD? Give us a star on GitHub!
• ☕ Support the maintainer: Buy me a coffee or Donate via PayPal.

---

📄 License

This project is open-source software licensed under the MIT License.