Quickstart with Docker Compose

The compose stack runs the whole local service: Valkey, ClickHouse, PostgreSQL, a one-shot migration container, and oriel serve --role=all.

1. Start the stack from the compose directory.

   cd deploy/compose
   docker compose -f local.yml up --build

2. Wait for the services to become healthy.

   The compose file waits for Valkey, ClickHouse, and PostgreSQL health checks before running oriel migrate up. The oriel service starts only after the migration container exits successfully and Valkey is healthy.

3. Open the UI and API.

   http://localhost:6743

4. Use OTLP endpoints from local applications or collectors.

   OTLP gRPC: localhost:4317
   OTLP HTTP: http://localhost:4318

What starts

Service	Purpose
valkey	Required runtime cache/pub-sub store on port 6379.
clickhouse	Telemetry storage, native port 9000, HTTP port 8123.
postgres	Metadata and control-plane storage on port 5432.
oriel-migrate	One-shot oriel migrate up against both stores.
oriel	Long-running oriel serve --role=all.

Create the first account

After the stack is running:

docker compose -f local.yml exec -e ORIEL_BOOTSTRAP_PASSWORD='change-me' oriel \
  oriel admin bootstrap --email you@example.com
docker compose -f local.yml exec oriel oriel admin create-workspace --slug demo

The bootstrap command requires a password. Prefer ORIEL_BOOTSTRAP_PASSWORD; the --password flag is visible in process lists.

Create a project and environment in Settings before sending telemetry.

Stop or reset

Stop the containers:

docker compose -f local.yml down

Delete local data volumes:

docker compose -f local.yml down -v

Deleting volumes removes PostgreSQL metadata and ClickHouse telemetry. Valkey holds rebuildable runtime cache state in the compose path.