Skip to content

docs(self-host): use the 3.0 storage config section - #172

Open
SheaHawkins wants to merge 1 commit into
rivet-dev:mainfrom
SheaHawkins:docs/self-host-storage-config
Open

SheaHawkins wants to merge 1 commit into
rivet-dev:mainfrom
SheaHawkins:docs/self-host-storage-config

Conversation

@SheaHawkins

@SheaHawkins SheaHawkins commented Nov 3, 2026 •

Copy link
Copy Markdown

Summary

Rivet 3.0 renamed the control plane's depot config section to storage, and auto_provision_tablets to auto_provision_partitions. The config rejects unknown fields, so the configs in the self-host guides stop the engine at startup:

Error: failed to deserialize config
    unknown field `depot`, expected one of `auth`, `guard`, `storage`, `object_storage`, `api_peer`, `pegboard`, `epoxy`, `logs`, `topology`, `pubsub`, `telemetry`, `runtime`, `metrics`, `outbound`

This affects both forms the guides use:

  • the JSON "depot" block: Docker Compose, VM, Hetzner;
  • RIVET__DEPOT__* environment variables: Kubernetes, AWS ECS, Railway, Render.

Changes

Change Pages
RIVET__DEPOT__LOG_DIRECTORY → RIVET__STORAGE__LOG_DIRECTORY, and the AUTO_PROVISION_* / BALANCING__ENABLED variables kubernetes, aws-ecs, railway, render
"depot" → "storage", auto_provision_tablets → auto_provision_partitions docker-compose, vm, hetzner
depot.log_directory → storage.log_directory, depot.cold_store.disk_cache_directory → storage.cold_store.disk_cache_directory configuration, custom, production-checklist, storage
Note that an S3-compatible endpoint over plain http:// needs AWS_ALLOW_HTTP=true storage

Testing

  • Ran rivetdev/engine:3.0.0 and rivetdev/engine:next (3.0.1-preview.1) with the Docker Compose guide's config, and with RIVET__DEPOT__LOG_DIRECTORY. Both exit with the error above.
  • With the renamed keys, both start and /health returns {"status":"ok", ...}.
  • Checked every renamed key against engine/artifacts/config-schema.json at v3.0.0.

Rivet 3.0 renamed the control plane's `depot` config section to `storage`
and `auto_provision_tablets` to `auto_provision_partitions`. The config
rejects unknown fields, so every self-host guide's config stopped the
engine at startup:

    Error: failed to deserialize config
        unknown field `depot`, expected one of `auth`, `guard`, `storage`, ...

That happens for both forms the guides use, the JSON `"depot"` block
(Docker Compose, VM, Hetzner) and `RIVET__DEPOT__*` variables (Kubernetes,
AWS ECS, Railway, Render), on rivetdev/engine:3.0.0 and :next
(3.0.1-preview.1). With the renamed keys the engine starts and /health
reports ok.

Also notes that an S3-compatible `endpoint` over plain http:// needs
AWS_ALLOW_HTTP=true.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant