ContextQMD
Back to Rivet

Railway Deployment

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

2.2.12.9 KB
Original Source

import { TutorialVideo } from '@/components/TutorialVideo';

Video Tutorial

<TutorialVideo videoId="zk8ODYz8CrI" /> <Warning> PostgreSQL is the recommended backend for multi-node self-hosted deployments today, but it remains experimental. For a production-ready single-node Rivet deployment, use the file system backend (RocksDB-based). Enterprise teams can contact [enterprise support](https://rivet.dev/sales) about FoundationDB for the most scalable production-ready deployment. </Warning>

Quick Deploy

Choose the template that best fits your needs:

Rivet TemplateRivet Starter
Blank template to start freshComplete example with chat app
- Rivet Engine- Pre-configured Rivet Engine
- PostgreSQL database- Example chat application with Actors
- Basic configuration- PostgreSQL database
- Manual setup required- Rivet Inspector for debugging
- Ready to run immediately

You can also use the Rivet Railway template as a starting point for your application.

<Note> After deploying either template, you can find the `RIVET__AUTH__ADMIN_TOKEN` under the **Variables** tab in the Railway dashboard. This token is required to access the Rivet Inspector. </Note>

Manual Deployment

Prerequisites

  1. Railway account
  2. Railway CLI (optional)

Step 1: Create New Project

bash
# Using Railway CLI
railway init

# Or create via dashboard
# https://railway.app/new

Step 2: Add Services

Deploy PostgreSQL Database

  1. Click "New Service" → "Database" → "PostgreSQL"
  2. Railway automatically provisions and configures PostgreSQL
  3. Note the connection string from the service variables

Deploy Rivet Engine

  1. Click "New Service" → "Docker Image"
  2. Set image: rivetdev/engine:latest
  3. Configure environment variables:
    • RIVET__POSTGRES__URL=${{Postgres.DATABASE_URL}}

Step 3: Deploy Your Application

Follow the Railway Quick Start guide to deploy your repository:

  1. Connect your GitHub account to Railway
  2. Select your repository containing your Rivet application
  3. Railway will automatically detect and deploy your application
  4. Configure environment variables for your application:
    • RIVET_ENDPOINT=${{Rivet.RAILWAY_PRIVATE_DOMAIN}} - Points to the Rivet Engine service's private domain

Next Steps