Self-hosted dashboard and API for RunRight.
Web UI · REST API · PostgreSQL · AI cost assistant · SSO · RBAC · Grafana
Live product tour: dashboard, run insights, recommendations, and job history
Pipe your data into Grafana or use the built-in dashboard. Raw runs land in Postgres.
The RunRight agent (run-right) collects metrics from every CI job. RunRight Platform is the optional self-hosted backend that stores those runs, serves a web dashboard, and powers the AI cost assistant.
You do not need this repo to use RunRight. The agent works standalone with OTLP, Prometheus, or JSON file export. This repo is for teams that want a persistent dashboard, historical analysis, and org-level reporting.
# Clone and start
git clone https://github.com/gbudjeakp/runright-platform.git
cd runright-platform
export RUNRIGHT_API_KEY=$(openssl rand -hex 32)
docker compose up -d| Service | URL |
|---|---|
| Dashboard | http://localhost:3000 |
| API | http://localhost:8080 |
| PostgreSQL | localhost:5435 |
# Install flyctl: https://fly.io/docs/flyctl/install/
fly auth login
fly launch --name my-runright --region iad
fly postgres create --name my-runright-db --region iad
fly postgres attach my-runright-db
# Set secrets
fly secrets set \
RUNRIGHT_API_KEY=$(openssl rand -hex 32) \
RUNRIGHT_BASE_URL=https://my-runright.fly.dev
fly deployhelm repo add runright https://gbudjeakp.github.io/runright-platform
helm install runright runright/runright-platform \
--set apiKey=$(openssl rand -hex 32) \
--set postgresql.enabled=trueFor automatic workflow monitoring without modifying CI files, set up a GitHub App:
Go to GitHub Developer Settings and create an app with:
| Setting | Value |
|---|---|
| Name | YourOrg RunRight |
| Homepage URL | Your RunRight URL |
| Webhook URL | https://your-runright.example.com/api/v1/github/webhook |
| Webhook Secret | Generate with openssl rand -hex 32 |
Permissions:
- Actions: Read
- Checks: Read & Write
- Contents: Read
- Metadata: Read
- Pull requests: Read & Write
- Workflows: Read
Events: Check run, Workflow run
After creating the app, click Generate a private key and download the .pem file.
Add to your .env or set as environment variables:
GITHUB_APP_ID=123456
GITHUB_APP_CLIENT_ID=Iv1.abc123
GITHUB_APP_SLUG=yourorg-runright
GITHUB_APP_WEBHOOK_SECRET=your-webhook-secret
GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----"Or with Fly.io:
fly secrets set \
GITHUB_APP_ID=123456 \
GITHUB_APP_CLIENT_ID=Iv1.abc123 \
GITHUB_APP_SLUG=yourorg-runright \
GITHUB_APP_WEBHOOK_SECRET=$(cat webhook-secret.txt) \
GITHUB_APP_PRIVATE_KEY="$(cat private-key.pem)" \
--app my-runrightVisit https://github.com/apps/yourorg-runright/installations/new and install on your repos.
Point your agents at the platform by adding to your CI:
- uses: gbudjeakp/run-right@v1
with:
run: make build
env:
RUNRIGHT_URL: ${{ vars.RUNRIGHT_URL }}
RUNRIGHT_API_KEY: ${{ secrets.RUNRIGHT_API_KEY }}| Feature | Details |
|---|---|
| Jobs dashboard | Browse every CI run: duration, CPU p95, memory, tier label, cost delta |
| Run detail | Per-run timeline, resource breakdown, and instance recommendation |
| AI cost assistant | Chat interface backed by OpenAI, Anthropic, or a local Ollama model |
| Policies | Org-level rules that auto-flag jobs exceeding cost or resource thresholds |
| Alerts | Slack, webhook, or email notifications when policy rules trigger |
| SSO | Google, GitHub OAuth2, or SAML 2.0 |
| RBAC | Viewer / Member / Admin / Owner roles per team |
| Audit log | Immutable record of config changes |
| Grafana | Pre-built dashboard auto-provisioned from grafana/ |
Copy .env.example to .env and fill in your values:
cp .env.example .envKey variables:
| Variable | Default | Description |
|---|---|---|
DATABASE_URL |
postgres://...@localhost:5435/runright |
PostgreSQL connection string |
RUNRIGHT_API_KEY |
— | Shared secret for agent → API auth |
RUNRIGHT_BASE_URL |
http://localhost:8080 |
Public URL (used for OAuth callbacks) |
RUNRIGHT_AI_PROVIDER |
ollama |
ollama | openai | anthropic |
RUNRIGHT_AI_MODEL |
llama3.1 |
Model name for the AI assistant |
RUNRIGHT_SSO_ENABLED |
false |
Enable SSO login |
See .env.example for the full list.
Prerequisites: Go 1.22+, Node.js 20+, pnpm 9+, Docker (for Postgres)
# Start Postgres only
docker compose up -d postgres
# Backend (hot reload via Air)
air
# Frontend
cd web && pnpm install && pnpm devOr run backend + frontend without Docker:
# Terminal 1
DATABASE_URL="postgres://runright:runright@localhost:5435/runright?sslmode=disable" \
go run ./cmd/server --port 8080
# Terminal 2
cd web && pnpm devdocker compose up -d postgres
docker compose --profile dev up -d backend-dev
# Edits to *.go reload automatically; no restart neededA pre-built dashboard is included in grafana/. It auto-provisions when you run Docker Compose:
docker compose up -d
# Grafana at http://localhost:3001 (admin / runright)Panels: jobs/day · avg CPU p95 by job · CI platform breakdown · cost savings potential · recent runs table · CPU trend by CI platform.
web/ React 18 + Vite + Tailwind CSS — dashboard
cmd/server/ Go entrypoint (Gin, port 8080)
cmd/seed/ Demo data seeder
internal/
server/ REST API handlers, auth middleware, RBAC, SSO, audit
assistant/ AI cost assistant (OpenAI / Anthropic / Ollama)
embeddings/ RAG vector search over job history
engine/ Cost recommender (shared with agent)
catalog/ AWS + GCP instance catalog
currency/ Exchange rate helpers
notification/ Alert dispatch (Slack, webhook, email)
helm/ Kubernetes Helm chart
terraform/ EKS + GKE infrastructure
grafana/ Dashboards and provisioning config
- run-right — the agent and GitHub Action (no server required)
Elastic License 2.0 (ELv2). See LICENSE