floodgate@localhost:/docs/getting-started
File: floodgate.info,Node: Getting Started,Next: Configuration,Prev: (dir),Up: docs

Getting Started

Floodgate refuses to start without an explicit JWT secret — there is no default that would quietly leave a deployment unauthenticated.

run directly
FLOODGATE_JWT_SECRET=dev-secret gleam run
or as a container
  • docker compose up -d --wait — starts on http://localhost:3000
  • docker compose logs -f floodgate
  • docker compose down -v

FLOODGATE_JWT_SECRET also seeds the startup tenant (FLOODGATE_TENANT_ID, default fluid) with that value as its first secret slot — see Multi-tenancy for what that tenant can do beyond boot. Once it's up, GET /health answers {"status":"ok"}, and the full set of knobs for the listen address, storage backend, and connection limits lives in Configuration.

↑ Up: docsNext: Configuration →