Skip to content

Installation

Quick start gets a pair of services running fast with one command each — install-gateway.sh and install-service.sh. A Docker one-liner is planned but not yet available; until then, Docker covers pulling the published images by hand. This section is the full reference to sit alongside quick start — everything from a local dev setup through to a production Kubernetes cluster, organized by how you actually intend to run this rather than crammed into one page.

  • Docker — pull the published images, docker run or docker compose for local evaluation.
  • Kubernetes — plain manifests for a real cluster, plus the two constraints (single replica, in-process migrations) worth knowing before you apply them.
  • Linux — from-source development setup, plus a systemd path for a plain VM with no container runtime.
  • macOS — the same from-source path as Linux today; called out separately since that may not stay true forever.
  • Windows — WSL2 today; native Windows support is on the roadmap, not yet available.

For the config file itself once something’s running — every field, the database decision, migrations — see Deployment.