Skip to main content

Install with Docker Compose

This page deploys DAGZ on a single host using Docker Compose. Use this when Kubernetes is not available; for clusters, prefer Install with Helm.

Prerequisites​

  • A dedicated VM with Docker and Docker Compose installed. DAGZ services tolerate a restart, so a spot VM is acceptable if HA isn't required.
  • A DNS hostname for the DAGZ web console.
  • The DAGZ product key file (provided by DAGZ during onboarding).

Resource budget for the DAGZ services:

  • CPU: negligible.
  • Memory: 4 GB.
  • Disk: 300 GB (200 GB ClickHouse + 100 GB history blob store).

1. Set the product key path​

export DAGZ_PRODUCT_KEY=path/to/dagz-key.json

2. Authenticate Docker against the registry​

cat "$DAGZ_PRODUCT_KEY" | docker login \
    -u _json_key \
    --password-stdin https://us-east1-docker.pkg.dev/autodag

Optional: edit $HOME/.docker/config.json and scope the credentials to the /autodag path:

{
  "auths": {
    "us-east1-docker.pkg.dev/autodag": {
      "auth": "<your imported product key>"
    }
  }
}

3. Bring up the stack​

DAGZ_REPO=oci://us-east1-docker.pkg.dev/autodag/docker-stable
docker compose \
    --file $DAGZ_REPO/autodag-compose \
    up --detach

Docker Compose pulls the published compose file directly from the OCI registry, then starts the DAGZ services.

To inspect the compose file locally for debugging:

docker buildx imagetools inspect --raw \
    us-east1-docker.pkg.dev/autodag/docker-stable/autodag-compose:latest \
    | jq '.layers[0].data' | sed 's/"//g' | base64 -d

4. Configure SSO​

Open the console URL in a browser. On first load it prompts you to choose an SSO provider and upload its configuration.

See SSO with Microsoft Entra ID for the walkthrough.