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

Merge pull request #73 from movie-web/feat/autoplay

Browse Source 
Add documentation for the `VITE_ALLOW_AUTOPLAY` environment variable
This commit is contained in:
William Oldham
2024-04-14 21:44:02 +01:00
committed by GitHub
parent 8cb77fd706 e1cb13704e
commit a53847ab8d
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
pages/client/configuration.mdx
View File

@@ -39,7 +39,7 @@ window.__CONFIG__ = {
This is the **read** API key from TMDB to allow movie-web to search for media. [Get one by following our guide](./tmdb.mdx).
<Caution>
**Required. The client will not work properly if this is not configured.**
**Required. The client will not work properly if this is not configured.**
</Caution>
### `VITE_CORS_PROXY_URL`
@@ -56,7 +56,7 @@ You can add multiple Workers by separating them with a comma, they will be load
**Worker URL entries must not end with a slash.**
<Caution>
**Required. The client will not work properly if this is not configured.**
**Required. The client will not work properly if this is not configured.**
</Caution>
### `VITE_DMCA_EMAIL`
@@ -128,6 +128,13 @@ When onboarding is enabled using `VITE_HAS_ONBOARDING`. This link will be used t
If omitted, this will still show the proxy onboarding screen, just without an documentation link for the proxy.
### `VITE_ALLOW_AUTOPLAY`
- Type: `boolean`
- Default: `false`
Whether to allow autoplay for users that use the host provided proxies.
### `VITE_DISALLOWED_IDS`
- Type: `string`
@@ -162,7 +169,8 @@ The [Turnstile key](https://dash.cloudflare.com/sign-up?to=/:account/turnstile)
## Config reference - Environment Variables Only
<Caution>
These configuration keys are specific to environment variables, they **only** work as environment variables **set at build time**.
These configuration keys are specific to environment variables, they **only**
work as environment variables **set at build time**.
</Caution>
### `VITE_PWA_ENABLED`
@@ -174,7 +182,8 @@ Set to `true` if you want to output a PWA application. Set to `false` or omit to
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.
<Warning>
Make sure you know what you're doing before enabling this, it **cannot be disabled** after you've set it up once.
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`
@@ -203,5 +212,5 @@ The value must include the protocol (HTTP/HTTPS) but must **not** end with a sla
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.
This field is case sensitive, make sure you use the correct casing.
</Warning>