From c3c94ded110e7e268958928909984032b7b102af Mon Sep 17 00:00:00 2001 From: Pas <74743263+Pasithea0@users.noreply.github.com> Date: Mon, 7 Apr 2025 12:12:35 -0600 Subject: [PATCH] update some docs --- pages/client/deploy.mdx | 108 ++++++++++++++++++++-------------------- pages/index.tsx | 10 ++-- 2 files changed, 61 insertions(+), 57 deletions(-) diff --git a/pages/client/deploy.mdx b/pages/client/deploy.mdx index cb41cb7..8c3bfe0 100644 --- a/pages/client/deploy.mdx +++ b/pages/client/deploy.mdx @@ -4,59 +4,7 @@ title: 'Deploy' # Deploying the client -## Method 1 - Vercel - Recommended - - - - Click [here](https://github.com/sussy-code/smov/fork) to fork the P-Stream - Github repository - - - Click [here](https://vercel.com/) to go to Vercel - - Sign in using either a GitHub, GitLab, or Bitbucket. - - - Clicking the "New Project" button on the top right of your dashboard and - following the steps to create a new project for your self hosted version of - movie web. - - - - After clicking it, you'll be presented with a list of Git repositories that - the Git account you've signed up with has write access to. - - - - Select your own fork of the P-Stream Github repository. - - - - Configure the environment variables: - `VITE_CORS_PROXY_URL`: Enter your - proxy URL here. Make sure to not have a slash at the end of your URL. - Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): - `https://test-proxy.test.workers.dev` - `VITE_TMDB_READ_API_KEY`: Enter your - TMDB Read Access Token here. Please read [the TMDB page](./tmdb.mdx) on how - to get an API key. - `VITE_BACKEND_URL`: Only set if you have a self-hosted - backend. Put in your backend URL. Check out [configuration - reference](../client/configuration.mdx) for details. Make sure to not have a - slash at the end of the URL. - - - Click "Deploy" - - - Congrats! You have your own version of P-Stream hosted. - - - - You may wish to configure a custom domain - Please consult [the Vercel docs - for how to do - this](https://vercel.com/docs/getting-started-with-vercel/domains). - - - -## Method 2 - Cloudflare Pages (Best host) +## Method 1 - Cloudflare Pages (Best host) @@ -127,6 +75,58 @@ title: 'Deploy' +## Method 2 - Vercel (Might be broken idk) + + + + Click [here](https://github.com/sussy-code/smov/fork) to fork the P-Stream + Github repository + + + Click [here](https://vercel.com/) to go to Vercel + + Sign in using either a GitHub, GitLab, or Bitbucket. + + + Clicking the "New Project" button on the top right of your dashboard and + following the steps to create a new project for your self hosted version of + movie web. + + + + After clicking it, you'll be presented with a list of Git repositories that + the Git account you've signed up with has write access to. + + + + Select your own fork of the P-Stream Github repository. + + + + Configure the environment variables: - `VITE_CORS_PROXY_URL`: Enter your + proxy URL here. Make sure to not have a slash at the end of your URL. + Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): + `https://test-proxy.test.workers.dev` - `VITE_TMDB_READ_API_KEY`: Enter your + TMDB Read Access Token here. Please read [the TMDB page](./tmdb.mdx) on how + to get an API key. - `VITE_BACKEND_URL`: Only set if you have a self-hosted + backend. Put in your backend URL. Check out [configuration + reference](../client/configuration.mdx) for details. Make sure to not have a + slash at the end of the URL. + + + Click "Deploy" + + + Congrats! You have your own version of P-Stream hosted. + + + + You may wish to configure a custom domain - Please consult [the Vercel docs + for how to do + this](https://vercel.com/docs/getting-started-with-vercel/domains). + + + ## Method 3 - Static Web Host @@ -177,6 +177,8 @@ title: 'Deploy' ## Method 4 - Docker Compose - Home Network +Docker is not recommended! It's much easier to host the static site and use a proxy like nginx to access. + This method is meant for those using a desktop device or single board computer with a minimum of 4GB of RAM such as a [Raspberry Pi](https://www.raspberrypi.com/) to run P-Stream on there home network for network connected devices. diff --git a/pages/index.tsx b/pages/index.tsx index 26e18dc..ac22bdf 100644 --- a/pages/index.tsx +++ b/pages/index.tsx @@ -23,10 +23,12 @@ export default function LandingPage() { and open source, forever! - - +
+ + +