Skip to content

docs: clarify Railway persistence setup #5607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
clockwork-labs-bot wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −1
Open

docs: clarify Railway persistence setup #5607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/docs/00300-resources/00100-how-to/00100-deploy/00300-railway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /how-to/deploy/railway

Railway is a hosted platform for deploying infrastructure and application services. If you want to run SpacetimeDB without managing your own VM, the official Railway template is a quick way to get started.

The template deploys the first-party `clockworklabs/spacetime` image, exposes port `3000`, and provisions persistent storage at `/stdb`. Once the service is running, you can publish one or more databases to it with the SpacetimeDB CLI.
The template deploys the first-party `clockworklabs/spacetime` image, exposes port `3000`, and provisions persistent storage at `/stdb`. The SpacetimeDB server data directory must be inside that volume, for example `/stdb/data`, so databases survive service redeploys. Once the service is running, you can publish one or more databases to it with the SpacetimeDB CLI.

## Prerequisites

Expand All @@ -28,6 +28,14 @@ Then:

That domain is the base URL your CLI and clients will use to connect to this SpacetimeDB instance.

Before publishing any databases, verify the service configuration:

- The Railway volume is mounted at `/stdb`.
- The SpacetimeDB start command includes `--data-dir=/stdb/data`.
- If the service cannot write to the volume, set `RAILWAY_RUN_UID=0` in the service variables and redeploy.

The template should configure the data directory for you, but check this setting if you edit the start command. If SpacetimeDB starts without a data directory under `/stdb`, Railway redeploys can discard published databases and other server state.

## Step 2: Add the Railway deployment to your CLI

Register your Railway deployment as a named server:
Expand Down
Loading