mirror of
https://github.com/movie-web/docs.git
synced 2025-09-13 09:03:27 +00:00
Make all pages MDX compliant + added logo back
This commit is contained in:
mrjvs
@@ -113,17 +113,17 @@ title: 'Changelog'
|
||||
|
||||
# Version 4.2.5
|
||||
|
||||
::alert{type="warning"}
|
||||
<Warning>
|
||||
This release requires a new version of simple-proxy: 2.1.3
|
||||
::
|
||||
</Warning>
|
||||
|
||||
- Update provider package, with fixes for febbox-mp4
|
||||
|
||||
# Version 4.2.4
|
||||
|
||||
::alert{type="warning"}
|
||||
<Warning>
|
||||
This release requires a new version of simple-proxy: 2.1.1
|
||||
::
|
||||
</Warning>
|
||||
|
||||
- Add meta tag for PWA's for apple devices
|
||||
- Add galician flag
|
||||
@@ -221,9 +221,9 @@ This release requires a new version of simple-proxy: 2.1.1
|
||||
|
||||
# Version 4.0.0
|
||||
|
||||
::alert{type="info"}
|
||||
If you are upgrading from a previous version, make sure to read [the upgrade guide](5.upgrade.md).
|
||||
::
|
||||
<Note>
|
||||
If you are upgrading from a previous version, make sure to read [the upgrade guide](./upgrade.mdx).
|
||||
</Note>
|
||||
|
||||
### Bug fixes
|
||||
|
||||
|
||||
@@ -36,11 +36,11 @@ window.__CONFIG__ = {
|
||||
- Type: `string`
|
||||
- Default: `""`
|
||||
|
||||
This is the **read** API key from TMDB to allow movie-web to search for media. [Get one by following our guide](/client/tmdb).
|
||||
This is the **read** API key from TMDB to allow movie-web to search for media. [Get one by following our guide](./tmdb.mdx).
|
||||
|
||||
::alert{type="danger"}
|
||||
<Caution>
|
||||
**Required. The client will not work properly if this is not configured.**
|
||||
::
|
||||
</Caution>
|
||||
|
||||
### `VITE_CORS_PROXY_URL`
|
||||
|
||||
@@ -48,16 +48,16 @@ This is the **read** API key from TMDB to allow movie-web to search for media. [
|
||||
- Default: `""`
|
||||
- Example: `"https://example1.example.com,https://example2.example.com"`
|
||||
|
||||
This is where you put proxy URLs. [Get some by following our guides](/proxy/deploy).
|
||||
This is where you put proxy URLs. [Get some by following our guides](../proxy/deploy.mdx).
|
||||
|
||||
If left empty, the client onboarding will not provide a "default setup" and the user will have to manually configure their own proxy or use the extension.
|
||||
|
||||
You can add multiple Workers by separating them with a comma, they will be load balanced using round robin method on the client.
|
||||
**Worker URL entries must not end with a slash.**
|
||||
|
||||
::alert{type="danger"}
|
||||
<Caution>
|
||||
**Required. The client will not work properly if this is not configured.**
|
||||
::
|
||||
</Caution>
|
||||
|
||||
### `VITE_DMCA_EMAIL`
|
||||
|
||||
@@ -73,7 +73,7 @@ This is the DMCA email for on the DMCA page. If this config value is present, a
|
||||
- Default: `false`
|
||||
|
||||
The application has two routing modes: hash-router and history-router.
|
||||
Hash router means that every page is linked with a hash like so: <code style="overflow-wrap: anywhere">https://example.com/#/browse</code>.
|
||||
Hash router means that every page is linked with a hash like so: `https://example.com/#/browse`.
|
||||
|
||||
History router does routing without a hash like so: `https://example.com/browse`, this looks a lot nicer, but it requires that your hosting environment supports Single-Page-Application (SPA) redirects (Vercel supports this feature). If you don't know what that means, don't enable this.
|
||||
|
||||
@@ -87,7 +87,7 @@ Setting this configuration value to `true` will enable the history-router.
|
||||
|
||||
This is the URL for the movie-web backend server which handles cross-device syncing.
|
||||
|
||||
The backend server can be found at https://github.com/movie-web/backend and is offered as a [Docker](https://docs.docker.com/get-started/overview/){target="\_blank"} image for deployment.
|
||||
The backend server can be found at https://github.com/movie-web/backend and is offered as a [Docker](https://docs.docker.com/get-started/overview/) image for deployment.
|
||||
|
||||
Backend URL must **not** end with a slash.
|
||||
|
||||
@@ -144,7 +144,7 @@ The list is comma separated, you can add as many as needed.
|
||||
|
||||
- Type: `string`
|
||||
- Default: `""`
|
||||
- Example: <code style="overflow-wrap: anywhere">"google.com:example.com,123movies.com:flixhq.to"</code>
|
||||
- Example: `"google.com:example.com,123movies.com:flixhq.to"`
|
||||
|
||||
Sometimes you want to proxy a CDN. This is how you can easily replace a CDN URL with your own.
|
||||
|
||||
@@ -155,15 +155,15 @@ The format is `<beforeA>:<afterA>,<beforeB>:<afterB>,...`
|
||||
- Type: `string`
|
||||
- Default: `""`
|
||||
|
||||
The [Turnstile key](https://dash.cloudflare.com/sign-up?to=/:account/turnstile){target="\_blank"} for Cloudflare captchas. It's used to authenticate requests to proxy workers (or providers API).
|
||||
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](../2.proxy/2.configuration.md#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
|
||||
|
||||
::alert{type="danger"}
|
||||
:icon{name="material-symbols:warning-rounded"} These configuration keys are specific to environment variables, they **only** work as environment variables **set at build time**.
|
||||
::
|
||||
<Caution>
|
||||
These configuration keys are specific to environment variables, they **only** work as environment variables **set at build time**.
|
||||
</Caution>
|
||||
|
||||
### `VITE_PWA_ENABLED`
|
||||
|
||||
@@ -173,9 +173,9 @@ The [Turnstile key](https://dash.cloudflare.com/sign-up?to=/:account/turnstile){
|
||||
Set to `true` if you want to output a PWA application. Set to `false` or omit to get a normal web application.
|
||||
A PWA web application can be installed as an application to your phone or desktop computer, but can be tricky to manage and comes with a few footguns.
|
||||
|
||||
::alert{type="warning"}
|
||||
<Warning>
|
||||
Make sure you know what you're doing before enabling this, it **cannot be disabled** after you've set it up once.
|
||||
::
|
||||
</Warning>
|
||||
|
||||
### `VITE_GA_ID`
|
||||
|
||||
@@ -200,8 +200,8 @@ 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){target="\_blank"}, 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).
|
||||
|
||||
::alert{type="warning"}
|
||||
:icon{name="material-symbols:warning-rounded"} This field is case sensitive, make sure you use the correct casing.
|
||||
::
|
||||
<Warning>
|
||||
This field is case sensitive, make sure you use the correct casing.
|
||||
</Warning>
|
||||
|
||||
@@ -17,9 +17,9 @@ title: 'Deploy'
|
||||
|
||||
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](2.tmdb.md) on how to get an API key.
|
||||
- `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](../4.client/2.configuration.md) for details. Make sure to not have a slash at the end of the URL.
|
||||
- `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.
|
||||
|
||||
1. Click "Deploy"
|
||||
1. Congrats! You have your own version of movie-web hosted.
|
||||
@@ -34,14 +34,14 @@ title: 'Deploy'
|
||||
|
||||
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `VITE_CORS_PROXY_URL: "https://test-proxy.test.workers.dev"`
|
||||
|
||||
5. Put your TMDB Read Access Token inside the quotes of `VITE_TMDB_READ_API_KEY: ""`. Please read [the TMDB page](2.tmdb.md) on how to get an API key.
|
||||
6. If you have a self-hosted backend server, enter your URL in the `VITE_BACKEND_URL` variable. Check out [configuration reference](../4.client/2.configuration.md) for details. Make sure to not have a slash at the end of the URL.
|
||||
5. Put your TMDB Read Access Token inside the quotes of `VITE_TMDB_READ_API_KEY: ""`. Please read [the TMDB page](./tmdb.mdx) on how to get an API key.
|
||||
6. If you have a self-hosted backend server, enter your URL in the `VITE_BACKEND_URL` variable. Check out [configuration reference](../client/configuration.mdx) for details. Make sure to not have a slash at the end of the URL.
|
||||
7. Save the file.
|
||||
8. Upload **all** of the files to a static website hosting such as:
|
||||
- GitHub Pages
|
||||
- Netlify
|
||||
- Vercel
|
||||
- Etc, [there are lots of options](https://www.staticwebsitehosting.org/){target="\_blank"}.
|
||||
- Etc, [there are lots of options](https://www.staticwebsitehosting.org/).
|
||||
9. Congrats! You have your own version of movie-web hosted.
|
||||
|
||||
## Method 3 - Docker Compose - Home Network
|
||||
@@ -74,8 +74,8 @@ services:
|
||||
|
||||
Example (THIS IS AN EXAMPLE, IT WON'T WORK FOR YOU): `CORS_PROXY_URL: "https://test-proxy.test.workers.dev"`
|
||||
|
||||
4. Put your TMDB Read Access Token inside the quotes of `TMDB_READ_API_KEY: ""`. Please read [the TMDB page](2.tmdb.md) on how to get an API key.
|
||||
5. Uncomment and add any [additional environment variables](3.configuration.md) you may need. Remove the `VITE_` prefix when adding an environment variable to `args`.
|
||||
4. Put your TMDB Read Access Token inside the quotes of `TMDB_READ_API_KEY: ""`. Please read [the TMDB page](./tmdb.mdx) on how to get an API key.
|
||||
5. Uncomment and add any [additional environment variables](configuration.mdx) you may need. Remove the `VITE_` prefix when adding an environment variable to `args`.
|
||||
6. Save the file!
|
||||
7. Now use [docker](https://docs.docker.com/get-docker/) to run `movieweb` as background service.
|
||||
|
||||
|
||||
@@ -8,10 +8,10 @@ The client is what users sees when navigating to your domain, it's the main part
|
||||
|
||||
## Progressive Web App
|
||||
|
||||
The client can be optionally ran as a [PWA](https://web.dev/explore/progressive-web-apps), which allows it to be installed on a mobile device. **This can be hard to do correctly and really hard if not almost impossible to reverse**, so it's generally not recommended to do so if you don't have experience hosting PWAs. If you understand the risks and still want to continue, then read more about it [here](../1.self-hosting/3.about-pwa.md).
|
||||
The client can be optionally ran as a [PWA](https://web.dev/explore/progressive-web-apps), which allows it to be installed on a mobile device. **This can be hard to do correctly and really hard if not almost impossible to reverse**, so it's generally not recommended to do so if you don't have experience hosting PWAs. If you understand the risks and still want to continue, then read more about it [here](../self-hosting/about-pwa.mdx).
|
||||
|
||||
## Configuration
|
||||
|
||||
The client features various configuration options, some of which are required for the client to function. [If you are using Vercel to host the client](1.deploy.md#method-1-vercel-recommended), then the required variables are a necessary part of creating the site, if you're using another host, or hosting it for yourself, you'll need to set them up yourself.
|
||||
The client features various configuration options, some of which are required for the client to function. [If you are using Vercel to host the client](./deploy.mdx#method-1-vercel-recommended), then the required variables are a necessary part of creating the site, if you're using another host, or hosting it for yourself, you'll need to set them up yourself.
|
||||
|
||||
You can view all of the configuration options on the [configurations page](3.configuration.md).
|
||||
You can view all of the configuration options on the [configurations page](./configuration.mdx).
|
||||
|
||||
@@ -4,11 +4,11 @@ title: 'TMDB API Key'
|
||||
|
||||
# Getting an API Key
|
||||
|
||||
In order to search for movies and TV shows, we use an API called ["The Movie Database" (TMDB)](https://www.themoviedb.org/){target="\_blank"}. For your client to be able to search, you need to generate an API key for yourself.
|
||||
In order to search for movies and TV shows, we use an API called ["The Movie Database" (TMDB)](https://www.themoviedb.org/). For your client to be able to search, you need to generate an API key for yourself.
|
||||
|
||||
::alert{type="info"}
|
||||
<Note>
|
||||
The API key is **free**, you just need to create an account.
|
||||
::
|
||||
</Note>
|
||||
|
||||
1. Create an account at https://www.themoviedb.org/signup
|
||||
1. You will be required to verify your email; click the link that you get sent to verify your account.
|
||||
|
||||
@@ -58,7 +58,7 @@ git push -f # Force push to your origin main branch
|
||||
|
||||
## From `3.X` to `4.X`
|
||||
|
||||
You will need the latest version of the proxy worker. Redeploy a new worker using [our self-hosting guide](../2.proxy/1.deploy.md).
|
||||
You will need the latest version of the proxy worker. Redeploy a new worker using [our self-hosting guide](../proxy/deploy.md).
|
||||
|
||||
After you have the new worker, you will need to [get the new movie-web deployment files](https://github.com/movie-web/movie-web/releases/latest). **You CANNOT use the non-PWA version**. To upgrade safely without any complications, you need to update with `movie-web.pwa.zip`, Not the non-PWA version.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user