Skip to content
GOVERN Admin

Admin Quick Start

Prerequisites

  • Docker and Docker Compose installed
  • A GOVERN admin API key (gvn_admin_xxxx)
  • DNS control for your organization’s domain

Step 1: Deploy the GOVERN API

Terminal window
docker compose -f govern-api.docker-compose.yml up -d

The API starts on port 8443. Verify with:

Terminal window
curl https://localhost:8443/health
# {"status":"healthy","version":"1.0.0"}

Step 2: Create the first organization

Terminal window
govern-admin org create \
  --name "Acme Corp" \
  --domain "acmecorp.com" \
  --tier enterprise \
  --admin-email "admin@acmecorp.com"

This creates the organization and sends an invitation email to the admin.

Step 3: Deploy monitoring agents

Terminal window
docker run -d \
  --name govern-agent \
  -e GOVERN_API_KEY=gvn_live_xxxx \
  -e GOVERN_ORG_ID=org_xxxx \
  archetypal/govern-agent:latest

Deploy one agent per environment (production, staging, etc.).

Step 4: Verify end-to-end

Open the admin console and confirm:

  • Organization appears in the org list
  • At least one monitoring agent is reporting as online
  • The admin user has accepted their invitation

The organization is ready for governance practitioners to begin registration and policy configuration.