Quick start

Run the Docker image

To get started, deploy the official drydock image:

Every example below also mounts a persistent /store volume. Without it, update history and detection timestamps reset every time the drydock container is recreated.

services:
  drydock:
    image: codeswhat/drydock
    container_name: drydock
    depends_on:
      socket-proxy:
        condition: service_healthy
    volumes:
      - ./drydock-store:/store
    environment:
      - DD_WATCHER_LOCAL_HOST=socket-proxy
      - DD_WATCHER_LOCAL_PORT=2375
      - DD_AUTH_BASIC_ADMIN_USER=admin
      - "DD_AUTH_BASIC_ADMIN_HASH=argon2id$$65536$$3$$4$$H/LzIyo+5tbepUCiuRU2bFai+nbf+y/ZjMYH7h+vf1g=$$GeCkn8cI/+DbKXUiPydlqKUvj5Ujb4wL5sUkSm83rQWyIejvWoejrk6zWmQ2x5an7qvSHYL9gZHpibCXAJNdYw=="
      # - DD_SERVER_TRUSTPROXY=1  # uncomment if a TLS-terminating reverse proxy sits in front of Drydock
    ports:
      - 3000:3000

  socket-proxy:
    image: tecnativa/docker-socket-proxy
    container_name: drydock-socket-proxy
    labels:
      - dd.watch=true
      - dd.update.mode=infrastructure
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - CONTAINERS=1
      - IMAGES=1
      - EVENTS=1
      - SERVICES=1
      - INFO=1          # Required for daemon identity detection (notification prefixes)
      # Add POST=1 for container actions (start/stop/restart) or auto-updates
      # Add NETWORKS=1 if using the Docker trigger for auto-updates
    healthcheck:
      test: wget --spider http://localhost:2375/version || exit 1
      interval: 5s
      timeout: 3s
      retries: 3
      start_period: 5s
    restart: unless-stopped

The official image is published on Docker Hub, GitHub Container Registry, and Quay.io.

Release tags use the same channel names in every registry:

Use the exact RC tag when reporting a regression. Use 1.6-rc only when you intentionally want each candidate cut without editing your Compose file.

Migrating from WUD

If you are coming from What's Up Docker, migrate WUD_* environment variables and wud.* labels before starting v1.6; those runtime aliases have been removed.

To rewrite your local config to drydock naming (DD_* and dd.*), run:

# preview changes only
docker exec -it drydock node dist/index.js config migrate --dry-run

# apply changes to specific files
docker exec -it drydock node dist/index.js config migrate --file .env --file compose.yaml

config migrate reads/writes only local files in your deployment. It does not send usage data to external services.

If you use the Home Assistant wud-card or Homepage's native whatsupdocker widget against your old WUD instance, set DD_COMPAT_WUDCARD=true to keep them working against drydock — see wud-card compatibility.

Open the UI

Open the UI in a browser and check that everything is working as expected.

First 5 minutes in the UI

1. Open the command palette with Cmd/Ctrl+K.
2. Use prefix scopes to narrow search quickly:
   • / pages
   • @ runtime resources (containers, agents, triggers, watchers)
   • # config resources (registries, auth, notifications, settings)
3. Leave the query empty to use recent results.
4. Open Notifications and tune all seven delivery rules, trigger assignments, audit-backed in-app bell categories, and per-provider templates. The update-available bell rule also offers a severity threshold; use Preview to render template drafts before saving.
5. Reorder or resize dashboard widgets in edit mode; the custom grid persists responsive layouts locally (and across devices when signed-in preference sync is enabled) and can be reset.

Keyboard shortcuts: Enter confirms action dialogs, Escape cancels dialogs and closes detail panels.

Next steps

• Getting started guide — step-by-step walkthrough from watching containers to notifications and auto-updates.
• Add some triggers to get notified or auto-update containers.
• Configure watchers to fine-tune how drydock monitors your containers.
• Run with Podman if your host uses Podman's Docker-compatible API socket.
• Multi-host monitoring — run lightweight agents on remote hosts and aggregate them into one UI.
• Integrate other registries (ECR, GCR, GHCR, and more).
• See a complete configuration example illustrating common drydock options.