GitDash
DocsAPI playgroundGitHub
Open GitDash
GitDash Docsv4.7.1
GitHub API playground
  • Introduction
  • Quick start
  • Deployment
  • Configuration
  • Auth modes
  • Access control
  • Caching & rate limits
  • Security model
  • Data sources
  • Feature overview
  • Repositories
  • Repository · Overview
  • Repository · Workflows
  • Repository · Pull requests
  • Repository · Team
  • Repository · Issues
  • Repository · Security
  • Repository · Audit trail
  • Workflow detail
  • Alerts
  • Team insights
  • Contributor & 1:1 prep
  • Cost
  • Reports
  • Org overview & health
  • Settings
  • AI insights
  • Metrics Reference
  • DORA 4 Keys
  • PR Cycle Time
  • PR Lifecycle Health
  • Workflow Overview
  • Performance Tab
  • Reliability Tab
  • Team & People
  • CI & Alert Metrics
  • API Reference
  • FAQ & Troubleshooting
  • Contributing
  • Release Notes
  • Data & privacy
GitHub RepositoryReport an Issue
GitDash Docs

Configuration

Everything is configured with environment variables. .env.local.example in the repository lists them all with comments; the tables below explain what each one is for.

Core

VariablePurpose
SESSION_SECRETRequiredAt least 32 characters; encrypts the session cookie. The app refuses to start in production without it.
MODEOptionalstandalone (default) or organization.
NEXT_PUBLIC_APP_URLOptionalPublic URL; used for OAuth redirects, same-origin checks, and the canonical and social-card URLs of public pages. Static pages read it at build time, so pass it to the image build as well when those URLs matter.

Organization mode and access control

VariablePurpose
GITHUB_CLIENT_IDOrganizationOAuth App client id (Continue with GitHub).
GITHUB_CLIENT_SECRETOrganizationOAuth App client secret.
DATABASE_URLOrganizationPostgres connection string: users, groups, grants, audit, alerts, reports, shared cache.
GITDASH_ADMIN_GITHUB_IDSOrganizationComma-separated numeric GitHub ids that are always admins.
GITDASH_ALLOWED_ORGSOptionalComma-separated orgs whose active members may sign in; empty means any GitHub account (it lands on /pending).
GITDASH_RBAC_ENFORCEOptionaltrue enforces group permissions; false (default) keeps everyone's access during rollout.
GITDASH_LANDING_PAGEOptionaltrue shows the /welcome product page to signed-out visitors at /, with Sign in leading to /login. For the public product site; leave unset when self-hosting.

Sync, webhooks and caching

VariablePurpose
GITHUB_TOKENOptionalServer token for the nightly sync crons, which run without a user session.
CRON_SECRETOptionalBearer token for /api/cron/*; the routes answer 401 without it.
GITHUB_WEBHOOK_SECRETOptionalVerifies /api/webhooks/github signatures; without it every webhook is rejected.
GITDASH_L2_CACHEOptional0 keeps the API cache in memory only (default: shared Postgres cache when a database is set).
GITDASH_GH_LOGOptional1 logs every GitHub call with its route and remaining budget.

Email

VariablePurpose
RESEND_API_KEY, RESEND_FROMOptionalEmail delivery through Resend (preferred).
SMTP_HOST, SMTP_USER, SMTP_PASS, SMTP_FROMOptionalGeneric SMTP instead of Resend (or SENDGRID_API_KEY). Admins can also set email in Settings → Email and digests.

AI insights

Optional. Without a key every AI surface is hidden. Providers are tried in this order and any without a key is skipped; in organization mode an admin can also set a provider in Settings → AI provider.

VariablePurpose
BAILIAN_API_KEY, BAILIAN_MODEL, BAILIAN_BASE_URLAlibaba Cloud Bailian (Anthropic Messages API).
GEMINI_API_KEY, GEMINI_MODELGoogle Gemini.
QWEN_API_KEY, QWEN_MODELQwen via DashScope.
AI_DISABLEDtrue turns every AI surface off regardless of keys.
AI_TIMEOUT_MS, AI_TOTAL_BUDGET_MS, AI_DAILY_TOKEN_BUDGETPer-attempt timeout, per-request time budget and a per-instance daily token cap.

Demo data

NEXT_PUBLIC_DEMO_MODE=true (or ?demo=1 on a page) replaces GitHub data with a fictional organization, for screenshots and trials. You still sign in.

PreviousDeploymentNextAuth modes

GitDash v4.7.1 — GitHub Actions Dashboard

Open source on GitHubData & privacyReport an issue