60s Pull the image · supply an APP_KEY · open the admin UI

Install in three commands.

The Community Edition is one container. No license key, no phone-home, no telemetry.

Coming soonComing soon Full quick-start ↗
DOCKER · ONE-LINER

Just run it.

Defaults to SQLite at /data/database.sqlite — perfect for a quick try-out. Swap to Postgres via env vars for production.

Coming soonComing soon
DOCKER COMPOSE

Production-ish in one file.

The compose file ships PromptGate alongside Postgres + a named volume for the data path. Set APP_KEY + DB_PASSWORD in a sibling .env and you're done.

  • Postgres 16 (recommended for production)
  • Separate named volumes for app data + DB
  • Stays under one network bridge — nothing extra exposed
  • Add a reverse proxy (Caddy / Traefik) in front for TLS

Compose docs ↗

Coming soonComing soon
ENVIRONMENT

What to set, what to leave alone

The defaults work for most setups. Override what your environment needs.

APP_KEY required

Laravel app key. Generate once: openssl rand -base64 32 → base64:<value>. Used for credential encryption.

APP_URL required

Public URL of your PromptGate instance. Used in OAuth callbacks + audit links.

DB_CONNECTION required

sqlite | pgsql | mysql. Postgres recommended for production.

PG_EDITION

community (default) | cloud. Drives log retention defaults.

SSRF_ALLOWED_HOSTS

Comma-separated allowlist for internal hosts the SSRF guard would otherwise block.

SESSION_ENCRYPT

true (default). Encrypts session cookies at rest.

SESSION_SECURE_COOKIE

true once you serve the admin UI over HTTPS.

FIRST RUN

Five-step onboarding

The dashboard surfaces these as a checklist; each step ticks itself off automatically as you complete it.

  1. Create your first project. Pick a type — AI Gateway, AI Wrapper, Agent Proxy, API Gateway, or MCP Gateway. Type is fixed for the project's life.
  2. Add a provider credential. Drop in your OpenAI / Anthropic / Mistral / … API key. Encrypted at rest with your APP_KEY.
  3. Create your first endpoint. 7-tab wizard for AI Gateway endpoints; one-line for API Gateway proxies.
  4. Issue an API token. Bearer token your client uses. Pick the narrowest scope (chat, models, proxy, mcp, tokens:write).
  5. Send your first request. curl or open the Playground. The dashboard's "First request" step ticks once anything lands in gateway_logs.
Detailed first-run guide ↗

Stuck somewhere?

The docs are deeper. Or open an issue and we'll unblock you.

Documentation Coming soonComing soon Contact us