Deploy to Cloudflare

Run Session Relay on Cloudflare Workers, with no server to maintain. It's the same app as the Docker version, with the same features, CLI and web app. Pick whichever suits you:

#What you need

• A Cloudflare account. The free plan is enough for a small team; Workers Paid ($5/month) raises the request and CPU limits. Check Cloudflare's current pricing for Hyperdrive, R2 and Cron limits.
• A Postgres 14+ database reachable from the internet, e.g. a free Neon project. Copy its connection string (postgres://user:password@host/db?sslmode=require).
• Node.js 20+ and git on your laptop.
• For your own domain: the domain's DNS must be on Cloudflare. Without one, the Worker gets a free session-relay.<you>.workers.dev address.

#1. Get the code and build

git clone https://github.com/Ryrahul/session-relay.git
cd session-relay
npm ci && npm run build
npx wrangler login                    # opens the browser

#2. Create the database tables

DATABASE_URL="postgres://user:password@host/db?sslmode=require" \
  node packages/server/dist/db/migrate-cli.js

#3. Create Hyperdrive and R2

cd packages/server
npx wrangler hyperdrive create session-relay --caching-disabled \
  --connection-string="postgres://user:password@host/db?sslmode=require"
npx wrangler r2 bucket create session-relay-transcripts

--caching-disabled matters: Hyperdrive caches query results for 60 seconds by default, so an edit, a new comment or a settings change could look like it didn't save. Session Relay needs every read to be current. Already created one with caching? npx wrangler hyperdrive update <id> --caching-disabled.

#4. Configure

Edit packages/server/wrangler.jsonc:

• hyperdrive[0].id: the id printed by hyperdrive create

• vars.PUBLIC_URL: the address people will use, e.g. https://relay.your-team.com (or your workers.dev address)

• For a custom domain, add:

  "routes": [{ "pattern": "relay.your-team.com", "custom_domain": true }]
  

Then choose a first-run setup code and store it as a secret:

npx wrangler secret put SETUP_CODE          # e.g. type: KDQX-7MRA-4ZTP

#5. Deploy

npx wrangler deploy

Open your URL. It shows Set up Session Relay. Enter the setup code, your organization's name, and your name and email. You become the owner; your token is shown once.

Setup closes for good once an organization exists, but remove the secret anyway:

npx wrangler secret delete SETUP_CODE

Then invite your team from Members → Invite with a link, and everyone follows Getting started.

#Updating

git pull && npm ci && npm run build
DATABASE_URL="…" node packages/server/dist/db/migrate-cli.js     # migrations first
cd packages/server && npx wrangler deploy

Migrations are additive, so the running version keeps working while they apply. To undo a bad deploy: npx wrangler rollback.

#Backups

• Database: use your provider's backups (Neon keeps point-in-time history), or pg_dump "$DATABASE_URL" | gzip > relay-$(date +%F).sql.gz.
• Transcripts: R2 is durable. To keep a copy elsewhere, use rclone with R2's S3-compatible API.

#Moving from Docker to Cloudflare

1. On the Docker server, take a database backup:

   docker compose -f deploy/docker-compose.yml --env-file deploy/.env exec -T postgres pg_dump -U relay -d relay | gzip > relay.sql.gz
   

2. Restore it into the new Postgres. Skip step 2 of this guide; the dump already has the tables.

   gunzip -c relay.sql.gz | psql "$DATABASE_URL"
   

3. Copy full transcripts from the transcripts volume into R2:

   scripts/copy-transcripts-to-r2.sh /var/lib/docker/volumes/<project>_transcripts/_data session-relay-transcripts
   

4. Deploy (steps 3–5, without SETUP_CODE: your organization already exists).
5. Point your domain at the Worker. Everyone keeps their tokens. If the address changes, they run relay login --server <new url> once.

#Troubleshooting

Edit this page on GitHub