Configuration
Environment Variables
This page documents all environment variables that configure RivetKit behavior.
Connection
| Environment Variable | Description |
|---|---|
RIVET_ENDPOINT | Endpoint URL to connect to Rivet Engine. Supports URL auth syntax. |
RIVET_ENGINE | Alternative to RIVET_ENDPOINT for engine connection |
RIVET_TOKEN | Authentication token for Rivet Engine |
RIVET_NAMESPACE | Namespace to use (default: “default”) |
Public Endpoint
These variables configure how clients connect to your actors.
| Environment Variable | Description |
|---|---|
RIVET_PUBLIC_ENDPOINT | Public endpoint for client connections. Supports URL auth syntax. |
RIVET_PUBLIC_TOKEN | Public token for client authentication |
Runner Configuration
| Environment Variable | Description |
|---|---|
RIVET_RUNNER | Runner name (default: “default”) |
RIVET_RUNNER_KEY | Authentication key for the runner |
RIVET_RUNNER_VERSION | Version number for the runner. See Versions & Upgrades. |
RIVET_RUNNER_KIND | Type of runner |
RIVET_TOTAL_SLOTS | Total actor slots available (default: 100000) |
Engine
| Environment Variable | Description |
|---|---|
RIVET_RUN_ENGINE | Set to 1 to spawn the engine process |
RIVET_RUN_ENGINE_VERSION | Version of engine to download |
Inspector
| Environment Variable | Description |
|---|---|
RIVET_INSPECTOR_TOKEN | Token for accessing the Rivet Inspector |
RIVET_INSPECTOR_DISABLE | Set to 1 to disable the inspector |
Logging
| Environment Variable | Description |
|---|---|
RIVET_LOG_LEVEL | Log level: trace, debug, info, warn, error, fatal, silent |
RIVET_LOG_TARGET | Set to 1 to include log target |
RIVET_LOG_TIMESTAMP | Set to 1 to include timestamps |
RIVET_LOG_MESSAGE | Set to 1 to include message formatting |
RIVET_LOG_ERROR_STACK | Set to 1 to include error stack traces |
RIVET_LOG_HEADERS | Set to 1 to log request headers |