Back to Rivet

File System

website/src/content/docs/self-hosting/filesystem.mdx

2.2.11.5 KB
Original Source
<Warning> For a production-ready single-node Rivet deployment, use the file system backend (RocksDB-based); for multi-node deployments, PostgreSQL is the recommended backend today but remains experimental as we evaluate the best fit for scalability and performance, and Enterprise teams can contact [enterprise support](https://rivet.dev/sales) about FoundationDB. </Warning>

Configuration

<CodeGroup>
json
{
  "database": {
    "file_system": {
      "path": "/var/lib/rivet/data"
    }
  }
}
bash
RIVET__database__file_system__path="/var/lib/rivet/data"
</CodeGroup>

Default Paths

If no path is specified, Rivet uses platform-specific default locations:

  • Linux: ~/.local/share/rivet-engine/db
  • macOS: ~/Library/Application Support/rivet-engine/db
  • Windows: %APPDATA%\rivet-engine\db

When running in a container or as a service, the path defaults to ./data/db relative to the working directory.

When to Use File System

The file system backend is ideal for:

  • Local development
  • Single-node deployments
  • Testing and prototyping
  • Air-gapped environments without database infrastructure

If you need a production-ready Rivet deployment today, use this backend for smaller single-node setups; for multi-node deployments, PostgreSQL is the recommended backend today though still experimental, and Enterprise teams can contact enterprise support about FoundationDB for the most scalable production-ready deployment.