diff --git a/app.config.ts b/app.config.ts index 5aeb3be..4a4d504 100644 --- a/app.config.ts +++ b/app.config.ts @@ -13,7 +13,6 @@ export default defineAppConfig({ owner: 'movie-web', branch: 'master', dir: 'content', - edit: true, }, aside: { level: 0, diff --git a/content/2.proxy/1.deploy.md b/content/2.proxy/1.deploy.md index eedf052..ef1a005 100644 --- a/content/2.proxy/1.deploy.md +++ b/content/2.proxy/1.deploy.md @@ -16,7 +16,7 @@ Netlify has a very generous free plan, so you'll be able to host your proxy for 1. There should now be a `Save & Deploy` button, click it. 1. Once the deployment is complete, click on the `Get Started` button that pops up, this will redirect you to the dashboard of your site. 1. Click on the only site in the `Sites` section of your dashboard. -1. Find the link of your site near the top of the page, it should look something like `https://.netlify.app`. Right click the link, click `Copy link address`. Now you'll just have to set up the client! +1. Find the link of your site near the top of the page, it should look something like `https://.netlify.app`. Right click the link, click `Copy link address`. [Now you'll just have to set up the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy)! ## Method 2 - Cloudflare (Easy) @@ -46,6 +46,7 @@ Cloudflare has a generous free plan, so you don't need to pay anything unless yo 1. Congratulations! Your worker is now deploying. Please wait for the GitHub Action to build and publish your worker. 1. You can click the [`Worker dash`](https://dash.cloudflare.com/sign-up?to=/:account/workers-and-pages){target="\_blank"} and `GitHub repo` buttons to see the status of the deploy. 1. When the worker has deployed, you will need to take note of the URL. This can be found on Cloudflare under [Workers and Pages -> Overview](https://dash.cloudflare.com/sign-up?to=/:account/workers-and-pages){target="\_blank"} -> Proxy. +1. Use the URL you took note of and [set up a custom proxy in the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy). ## Method 2 - Cloudflare (Manual) @@ -64,7 +65,7 @@ Cloudflare has a generous free plan, so you don't need to pay anything unless yo 1. The `Save and deploy` button in the top right corner should now be active, click it to deploy your proxy! 1. A confirmation dialog will appear, click `Save and deploy` once more. 1. Your worker is now deployed! You can click the back button in the top left to take you back to the summary screen. -1. On the summary screen, your worker link will be displayed under `Preview`. Right click the link, click `Copy link address` and save the link somewhere - you will need it to set up the client! +1. On the summary screen, your worker link will be displayed under `Preview`. Right click the link, click `Copy link address` and save the link somewhere - [you will need it to set up the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy)! ## Method 3 - Railway (Easy) @@ -76,10 +77,10 @@ Railway offers you $5 of credit once you verify your account, which is enough to 1. If you are signing up, then verify your account by clicking the link in the email Railway sends you. 1. 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. 1. Click the [`Deploy on Railway`](https://railway.app/template/dyYHq1) button above. -1. If a `Configure` button is displayed, click on it and allow Railway to access your GitHub account. +1. If a `Configure` button is displayed, click on it and allow Railway to access your GitHub account. 1. The `Deploy` button at the bottom of the template should be active, click on it. 1. Once the proxy has deployed, copy the URL from the `Deployments` page. -1. Congratulations! You have deployed the proxy, you can now set up the client. +1. Congratulations! You have deployed the proxy, [you can now set up the client](../5.extra/1.streaming.md#method-1---self-hosted-proxy). ## Method 4 - Docker diff --git a/content/5.extra/1.streaming.md b/content/5.extra/1.streaming.md new file mode 100644 index 0000000..a2c1c42 --- /dev/null +++ b/content/5.extra/1.streaming.md @@ -0,0 +1,42 @@ +--- +title: 'Streaming' +--- + +# Streaming + +This page explains all the different ways you can enable movie-web to stream your favorite movies & TV shows, each with their own pros and cons. + + + +## Method 1 - Self-hosted proxy + +Self-hosting a proxy is an easy way to get faster streaming speeds, [we have a guide](../2.proxy/1.deploy.md) that explains how to set up one for **free**. + +This method is recommended if you want to host a proxy for your friends and or family to use, as it is the faster than using the public proxy and the most reliable way to stream media at the moment. + + + +1. Set up a proxy using one of our [guides](../2.proxy/1.deploy.md#deploying-the-proxy), [though we recommend Netlify](../2.proxy/1.deploy.md#method-1---netlify-easy). +2. Once that's done, go to the [Connections](https://movie-web.app/settings#settings-connection){target="\_blank"} section of the [Settings page](https://movie-web.app/settings){target="\_blank"} on [movie-web](https://movie-web.app){target="\_blank"}. +3. Enable `Use custom proxy workers` if it's not already enabled. +4. Add a new custom proxy by clicking `Add new worker`. +5. Copy the URL of the proxy you deployed before, and paste it into the empty text box. +![Example of settings page](/assets/proxy-url-example.gif) + +::alert{type="info"} +If you're self-hosting the client, you can use the [`VITE_CORS_PROXY_URL`](../3.client/3.configuration.md#vite_cors_proxy_url) variable to set the proxy URL for everyone who uses your client. +:: + +## Method 2 - Public proxy + +The public proxy is the easiest way to get started with movie-web as it is the default, it is hosted by us and is completely free to use. + +If you are using the main website, then you are most likely already using the public proxy. Unfortunately you will most likely be getting slower speeds and your video might be buffering more often, which is why we recommend using a self-hosted proxy if you can. + +This is not the case with self-hosted clients, there is no proxy set up by default on self-hosted clients and you will need to [set up one yourself](../2.proxy/1.deploy.md). diff --git a/content/5.extra/_dir.yml b/content/5.extra/_dir.yml new file mode 100644 index 0000000..e620a8a --- /dev/null +++ b/content/5.extra/_dir.yml @@ -0,0 +1,4 @@ +title: 'Extra' +icon: mdi:information-variant-circle-outline +navigation.redirect: /extra/streaming +titleTemplate: '%s | Extra' diff --git a/public/assets/proxy-url-example.gif b/public/assets/proxy-url-example.gif new file mode 100644 index 0000000..bccec70 Binary files /dev/null and b/public/assets/proxy-url-example.gif differ