Quick Start
This page helps engineers start the local OpenTremor stack, check that the API is ready, and choose a next step.
Prerequisites
Section titled “Prerequisites”| Requirement | Purpose |
|---|---|
| Docker with Compose | Runs the services and builds their images |
git, make, Python 3 | make up bootstraps the component repositories; the bootstrap script uses Python 3 |
You do not need to install uv or Node.js on your machine.
1. Check out the workspace
Section titled “1. Check out the workspace”Clone the workspace repository and run commands from its root:
The stack is defined in OpenTremor-deployments/docker-compose.yaml. It builds core with all first-party packs, the dashboard, and the docs from sibling repositories, then routes them through HAProxy. make up runs ./bootstrap.sh first to clone those repositories beside the workspace.
2. Start the stack
Section titled “2. Start the stack”The workspace includes a ready-to-use config at OpenTremor-deployments/configs/opentremor-local.yaml. MongoDB indexes are created when core starts. It is mounted read-only into the core container and shared with the dev stack, so both local stacks read the same file; see OpenTremor-deployments/configs/README.md for why the per-repository configs still carry their own copy of the dev credentials.
make upOn the first run, make up builds opentremor-core-test:latest (core with the packs, a local-test-only bundled image), opentremor-dashboard:latest, and opentremor-docs-test:latest. Later runs reuse those images.
Use the HAProxy URL for the complete stack:
| Service | URL |
|---|---|
| API, dashboard, and docs | http://localhost:8080 |
| Core API directly | http://localhost:8000 |
| Dashboard directly | http://localhost:3001 |
| Docs directly | http://localhost:4321 |
The dashboard and docs pages render on their direct ports, but browser requests that rely on HAProxy routing may fail. Use port 8080 for the complete stack.
3. Add monitoring tools (optional)
Section titled “3. Add monitoring tools (optional)”The quickstart stack runs the product services. You can also start the tools from OpenTremor-monitoring; bootstrap.sh clones that repository beside the others. These tools join the Compose network, opentremor_default.
| Tool | URL | What it shows | Docs |
|---|---|---|---|
| Grafana, with Prometheus and Loki | http://localhost:3000 | Traffic, latency, findings, backups, and request logs | Monitoring, Logs and Troubleshooting |
| GlitchTip | http://localhost:8010 | API and dashboard errors with stack traces | Error tracking: GlitchTip, Error reporting |
The /metrics endpoint | http://localhost:8000/metrics | Prometheus metrics; no extra service to install | Metrics |
From the workspace root, start Grafana, Prometheus, Loki, and Alloy:
GRAFANA_ADMIN_PASSWORD=change-me OPENTREMOR_NETWORK=opentremor_default \ docker compose -f OpenTremor-monitoring/docker-compose.yaml up -dThen start GlitchTip and create an account:
cp OpenTremor-monitoring/glitchtip/.env.example OpenTremor-monitoring/glitchtip/.env# In that .env: set the two secrets, and OPENTREMOR_NETWORK=opentremor_defaultdocker compose -f OpenTremor-monitoring/glitchtip/docker-compose.yaml up -ddocker compose -f OpenTremor-monitoring/glitchtip/docker-compose.yaml exec glitchtip ./manage.py createsuperuserIn GlitchTip, create an organization and project, then copy the project’s DSN. Replace its host with glitchtip:8000. Restart the stack with the DSN:
SENTRY_DSN=http://<key>@glitchtip:8000/<project id> make upThe local development stack runs services in containers and reloads changes from the checked-out repositories. From the workspace root, run:
make up-devThis target bootstraps the repositories before starting core, the dashboard, docs, MongoDB, and the task scheduler. It bind-mounts the component repositories so edits reload. See Development Setup for tests and formatting.
The direct core API port is 8001 in this stack. The shared verification examples below use HAProxy on port 8080, which works with either stack.
Verify the server
Section titled “Verify the server”curl http://localhost:8080/health/ready# {"status": "ok", "storage": "ok"}
curl -H "X-API-Key: $OPENTREMOR_API_KEY" http://localhost:8080/v1/packs# {"packs": [{"name": "terraform-plan", "description": "..."}, {"name": "python-code-change", ...}, ...]}