diff --git a/pages/backend/configuration.mdx b/pages/backend/configuration.mdx index 7ca6ca7..6e64d50 100644 --- a/pages/backend/configuration.mdx +++ b/pages/backend/configuration.mdx @@ -4,9 +4,8 @@ title: 'Configuration' # Backend Config Reference -The backend can be configured in 3 different ways: +The backend can be configured in 2 different ways: -- Make a `config.json` file in the working directory of the application (root of repository) - Make a `.env` file in the working directory of the application (root of repository) - Add environment variables to your system (or container) @@ -14,105 +13,51 @@ These different config options are all mutually inclusive, so you can use multip With any of these configurations, you have to have atleast three variables set - for the server to function: [`postgres.connection`](#postgres-connection-⚠), - [`crypto.sessionSecret`](#crypto-session-secret-⚠) and - [`meta.name`](#meta-name-⚠) + for the server to function: [`DATABASE_URL`](#postgres-connection-⚠), + [`CRYPTO_SECRET`](#crypto-session-secret-⚠) and + [`META_NAME`](#meta-name-⚠) -### Method 1 - `config.json` - -This method uses nesting, so the key `server.basePath` with the value of `"/backend"` will result in a file that looks like this: - -```json -{ - "server": { - "basePath": "/backend" - } -} -``` - -### Method 2 - `.env` - -The environment variable names use double underscores as separators and `MWB_` as the prefix. So the key `server.basePath` will result in the .env file like this: - +### Method 1 - `.env` +Example: ```sh -MWB_SERVER__BASE_PATH=/backend +CRYPTO_SECRET=6abkbIoK3CPU6EVI2wa26WG26VCb7z8v ``` -### Method 3 - Environment +### Method 2 - Environment This method is identical to the `.env` method listed above, but you add the variables to the environment instead of writing it in a file. # Reference - -## Server - -All configurations related to the HTTP server. - -### `server.port` - -- Type: `number` -- Default: `8080` - -Port number that the HTTP server listens on. - -### `server.cors` - -- Type: `string` -- Default: `""` -- Example: `"https://pstream.org https://testing.pstream.org"` - -Space separated list of allowed origins. - -### `server.allowAnySite` - -- Type: `boolean` -- Default: `false` - -If set to true, it allows any origin to access the site. This overwrites the [`server.cors`](#server-cors) setting. - -### `server.trustProxy` - -- Type: `boolean` -- Default: `false` - -Controls whether the server should trust reverse proxy headers. This is used to identify users for ratelimiting. - -### `server.trustCloudflare` - -- Type: `boolean` -- Default: `false` - -Controls whether the server should trust Cloudflare IP headers. This is used to identify users for ratelimiting. - -### `server.basePath` - -- Type: `string` -- Default: `"/"` - -Prefix for which path is being listened on. Useful if you're hosting on `example.com/backend` for example. - -If this is set, you shouldn't apply URL rewriting before proxying. - -## Logging - -All configurations related to how the HTTP server will log. This is not related to the [metrics](./introduction.mdx#metrics) endpoint. - -### `logging.format` - -- Type: `string` | `"pretty"` | `"json"` -- Default: `"pretty"` - -Logging format to use, should be either `pretty` or `json`, most users should probably use the default. - ## Postgres -All configurations related to how postgres functions. +### `PG_USER +- Type: `string` +- Example: `pstream_user` -### `postgres.connection` ⚠ +Username for Postgres + +### PG_PASSWORD +- Type: `string` +- Example: `Iamaweakpassword` + +Password for Postgres using something strong. Generate one [here](https://www.random.org/strings/) + +### PG_DB +- Type: `string` +- Example: `p-stream_backend` + +Database name for Postgres + +## Backend + +All configurations related to how the backend functions. + +### `DATABASE_URL` ⚠ - Type: `string` -- Example: `"postgresql://localhost:5432"` +- Example: `postgresql://pstream_user:6abkbIoK3CPU6EVI2wa26WG26VCb7z8ve@localhost:5432/p-stream_backend` +- Str: postgresql://PG_USER:PG_PASSWORD@postgres(or localhost):PGPORT/PG_DB Connection URL for postgres instance, should contain the database in the URL. @@ -120,43 +65,15 @@ Connection URL for postgres instance, should contain the database in the URL. **Required. The backend will not start if this is not configured.** -### `postgres.migrateOnBoot` - -- Type: `boolean` -- Default: `false` - -Run all [migrations](./introduction.mdx#migrations) that haven't ran yet on boot. - - - If you have multiple replicas running, this can cause a lot of issues. We - recommend only using this if you run only one replica. - - -### `postgres.debugLogging` - -- Type: `boolean` -- Default: `false` - -Log all postgres queries in the console. Useful for debugging issues with the database. - -This outputs sensitive, **DO NOT** run it in production. - -### `postgres.ssl` - -- Type: `boolean` -- Default: `false` - -Enable SSL for postgres connections. Useful if you're using a hosted postgres database. - ## Cryptography All configurations related to cryptography. -### `crypto.sessionSecret` ⚠ +### `CRYPTO_SECRET` ⚠ - Type: `string` -The secret used to sign sessions. **Must be at least 32 characters long.** +The secret used to sign sessions. **Must be at least 32 characters long. [Generate here](https://www.random.org/strings/)** **Required. The backend will not start if this is not configured.** @@ -166,7 +83,7 @@ The secret used to sign sessions. **Must be at least 32 characters long.** These options configure how the server will display itself to the frontend. -### `meta.name` ⚠ +### `META_NAME` ⚠ - Type: `string` - Example: `"Unofficial backend"` @@ -177,7 +94,7 @@ The name of the backend instance, this will be displayed to users who try to cre **Required. The backend will not start if this is not configured.** -### `meta.description` +### `META_DESCRIPTION` - Type: `string` - Default: `""` @@ -189,7 +106,7 @@ The description of the backend instance, this will be displayed to users who try All configurations related to adding captcha functionality. Captchas' help to protect your server from bot attacks. -### `captcha.enabled` +### `CAPTCHA` - Type: `boolean` - Default: `false` @@ -200,7 +117,7 @@ Enables [Recaptcha](https://www.google.com/recaptcha/about/) support for user re If this is enabled, all other captcha related settings are required. -### `captcha.secret` +### `CAPTCHA_CLIENT_KEY` - Type: `string` - Default: `""` @@ -208,38 +125,30 @@ Enables [Recaptcha](https://www.google.com/recaptcha/about/) support for user re [Google Recaptcha](https://www.google.com/recaptcha/about/) secret key. -### `captcha.clientKey` +## TMBD +All configurations related to adding a private TMBD key. +Get your [TMBD API KEY](https://www.themoviedb.org/settings/api). + +### `TMDB_API_KEY` - Type: `string` - Default: `""` -- Example: `"2jf853z5bc63bvDb2323FAda"` +- Example: `"sjgaJ@3djasFVefihdjasidygyuiiii9382222222222ahdlx"` -[Google Recaptcha](https://www.google.com/recaptcha/about/) site key. +## TRAKT -## Ratelimits - -All configuration options related to adding ratelimiting functionality. Helps to protect against bot attacks or spammy users. - - - Make sure your IP headers are properly forwarded if you're using a reverse - proxy. Also see [`server.trustProxy`](#server-trust-proxy). - - -### `ratelimits.enabled` - -- Type: `boolean` -- Default: `false` - -Enables ratelimiting some more expensive endpoints. - - - If this is enabled, all other ratelimit related settings are required. - - -### `ratelimits.redisUrl` +### `TRAKT_CLIENT_ID` - Type: `string` - Default: `""` -- Example: `"redis://localhost:6379"` +- Example: `"sjgaJ@3djasFVefihdjasidygyuiiii9382222222222ahdlx"` + +### `TRAKT_CLIENT_SECRET` + +- Type: `string` +- Default: `""` +- Example: `"sjgaJ@3djasFVefihdjasidygyuiiii9382222222222ahdlx"` + +Get your [TRAKT API KEY](https://trakt.tv/oauth/applications). +Click New Application after you've logged in, enter the name of the app, which doesnt matter, and for redirect url, just do https://google.com, it doesnt matter. -Redis connection URL for storing ratelimit data. You can use a plain redis instance for this, no modules are required. diff --git a/pages/backend/deploy.mdx b/pages/backend/deploy.mdx index f20f838..b2fe2a0 100644 --- a/pages/backend/deploy.mdx +++ b/pages/backend/deploy.mdx @@ -2,21 +2,12 @@ title: 'Deploy' --- -# NOTICE! This is for the old backend. We are working on the docs to deploy backend v2! -You can use the [community backend](https://server.fifthwit.net) or deploy from https://github.com/p-stream/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](./configuration.mdx). - - The postgres database will need to be populated with - [migrations](./introduction.mdx#migrations) if `postgres.migrateOnBoot` isn't - enabled. - - ## Method 1 - Docker Deployment This method provides a straightforward setup with minimal configuration. For more extensive customization, see the [Configuration Reference](./configuration.mdx). @@ -24,34 +15,29 @@ This method provides a straightforward setup with minimal configuration. For mor **Prerequisites** - **Docker:** If you don't have Docker installed, download it from the official website: [Docker installation](https://www.docker.com/get-started) -- **Docker Compose:** Install Docker Compose following the instructions for your operating system: [Docker-Compose installation](https://docs.docker.com/compose/install/) - **Setup** **Create `docker-compose.yml`:** ```yaml - version: '3.8' services: postgres: image: postgres environment: - POSTGRES_USER: movie_web_user - POSTGRES_DB: movie_web_backend + POSTGRES_USER: pstream_user + POSTGRES_DB: pstream POSTGRES_PASSWORD: YourPasswordHere ports: - "5432:5432" networks: - p-stream-network p-stream: - image: ghcr.io/p-stream/backend:latest + image: ghcr.io/dumbutdumber/backend:latest environment: - MWB_POSTGRES__CONNECTION: postgresql://movie_web_user:YourPasswordHere@postgres:5432/movie_web_backend - MWB_CRYPTO__SESSION_SECRET: 32CharacterLongStringHere - MWB_META__NAME: unofficial-backend - MWB_POSTGRES__MIGRATE_ON_BOOT: "true" - MIKRO_ORM_MIGRATIONS_DISABLE_FOREIGN_KEYS: "true" + DATABASE_URL: postgresql://pstream_user:YourPasswordHere@postgres:5432/pstream + CRYPTO_SECRET: 32CharacterLongStringHere + META_NAME: unofficial-backend ports: - "80:80" depends_on: @@ -81,42 +67,32 @@ This method provides a straightforward setup with minimal configuration. For mor 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. -### Optional: Implementing a Reverse Proxy - -To enhance your SSL and domain configuration, it's advisable to establish a reverse proxy, such as Nginx. For an optimal choice in this regard, Cloudflare Zero Trust Tunnel is recommended. You can find more information [here](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/). - -- If you decide to utilize a reverse proxy, it's important to include `MWB_SERVER__CORS: "https://movie.example.com"` in your configuration. - - `MWB_SERVER__CORS` must contain a **space-separated** list of origins (Protocol + Hostname) for the client to be able to access the backend. -- Depending on your specific setup, you may also require the addition of `MWB_SERVER__TRUST_PROXY: true` and `MWB_SERVER__TRUST_CLOUDFLARE: true`. - ## Method 2 - Railway (Easy) -Railway offers you $5 of credit once you verify your account, which is enough to run the backend for around 5 months (~$0.90 per month). +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. -[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/hbgO43) +[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/deploy/pstreambackend?referralCode=zvXFZF) 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. - If you created your account with an email, then to verify your - account further, go to your account, then plans and verify your account with - a GitHub account. + you. Ensure you setup your server location [here](https://railway.com/workspace) + to the closest one possible. - Click the [`Deploy on Railway`](https://railway.app/template/TS4mw5) button + Click the [`Deploy on Railway`](https://railway.com/deploy/pstreambackend?referralCode=zvXFZF) button above. - If a `Configure` button is displayed, click on it and allow Railway to - access your GitHub account. + Click on configure For the one that says Backend. - Fill in the required variables or change the default values. + Fill in the required variable META_NAME the rest are optional and can be set later on. diff --git a/pages/backend/introduction.mdx b/pages/backend/introduction.mdx index 087093a..83b9c04 100644 --- a/pages/backend/introduction.mdx +++ b/pages/backend/introduction.mdx @@ -8,22 +8,21 @@ The backend is essentially just an account server. It handles user accounts, syn ## Recommended Community Backend -I recommend using the [official-backend](https://backend.undi.rest)! +I recommend using the [official-backend](https://server.fifthwit.net/)! ## Metrics The backend exposes an endpoint for [Prometheus metrics](https://prometheus.io/) which allows you to keep track of the backend more easily, it can be accessed on `/metrics`. -To view these metrics properly, you'll need to use an analytics program like [Grafana](https://grafana.com/), [which can visualize logs from Prometheus](https://prometheus.io/docs/visualization/grafana/). +Ex: https://server.fifthwit.net/metrics + +To view these metrics properly, you can use the [P-Stream Metrics Dash](https://dash.pstream.mov/). + + This dash is not functioning properly right now. It does work but certain information + can be wrong or outdated. This will be fixed soon + ## Security -Optionally, there are a few security settings: +Optionally, is a security setting: - [Recaptcha support](./configuration.mdx#captcha), the server can verify Recaptcha v3 tokens on register and login. -- [Ratelimits](./configuration.mdx#ratelimits), some expensive endpoints have ratelimits, but only when enabled. This requires an additional redis connection. - -## Migrations - -Migrations help keep your database schema in sync with everyone else. To run migrations, you can use the `pnpm migration:up` command inside the docker container or in your command-line if you're not using docker. - -Alternatively, you can enable the [`postgres.migrateOnBoot`](./configuration.mdx#postgres-migrate-on-boot) variable and it will be automatically migrated on boot.