Backend
Deploying the backend#
The only officially recognized hosting method is through Docker (or similar container runtimes). It can be scaled horizontally to all your heart's content and is the safest way to host the backend.
For configuration, check out the configuration reference.
Method 1 - Cloudflare Deployment (Free + Easy)#
Prerequisites
- A Cloudflare account
- A GitHub account
Create a Cloudflare Worker for the backend In the Cloudflare Dashboard go to the sidebar, then click "Compute & AI" > "Workers and Pages"
Select "Create application" then click "Continue with GitHub"
If needed, link your GitHub account to your Cloudflare account.
Go to the backend repository click Star, to Star it :P then Fork the project by clicking Fork, then Create Fork.
In the Cloudflare dashboard select the GitHub repository you set for the
backend, it should set the build command as npm run build and deploy
command as node .output/server/index.mjs
Backend uses PostgreSQL as our database, so you need somewhere to host. I personally recommend Neon as they have a perfectly fine free tier. For larger deployments, it can be quite expensive, so have a backup strategy if you get a lot of users.
In the Neon dashboard click create project, give it a name, then click
Connect to your Database. It should give you a line like this: psql 'postgresql://neondb_owner:RANDOMSTUFFHERE@MORERANDOMSTUFF.c-2.us-east-1.aws.neon.tech/neondb?sslmode=require&channel_binding=require' Copy the url including the postgresql:// for the next step.
Set your Environment Variables. In the Cloudflare dashboard, go to your worker, go to settings, then click "Configure API token and other runtime variables" Now set your variables:
- CRYPTO_SECRET: Generate a random 32 character string and set that as the value
- DATABASE_URL: The long postgres:// string from earlier.
- META_NAME: Whatever you want the name to be, users will see it when they sign up
- META_DESCRIPTION: The description for your instance
Method 2 - Docker Deployment#
This method provides a straightforward setup with minimal configuration. For more extensive customization, see the Configuration Reference.
Prerequisites
- Docker: If you don't have Docker installed, download it from the official website: Docker installation Setup
Create docker-compose.yml:
services:
postgres:
image: postgres
environment:
POSTGRES_USER: pstream_user
POSTGRES_DB: pstream
POSTGRES_PASSWORD: YourPasswordHere
ports:
- "5432:5432"
networks:
- p-stream-network
p-stream:
image: ghcr.io/dumbutdumber/backend:latest
environment:
DATABASE_URL: postgresql://pstream_user:YourPasswordHere@postgres:5432/pstream
CRYPTO_SECRET: 32CharacterLongStringHere
META_NAME: unofficial-backend
ports:
- "80:80"
depends_on:
- postgres
networks:
- p-stream-network
networks:
p-stream-network:
driver: bridgeImportant:
- Replace
YourPasswordHerewith your secure database password. - Generate a strong session secret and replace
32CharacterLongStringHere.
Start the Backend: Open a terminal in the directory containing docker-compose.yml and execute:
docker-compose up -dAccessing Your Backend#
Your backend should be accessible on (YourPrivateIP):80. To share it outside your local network, you'll need to configure port forwarding or cloudflared tunnel.
Method 3 - Railway (Easy)#
Railway offers a 30-day free trial that includes a one-time $5 credit. After the trial, you receive $1 in usage credits for free each month.
Click the Deploy on Railway
button above.
Fill in the required variable META_NAME the rest are optional and can be set later on.
The Deploy button at the bottom of the template should be active, click on
it.
Once the Backend service has deployed, copy the URL from the Deployments
page. (Might take a second for it to be available after the service has
deployed)
Congratulations! You have deployed the backend, you can now set up the client.