api-reference/decision-engine-api-reference/installation.md
This section covers everything needed to get Decision Engine running locally — from a single docker compose up to the full CLI, Docker, Compose, and Helm matrix.
The Quick Start below pulls prebuilt images from GHCR, so you do not need Rust, make, or a local database. You do need:
Docker Engine 20+
Docker Compose v2+ (the docker compose subcommand, not the legacy docker-compose binary)
The repository cloned locally — the compose command reads docker-compose.yaml, so run it from the repo root:
git clone https://github.com/juspay/decision-engine.git
cd decision-engine
Network access to pull ghcr.io/juspay/... images and a few GB of free disk (the first run pulls the app, PostgreSQL, Redis, Kafka, ClickHouse, and Mailpit).
The fastest path to a running instance. Every service in docker-compose.yaml is gated behind a profile, so a profile is required — there is no default/unprofiled bring-up:
docker compose --profile postgres-ghcr up -d
curl http://localhost:8080/health
Expected response:
{ "message": "Health is good" }
For the API, dashboard, and docs together, use --profile dashboard-postgres-ghcr instead — see Dashboard.
| Page | Use it for |
|---|---|
| Local Setup | The canonical guide — Compose profiles, source builds, Docker images without Compose, Helm, and troubleshooting. |
| PostgreSQL Setup | Postgres-specific Compose profiles, make targets, and verification. |
| MySQL Setup | The same, for MySQL. |
| Configuration | Config file reference and environment variable overrides once the service is up. |
| Dashboard | Bring up the React operator dashboard alongside the API. |
Decision Engine supports PostgreSQL and MySQL as interchangeable backends. Pick one and follow its dedicated guide, or go straight to Local Setup if you want the full profile matrix (dashboard, monitoring, source builds) rather than a database-first walkthrough.
curl examples once the service is running.