Documentation
The documentation portal is being built alongside the platform. Sections marked as planned will be filled in as the corresponding capabilities ship.
Spin up Kaporeal locally in under five minutes.
Docker, requirements, and first-time setup.
Environment variables and runtime configuration.
PostgreSQL setup, migrations, and backups.
Docker Compose, Kubernetes, and reverse proxies.
Auth, secrets, audit logging, and access control.
How loads move through the operational lifecycle.
Adopt and configure Kaporeal modules.
REST endpoints, payloads, and webhooks.
Operational scripts, seeds, and maintenance tasks.
End-to-end walkthroughs of common workflows.
Set up a dev environment and ship your first PR.
Open an issue or contribute a page. Documentation is shipped right alongside the codebase.