Skip to content
DashboardWebsite

Quick Start

This page helps engineers start the local OpenTremor stack, check that the API is ready, and choose a next step.

RequirementPurpose
Docker with ComposeRuns the services and builds their images
git, make, Python 3make up bootstraps the component repositories; the bootstrap script uses Python 3

You do not need to install uv or Node.js on your machine.


Clone the workspace repository and run commands from its root:

Terminal window
git clone [email protected]:opentremor/opentremor.git && cd opentremor

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.

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.

Terminal window
make up

On 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:

ServiceURL
API, dashboard, and docshttp://localhost:8080
Core API directlyhttp://localhost:8000
Dashboard directlyhttp://localhost:3001
Docs directlyhttp://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.

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.

ToolURLWhat it showsDocs
Grafana, with Prometheus and Lokihttp://localhost:3000Traffic, latency, findings, backups, and request logsMonitoring, Logs and Troubleshooting
GlitchTiphttp://localhost:8010API and dashboard errors with stack tracesError tracking: GlitchTip, Error reporting
The /metrics endpointhttp://localhost:8000/metricsPrometheus metrics; no extra service to installMetrics

From the workspace root, start Grafana, Prometheus, Loki, and Alloy:

Terminal window
GRAFANA_ADMIN_PASSWORD=change-me OPENTREMOR_NETWORK=opentremor_default \
docker compose -f OpenTremor-monitoring/docker-compose.yaml up -d

Then start GlitchTip and create an account:

Terminal window
cp OpenTremor-monitoring/glitchtip/.env.example OpenTremor-monitoring/glitchtip/.env
# In that .env: set the two secrets, and OPENTREMOR_NETWORK=opentremor_default
docker compose -f OpenTremor-monitoring/glitchtip/docker-compose.yaml up -d
docker compose -f OpenTremor-monitoring/glitchtip/docker-compose.yaml exec glitchtip ./manage.py createsuperuser

In GlitchTip, create an organization and project, then copy the project’s DSN. Replace its host with glitchtip:8000. Restart the stack with the DSN:

Terminal window
SENTRY_DSN=http://<key>@glitchtip:8000/<project id> make up

Terminal window
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", ...}, ...]}