Skip to main content
Sign In
Platforms

Docker Container

Run Rivet Engine in a single Docker container.

Run with ephemeral storage:

Quick Start

docker run -p 6420:6420 rivetdev/engine

Run with persistent storage:

docker run \
  -p 6420:6420 \
  -v rivet-data:/data \
  -e RIVET__FILE_SYSTEM__PATH="/data" \
  rivetdev/engine

Configuration

Environment Variables

Configure Rivet using environment variables:

docker run -p 6420:6420 \
  -v rivet-data:/data \
  -e RIVET__POSTGRES__URL="postgresql://postgres:password@localhost:5432/db" \
  rivetdev/engine

Config File

Mount a JSON configuration file:

# Create config file
cat <<EOF > rivet-config.json
{
  "postgres": {
    "url": "postgresql://postgres:password@localhost:5432/db"
  }
}
EOF

# Run with mounted config
docker run -p 6420:6420 \
  -v rivet-data:/data \
  -v $(pwd)/rivet-config.json:/etc/rivet/config.json:ro \
  rivetdev/engine

Production Setup

With PostgreSQL

# Create network
docker network create rivet-net

# Run PostgreSQL
docker run -d \
  --name postgres \
  --network rivet-net \
  -e POSTGRES_DB=rivet \
  -e POSTGRES_USER=rivet \
  -e POSTGRES_PASSWORD=rivet_password \
  -v postgres-data:/var/lib/postgresql/data \
  postgres:15

# Run Rivet Engine
docker run -d \
  --name rivet-engine \
  --network rivet-net \
  -p 6420:6420 \
  -e RIVET__POSTGRES__URL="postgresql://rivet:rivet_password@postgres:5432/rivet" \
  rivetdev/engine

Next Steps

Edit this page