movie-web/docs
1
0
Fork 0
mirror of https://github.com/movie-web/docs.git synced 2025-09-13 00:43:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix links and anchors

Browse Source
This commit is contained in:
mrjvs
2024-03-31 03:02:57 +02:00
parent b5b8bb8de1
commit 561c3a04b3
13 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
pages/backend/changelog.mdx
View File

@@ -22,7 +22,7 @@ For this update, you will need to run migrations.
For this update, you will need to run migrations.
</Warning>
- [Added option to trust Cloudflare IP headers for ratelimits](./configuration.mdx#servertrustcloudflare)
- [Added option to trust Cloudflare IP headers for ratelimits](./configuration.mdx#server-trust-cloudflare)
- Removed unused table
- Optimized prometheus metrics, should make less indexes
@@ -32,5 +32,5 @@ For this update, you will need to run migrations.
- Account creation/deletion endpoints
- Endpoints for importing old account data
- Endpoints for syncing data
- [Ratelimit system](./configuration.mdx#ratelimit)
- [Ratelimit system](./configuration.mdx#ratelimits)
- [Captcha system](./configuration.mdx#captcha)

6
pages/backend/configuration.mdx
View File

@@ -14,7 +14,7 @@ These different config options are all mutually inclusive, so you can use multip
<Warning>
With any of these configurations, you have to have atleast three variables set for the server to function:
[`postgres.connection`](#postgresconnection), [`crypto.sessionSecret`](#cryptosessionsecret) and [`meta.name`](#metaname)
[`postgres.connection`](#postgres-connection-⚠), [`crypto.sessionSecret`](#crypto-session-secret-⚠) and [`meta.name`](#meta-name-⚠)
</Warning>
### Method 1 - `config.json`
@@ -67,7 +67,7 @@ Space separated list of allowed origins.
- Type: `boolean`
- Default: `false`
If set to true, it allows any origin to access the site. This overwrites the [`server.cors`](#servercors) setting.
If set to true, it allows any origin to access the site. This overwrites the [`server.cors`](#server-cors) setting.
### `server.trustProxy`
@@ -222,7 +222,7 @@ If this is enabled, all other captcha related settings are required.
All configuration options related to adding ratelimiting functionality. Helps to protect against bot attacks or spammy users.
<Note>
Make sure your IP headers are properly forwarded if you're using a reverse proxy. Also see [`server.trustProxy`](#servertrustproxy).
Make sure your IP headers are properly forwarded if you're using a reverse proxy. Also see [`server.trustProxy`](#server-trust-proxy).
</Note>
### `ratelimits.enabled`

2
pages/backend/deploy.mdx
View File

@@ -94,4 +94,4 @@ Railway offers you $5 of credit once you verify your account, which is enough to
1. Fill in the required variables or change the default values.
1. The `Deploy` button at the bottom of the template should be active, click on it.
1. 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)
1. Congratulations! You have deployed the backend, you can now [set up the client](../1.self-hosting/2.use-backend.md).
1. Congratulations! You have deployed the backend, you can now [set up the client](../self-hosting/use-backend.mdx).

2
pages/backend/introduction.mdx
View File

@@ -27,4 +27,4 @@ Optionally, there are a few security settings:
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#postgresmigrateonboot) variable and it will be automatically migrated on boot.
Alternatively, you can enable the [`postgres.migrateOnBoot`](./configuration.mdx#postgres-migrate-on-boot) variable and it will be automatically migrated on boot.

6
pages/client/configuration.mdx
View File

@@ -157,7 +157,7 @@ The format is `<beforeA>:<afterA>,<beforeB>:<afterB>,...`
The [Turnstile key](https://dash.cloudflare.com/sign-up?to=/:account/turnstile) for Cloudflare captchas. It's used to authenticate requests to proxy workers (or providers API).
[The proxy workers will need to be configured to accept these captcha tokens](../proxy/configuration.mdx#turnstile_secret), otherwise it has no effect for security.
[The proxy workers will need to be configured to accept these captcha tokens](../proxy/configuration.mdx#turnstile-secret), otherwise it has no effect for security.
## Config reference - Environment Variables Only
@@ -191,7 +191,7 @@ The Google Analytics ID for tracking user behavior. If omitted, no tracking will
- Default: `""`
- Example: `"https://movie-web.app"`
The domain where the app lives. Only required when having the [`VITE_OPENSEARCH_ENABLED`](#vite_opensearch_enabled) option enabled.
The domain where the app lives. Only required when having the [`VITE_OPENSEARCH_ENABLED`](#vite-opensearch-enabled) option enabled.
The value must include the protocol (HTTP/HTTPS) but must **not** end with a slash.
@@ -200,7 +200,7 @@ The value must include the protocol (HTTP/HTTPS) but must **not** end with a sla
- Type: `boolean`
- Default: `false`
Whether to enable [OpenSearch](https://developer.mozilla.org/en-US/docs/Web/OpenSearch), this allows a user to add a search engine to their browser. When enabling you **must** also set [`VITE_APP_DOMAIN`](#vite_app_domain).
Whether to enable [OpenSearch](https://developer.mozilla.org/en-US/docs/Web/OpenSearch), this allows a user to add a search engine to their browser. When enabling you **must** also set [`VITE_APP_DOMAIN`](#vite-app-domain).
<Warning>
This field is case sensitive, make sure you use the correct casing.

6
pages/extra/streaming.mdx
View File

@@ -17,13 +17,13 @@ Since this method uses your own IP, it is undetectable by streaming services, so
## 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**.
Self-hosting a proxy is an easy way to get faster streaming speeds, [we have a guide](../proxy/deploy.mdx) 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.
{/* This method is recommended if you want to host a proxy for your friends and family to use, or if you want to use movie-web on a device that doesn't support the [browser extension](#method-1---browser-extension), such as a smart TV or mobile device.*/}
1. Set up a proxy using one of our [guides](../proxy/deploy.mdx#deploying-the-proxy), [though we recommend Netlify](../proxy/deploy.mdx#method-1---netlify-easy).
1. Set up a proxy using one of our [guides](../proxy/deploy.mdx), [though we recommend Netlify](../proxy/deploy.mdx#method-1-netlify-easy).
2. Once that's done, go to the **Connections** section of the **Settings page** on your movie-web instance of chocie.
3. Enable `Use custom proxy workers` if it's not already enabled.
4. Add a new custom proxy by clicking `Add new worker`.
@@ -31,7 +31,7 @@ This method is recommended if you want to host a proxy for your friends and or f
![Example of settings page](/assets/proxy-url-example.gif)
<Note>
If you're self-hosting the client, you can use the [`VITE_CORS_PROXY_URL`](../client/configuration.mdx#vite_cors_proxy_url) variable to set the proxy URL for everyone who uses your client.
If you're self-hosting the client, you can use the [`VITE_CORS_PROXY_URL`](../client/configuration.mdx#vite-cors-proxy-url) variable to set the proxy URL for everyone who uses your client.
</Note>
## Method 2 - Public proxy

2
pages/instances.mdx
View File

@@ -8,7 +8,7 @@ This page showcases movie-web instances hosted by the community and other altern
## Community Instances
The community maintains these trusted instances, meaning they are likely to be up-to-date. Remember that since these are volunteer instances, they might be down or stop working at any time. If you want to be sure you have access to movie-web, consider [hosting your own instance](../1.self-hosting/1.hosting-intro.md).
The community maintains these trusted instances, meaning they are likely to be up-to-date. Remember that since these are volunteer instances, they might be down or stop working at any time. If you want to be sure you have access to movie-web, consider [hosting your own instance](../self-hosting/hosting-intro.mdx).
**Instances marked with a 💾 have set up a backend, making it possible to sync your data across multiple devices.**

2
pages/proxy/changelog.mdx
View File

@@ -18,7 +18,7 @@ title: 'Changelog'
# Version 2.1.0
- [Added Turnstile integration](./configuration.mdx#turnstile_secret) to secure your workers from abuse.
- [Added Turnstile integration](./configuration.mdx#turnstile-secret) to secure your workers from abuse.
# Version 2.0.1

2
pages/proxy/configuration.mdx
View File

@@ -16,7 +16,7 @@ Adding environment variables is different for every platform, [here's a guide on
Turnstile secret key from the [Cloudflare dashboard](https://dash.cloudflare.com/sign-up?to=/:account/turnstile).
<Warning>
Keep in mind that you will also need to [configure the Turnstile key on the client](../client/configuration.mdx#vite_turnstile_key) and **configure the [`JWT_SECRET`](#jwt_secret) below.**
Keep in mind that you will also need to [configure the Turnstile key on the client](../client/configuration.mdx#vite-turnstile-key) and **configure the [`JWT_SECRET`](#jwt-secret) below.**
</Warning>
### `JWT_SECRET`

6
pages/proxy/deploy.mdx
View File

@@ -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://<random-words>.netlify.app`. Right click the link, click `Copy link address`. [Now you'll just have to set up the client](../extra/streaming.md#method-1---self-hosted-proxy)!
1. Find the link of your site near the top of the page, it should look something like `https://<random-words>.netlify.app`. Right click the link, click `Copy link address`. [Now you'll just have to set up the client](../extra/streaming.mdx#method-1-self-hosted-proxy)!
## Method 2 - Cloudflare (Easy)
@@ -50,7 +50,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) 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) -> Proxy.
1. Use the URL you took note of and [set up a custom proxy in the client](../extra/streaming.mdx#method-1---self-hosted-proxy).
1. Use the URL you took note of and [set up a custom proxy in the client](../extra/streaming.mdx#method-1-self-hosted-proxy).
## Method 2 - Cloudflare (Manual)
@@ -88,7 +88,7 @@ Railway offers you $5 of credit once you verify your account, which is enough to
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](../extra/streaming.mdx#method-1---self-hosted-proxy).
1. Congratulations! You have deployed the proxy, [you can now set up the client](../extra/streaming.mdx#method-1-self-hosted-proxy).
## Method 4 - Docker

4
pages/self-hosting/about-pwa.mdx
View File

@@ -14,9 +14,9 @@ Enabling PWAs means that you cannot disable it again - Please only proceed if yo
## If you are running movie-web on a hosting platform such as Vercel
If your hosting is building movie-web from the source, you can enable PWAs using the [`VITE_PWA_ENABLED`](../client/configuration.mdx#vite_pwa_enabled) environment variable.
If your hosting is building movie-web from the source, you can enable PWAs using the [`VITE_PWA_ENABLED`](../client/configuration.mdx#vite-pwa-enabled) environment variable.
Setting [`VITE_PWA_ENABLED`](../client/configuration.mdx#vite_pwa_enabled) to `true` will generate a [service worker file](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#service_worker) and a [web app manifest](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#the_web_app_manifest) which enable the website to be installed from a [web browser both on Desktop and on Mobile](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#installation_from_the_web).
Setting [`VITE_PWA_ENABLED`](../client/configuration.mdx#vite-pwa-enabled) to `true` will generate a [service worker file](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#service_worker) and a [web app manifest](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#the_web_app_manifest) which enable the website to be installed from a [web browser both on Desktop and on Mobile](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Making_PWAs_installable#installation_from_the_web).
## If you are running movie-web using the .zip files

2
pages/self-hosting/hosting-intro.mdx
View File

@@ -9,7 +9,7 @@ title: 'Start self-hosting'
</Note>
Since movie-web has many different components, there are a few configurations of how you can host it. Each of these configurations has their own benefits, whether that be having complete control over your data or customizing your experience.
**If you don't know what to choose, go with [method 1.](#method-1---only-host-the-frontend)**
**If you don't know what to choose, go with [method 1.](#method-1-only-host-the-frontend)**
## Method 1 - Only host the frontend

8
pages/self-hosting/troubleshooting.mdx
View File

@@ -18,7 +18,7 @@ If the test fails, then you should recheck your credentials. [**Make sure you're
**This is likely a misconfigured Worker.** To make sure that the Workers are the issue, visit `/admin` or `/#/admin`, then click on the `Test workers` button.
You should have at least 1 Worker registered, if you don't, you should [deploy a worker](../proxy/deploy.mdx#method-1---cloudflare-easy) and [set it up in the client](../client/configuration.mdx#vite_cors_proxy_url).
You should have at least 1 Worker registered, if you don't, you should [deploy a worker](../proxy/deploy.mdx) and [set it up in the client](../client/configuration.mdx#vite-cors-proxy-url).
If any Worker fails the test, you should double check its URL and see if its up to date with the latest updates.
@@ -26,9 +26,9 @@ If any Worker fails the test, you should double check its URL and see if its up
**This is likely misconfigured or broken backend.** To verify that the backend is the issue, visit `/admin` or `/#/admin`, then click on the `Test backend` button.
If the backend is online and properly configured it should display the name and version of the backend. If the name and description of the test don't match your own instance, [make sure you have your backend URL set correctly.](../client/configuration.mdx#vite_backend_url)
If the backend is online and properly configured it should display the name and version of the backend. If the name and description of the test don't match your own instance, [make sure you have your backend URL set correctly.](../client/configuration.mdx#vite-backend-url)
If the test gives you an error, your [backend URL configuration option](../client/configuration.mdx#vite_backend_url) likely has a typo.
If the test gives you an error, your [backend URL configuration option](../client/configuration.mdx#vite-backend-url) likely has a typo.
If the version that shows up on your backend is not the latest version, you should update your backend to keep up with the latest changes.
@@ -38,7 +38,7 @@ It is likely that you haven't installed the PWA version of movie-web. Please rea
## I'm getting SSL issues when using a hosted postgres database
You are most likely missing the [`postgres.ssl`](../backend/configuration.mdx#postgresssl) variable on your backend, enable it and the connection should work.
You are most likely missing the [`postgres.ssl`](../backend/configuration.mdx#postgres-ssl) variable on your backend, enable it and the connection should work.
## Permission denied to set parameter "session_replication_role"