Quick start

Run the Docker image

The easiest way to get started is to deploy the official WUD container image.

Docker Compose

services:
  whatsupdocker:
    image: getwud/wud
    container_name: wud
    environment:
      - WUD_AUTH_ADMIN_USER=admin
      - WUD_AUTH_ADMIN_PASSWORD=MySecurePassword123
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 3000:3000

Docker

docker run -d --name wud \
  -e WUD_AUTH_ADMIN_USER="admin" \
  -e WUD_AUTH_ADMIN_PASSWORD="MySecurePassword123" \
  -v "/var/run/docker.sock:/var/run/docker.sock" \
  -p 3000:3000 \
  getwud/wud

Note that WUD is available on multiple container registries:

• Docker Hub: getwud/wud
• GitHub Container Registry: ghcr.io/getwud/wud

Open the UI

Open the UI in your browser and verify that everything is running properly.

Add your first trigger

Everything running smoothly?

It's time to configure your triggers!

Going deeper

Need to fine-tune how WUD monitors your containers?

Check out the watcher documentation!

Running in Kubernetes?

WUD can be deployed natively in your Kubernetes cluster to watch Deployments, StatefulSets, DaemonSets, and CronJobs. Check out the Kubernetes Watcher Guide for RBAC manifests and setup instructions.

Need to integrate other registries (ECR, GCR, GitLab...)?

Check out the registry documentation.

Ready-to-go examples

info

You can find a complete configuration example illustrating common WUD options.