Reference
Environment Variables
Connect a node to a Rivet control plane with environment variables for endpoints, authentication, node pools and the local control plane.
These variables wire your process to a Rivet control plane. Variables that configure the RivetKit SDK itself, including logging, storage, and the inspector, are listed in Environment Variables in the Actors docs.
Connection
| Environment Variable | Description |
|---|---|
RIVET_ENDPOINT | Endpoint URL to connect to Rivet control plane. Supports URL auth syntax. |
RIVET_TOKEN | Authentication token for Rivet control plane |
RIVET_NAMESPACE | Namespace to use (default: “default”) |
Nodes
| Environment Variable | Description |
|---|---|
RIVET_POOL | Node pool to join (default: “default”). See Architecture. |
RIVET_ENVOY_VERSION | Version number of this node. Increase it on every deploy. See Versions & Upgrades. |
Local Control Plane
In development, RivetKit starts a local control plane for you. These variables override that behavior.
| Environment Variable | Description |
|---|---|
RIVET_RUN_ENGINE | Set to 1 to start a local control plane |
RIVET_RUN_ENGINE_HOST | Host the local control plane binds to. Defaults to 127.0.0.1. |
RIVET_RUN_ENGINE_PORT | Port the local control plane binds to. Defaults to 6420. |
RIVET_RUN_ENGINE_VERSION | Version of the local control plane to download |
RIVET_RUN_SERVICES | Set to 1 to run Services with the local control plane, or 0 to disable it. By default, Services runs whenever the local control plane does. |
RIVET_SERVICES_BINARY | Path to a local rivet-services binary. |