gegentic/api repository overview

⁠Gegentic API

Gegentic is an AI governance platform for organisations that want to enforce policy guardrails, compliance checks, and audit trails over their AI usage. This image (gegentic/api) is the core backend service of a self-hosted Gegentic deployment — it's a stripped-down, license-gated build aimed at universities and training programs that want to teach AI governance concepts hands-on, without needing the full commercial platform.

This image is one piece of a multi-container stack. It will not run standalone — use the provided docker-compose.yml to bring up the full system.

⁠What this image is

gegentic/api serves:

• A REST API (port 4001) consumed by the gegentic/portal frontend and any external API clients
• A gRPC API (port 4002) used for internal service-to-service communication

It manages organisations, projects, governance policies, members, and routes guarded LLM traffic through the rest of the Gegentic stack (gateway, guardian, tracing).

⁠Full stack

The API does not run in isolation. A complete Gegentic deployment is a multi-container stack:

Get the full docker-compose.yml and .env.example from the Gegentic repository⁠ or registration package.

⁠Quick start

# 1. Register to get a license key
#    https://gegentic.com/gegentic/edu/register

# 2. Copy and fill in the environment file
cp .env.example .env
# edit .env: LICENSE_KEY, ORG_NAME, DB credentials, encryption keys, etc.

# 3. Bring up the stack
docker compose up -d

# Portal:  http://localhost:3000
# API:     http://localhost:4001
# Tracing: http://localhost:5001

⁠License

A LICENSE_KEY (JWT, issued after registering at gegentic.com/gegentic/edu/register⁠) is required at startup — the container will not boot without one. The corresponding public key used to verify the license is baked into the image at build time and cannot be overridden via environment variables or docker-compose.yml.

⁠Configuration

All runtime configuration is via environment variables — see .env.example for the full list, including:

• LICENSE_KEY — required, ties the deployment to your registered instance
• ORG_NAME — name shown in the portal and emails
• DB_USER / DB_PASSWORD / DB_NAME — Postgres credentials
• SUPERTOKENS_API_KEY — shared secret with the SuperTokens container
• ENCRYPT_KEY_FOR_API_KEY / ENCRYPT_KEY_FOR_VIRTUAL_KEY — encryption keys for stored credentials
• AWS_* — SES credentials for sending invite/notification emails
• ANALYTICS_ENABLED — opt out of anonymized license-lifecycle telemetry (no org data or PII is collected)

A handful of build-time-only settings (the license public key, the analytics key) are intentionally baked into the image and are not configurable at runtime — this keeps them from being tampered with or disabled by editing docker-compose.yml.

⁠Tags

• latest — most recent stable release

⁠Documentation

For full setup instructions, configuration reference, and usage guides, see the docs at docs.gegentic.com⁠.

⁠Support

This image is intended for educational/training use. For issues with the Gegentic edition, see the documentation at gegentic.com⁠.