Skip to content
Drydock
Quick Start

Quick start

Deploy Drydock with Docker using a socket proxy or direct mount.

v1.9.0-rc.1 is an opt-in test build. These versioned examples pin that RC. For production, use the latest stable release (v1.7.1) and its v1.7 docs. Stop Drydock and back up the complete store directory before upgrading: first startup imports JSON into SQLite. Downgrading requires restoring the pre-upgrade snapshot and cannot carry back changes made only in SQLite. See storage migration and downgrade guidance.

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.

Using a socket proxy is the most secure way to expose the Docker API. The proxy limits which endpoints Drydock can access.

services:
  drydock:
    image: codeswhat/drydock:1.9.0-rc.1
    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:

TagBehavior
1.9.0-rc.1Immutable release candidate; best for reproducible testing
1.9-rcRolling release-candidate channel; moves to the newest 1.9.0-rc.N
1.8-rcSeparate rolling 1.8 candidate channel
1.7.0-rc.24Final 1.7.0 candidate, promoted to the 1.7.0 GA on 2026-10-19
1.7-rcSeparate rolling 1.7 candidate channel
1.7.1Immutable exact GA release, promoted unchanged from 1.7.1-rc.7; best for reproducible deployments
1.7.0Earlier immutable GA release, superseded by the 1.7.1 security maintenance release
1.7Rolling stable minor channel for the current stable line; resolves to 1.7.1; published only for GA releases
1.6.1Immutable exact GA release; final release of the frozen previous stable line
1.6Rolling channel for the frozen previous stable line; it no longer moves
1Rolling stable major channel; resolves to 1.7.1; published only for GA releases
latestNewest GA release; resolves to 1.7.1 and never points at a prerelease

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

Authentication is required by default on fresh installs. The examples above use Basic auth with username admin and password password. See the auth docs for OIDC, anonymous access, and other options.
Behind a reverse proxy? If a TLS-terminating reverse proxy (Nginx Proxy Manager, Traefik, Caddy, Synology DSM, etc.) sits in front of Drydock, set DD_SERVER_TRUSTPROXY=1 (the number of proxy hops) — otherwise every manual action in the UI fails with 403 CSRF validation failed, and WebSocket log streaming (the dashboard log viewer, container logs) fails to connect too. See the FAQ for details.

Migrating from WUD

If you are coming from What's Up Docker, migrate WUD_* environment variables and wud.* labels before starting v1.6 or later; 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.

Sign in with the default admin / password from the example and change that password right away: generate a new hash, replace DD_AUTH_BASIC_ADMIN_HASH, and recreate the container. Anyone who can reach port 3000 can use the default credentials. See the auth docs for how to generate a hash.

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