mirror of
https://github.com/p-stream/docs.git
synced 2026-01-11 20:10:34 +00:00
113 lines
3.6 KiB
Text
113 lines
3.6 KiB
Text
---
|
|
title: 'Deploy'
|
|
---
|
|
|
|
# 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](./configuration.mdx).
|
|
|
|
## Method 1 - Docker Deployment
|
|
|
|
This method provides a straightforward setup with minimal configuration. For more extensive customization, see the [Configuration Reference](./configuration.mdx).
|
|
|
|
**Prerequisites**
|
|
|
|
- **Docker:** If you don't have Docker installed, download it from the official website: [Docker installation](https://www.docker.com/get-started)
|
|
**Setup**
|
|
|
|
<Steps>
|
|
<Steps.Step>
|
|
**Create `docker-compose.yml`:**
|
|
```yaml
|
|
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: bridge
|
|
```
|
|
**Important:**
|
|
* Replace `YourPasswordHere` with your secure database password.
|
|
* Generate a strong session secret and replace `32CharacterLongStringHere`.
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
**Start the Backend:** Open a terminal in the directory containing `docker-compose.yml` and execute:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
</Steps.Step>
|
|
</Steps>
|
|
|
|
### Accessing 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 2 - 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.
|
|
|
|
[](https://railway.com/deploy/pstreambackend?referralCode=zvXFZF)
|
|
|
|
<Steps>
|
|
<Steps.Step>
|
|
Login to your [Railway](https://railway.app) account if you have one,
|
|
otherwise create one [here](https://railway.app/login). - If you are signing
|
|
up, then verify your account by clicking the link in the email Railway sends
|
|
you. Ensure you setup your server location [here](https://railway.com/workspace)
|
|
to the closest one possible.
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
Click the [`Deploy on Railway`](https://railway.com/deploy/pstreambackend?referralCode=zvXFZF) button
|
|
above.
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
Click on configure For the one that says Backend.
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
Fill in the required variable META_NAME the rest are optional and can be set later on.
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
The `Deploy` button at the bottom of the template should be active, click on
|
|
it.
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
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)
|
|
</Steps.Step>
|
|
|
|
<Steps.Step>
|
|
Congratulations! You have deployed the backend, you can now [set up the
|
|
client](../self-hosting/use-backend.mdx).
|
|
</Steps.Step>
|
|
</Steps>
|