Skip to main content

Quick start

Run the Docker image

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

services:
whatsupdocker:
image: getwud/wud
container_name: wud
volumes:
- /var/run/docker.sock:/var/run/docker.sock
ports:
- 3000:3000
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?

Going deeper...

Need to fine-tune how WUD monitors your containers?

Check out the watcher documentation!

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.