Skip to main content

Control Plane

Run the service that routes, schedules, and persists on your own infrastructure.

The control plane is stateful. It needs persistent storage and a stable network identity, which is why it cannot run on serverless platforms.

WorkerWorkerControl planeroute, schedule, persistStorage

Standing one up is four decisions:

  1. A platform to run the container on. Pick from the guides below.
  2. A storage backend. File system for a single node, PostgreSQL for multi-node. See Storage.
  3. An admin token, so the API and dashboard are not open. See Configuration.
  4. A reverse proxy that tolerates long-lived WebSockets. See Ports.

Picking a platform

If you wantUse
The fastest path from nothing to runningDocker Compose
A production deployment you will scaleKubernetes
A managed platform with the least setupRailway
AWS, on FargateAWS ECS
A Linux host you already ownVM & bare metal
Anything elseCustom platform

Trying it locally

One command, no persistence, useful only for a look around:

docker run -p 6420:6420 rivetdev/engine

Open http://localhost:6420/ui for the dashboard. For anything you intend to keep, start from a platform guide instead: this container writes to a path inside itself that disappears when the container does.

Next steps