DocsAPI Reference

Requirements

Prerequisites for self-hosting Tokamak


Check these requirements before installing Tokamak.

Software

RequirementMinimum versionNotes
Docker24.xDocker Engine or Docker Desktop
Docker Composev2Included with Docker Desktop
GitAnyFor cloning the repository
MakeAnyThe documented workflow uses make targets

Hardware

These are guidance figures rather than measured limits — the Compose stack sets no CPU or memory constraints.

Development:

ResourceSuggested minimum
CPU2 cores
RAM4 GB
Disk10 GB

Production:

ResourceRecommended
CPU4+ cores
RAM8+ GB
Disk50+ GB (depends on media storage and request archives)

External requirements

RequirementRequiredNotes
PostgreSQL 18 with pgvectorYesBundled as the api-db container (pgvector/pgvector:pg18)
RedisNoOptional. Bundled as the redis container; core uses it only to share Claude Pool credential affinity across replicas (REDIS_URL)
At least one LLM provider API keyYesConfigured through the admin API once the stack is up
S3-compatible storageProduction onlyFor media and request archives. MinIO works.
An OIDC provider (Keycloak)NoOptional. Not started by the Compose stack — point at an existing installation, or use preview login in a local development environment.

Database schemas

Core, auth and billing each own a schema inside the same PostgreSQL database and create it on first boot. The schema names are configurable via TOKAMAK_CORE_DB_SCHEMA, TOKAMAK_AUTH_DB_SCHEMA and TOKAMAK_BILLING_DB_SCHEMA; the pgvector extension is installed automatically by core's first migration.

On this page