Documentation

Quickstart

The current local workflow is driven by./tools/scripts/quickstart.sh,cordumctl up, or raw Docker Compose. The helper script auto-creates.env, generates API and Redis credentials, creates local TLS certificates when needed, waits for gateway health, and can run smoke tests.

Prerequisites

Docker + Docker ComposecurljqGo (optional for cordumctl from source)

Fastest path

bash

git clone https://github.com/cordum-io/cordum
cd cordum
export CORDUM_API_KEY="$(openssl rand -hex 32)"
export CORDUM_TENANT_ID=default
./tools/scripts/quickstart.sh

If./certs/ca/ca.crtexists, quickstart.sh switches its health checks tohttps://localhost:8081and uses that CA automatically.

Alternative bring-up

terminal

# Uses Docker Compose under the hood
go run ./cmd/cordumctl up

# Or run Compose directly
docker compose build
docker compose up -d

Dashboard

The default Docker Compose stack serves the dashboard onhttp://localhost:8082. The Vite development dashboard in the core repo useshttp://localhost:5173.

See thedashboard guidefor route groups, config.json fields, and event-stream behavior.

Licensing and telemetry

Licensing

Community tier is enforced by default (3 workers, 500 RPS). Install a license withcordumctl license installfor Team or Enterprise limits.

Telemetry

Telemetry defaults tolocal_only. SetCORDUM_TELEMETRY_MODE=anonymousto share anonymous usage data.

Verify the stack

bash

curl --cacert ./certs/ca/ca.crt   -H "X-API-Key: $CORDUM_API_KEY"   -H "X-Tenant-ID: ${CORDUM_TENANT_ID:-default}"   https://localhost:8081/api/v1/status | jq

bash ./tools/scripts/platform_smoke.sh
bash ./tools/scripts/cordumctl_smoke.sh

The canonical quickstart walkthrough in the core repo also shows a minimal approval-only workflow: create a workflow, start a run, approve the gate job fromGET /api/v1/approvals, and confirm the run reachessucceeded.

Troubleshooting

Gateway auth fails

Make sure the running stack and your shell use the same CORDUM_API_KEY and X-Tenant-ID. quickstart.sh auto-creates .env and exports credentials for its own checks.

HTTPS requests fail locally

Use the generated CA certificate with --cacert ./certs/ca/ca.crt, or point CORDUM_TLS_CA at that file.

Compose ports are already busy

Check 8081, 8082, 4222, 6379, 50051, and 9093 before starting. quickstart.sh warns on common conflicts.

Source of truth:docs/quickstart.md•Architecture overview