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

Small fixes.

Browse Source
This commit is contained in:
qtchaos
2023-12-31 17:01:56 +02:00
parent 42ff0204a5
commit 5f75fe66a9
2 changed files with 15 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
content/3.client/3.configuration.md
View File

@@ -33,18 +33,21 @@ window.__CONFIG__ = {
### `VITE_TMDB_READ_API_KEY` ⚠ ### `VITE_TMDB_READ_API_KEY` ⚠
- 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](../3.client/2.tmdb.md#getting-an-api-key). This is the **read** API key from TMDB to allow movie-web to search for media. [Get one by following our guide](../3.client/2.tmdb.md#getting-an-api-key).
::alert{type="danger"} ::alert{type="danger"}
**Required. The client will not work properly if this is not configured.** **Required. The client will not work properly if this is not configured.**
:: ::
Example: `get-your-own-api-key`
Default: N/A
### `VITE_CORS_PROXY_URL` ⚠ ### `VITE_CORS_PROXY_URL` ⚠
- Type: `string`
- Default: `""`
- Example: `"https://example1.example.com,https://example2.example.com"`
This is where you put proxy URLS, you must have at least one. [Get one by following our guide](../2.proxy/1.deploy.md#method-1---cloudflare-easy). This is where you put proxy URLS, you must have at least one. [Get one by following our guide](../2.proxy/1.deploy.md#method-1---cloudflare-easy).
You can add multiple Workers by separating them with a comma, they will be load balanced using round robin method on the client. You can add multiple Workers by separating them with a comma, they will be load balanced using round robin method on the client.
@@ -54,20 +57,19 @@ You can add multiple Workers by separating them with a comma, they will be load
**Required. The client will not work properly if this is not configured.** **Required. The client will not work properly if this is not configured.**
:: ::
Example: `"https://example1.example.com,https://example2.example.com"`
Default: N/A
### `VITE_DMCA_EMAIL` ### `VITE_DMCA_EMAIL`
- Type: `string`
- Default: `""`
- Example: `"dmca@example.com"`
This is the DMCA email for on the DMCA page. If this config value is present, a new page will be made and linked in the footer, where it will mention how to handle DMCA take-down requests. If the configuration value is left empty, the page will not exist. This is the DMCA email for on the DMCA page. If this config value is present, a new page will be made and linked in the footer, where it will mention how to handle DMCA take-down requests. If the configuration value is left empty, the page will not exist.
Example: `"dmca@example.com"`
Default: `""`
### `VITE_NORMAL_ROUTER` ### `VITE_NORMAL_ROUTER`
- Type: `boolean`
- Default: `false`
The application has two routing modes: hash-router and history-router. The application has two routing modes: hash-router and history-router.
Hash router means that every page is linked with a hash like so: `https://example.com/#/browse`. Hash router means that every page is linked with a hash like so: `https://example.com/#/browse`.
@@ -75,10 +77,6 @@ History router does routing without a hash like so: `https://example.com/browse`
Setting this configuration value to `true` will enable the history-router. Setting this configuration value to `true` will enable the history-router.
Example: `true`
Default: `false`
### `VITE_BACKEND_URL` ### `VITE_BACKEND_URL`
- Type: `string` - Type: `string`

2
content/4.backend/2.configuration.md
View File

@@ -100,7 +100,7 @@ All configurations related to how the HTTP server will log. This is not related
### `logging.format` ### `logging.format`
- Type: `string` | `"pretty" | "json"` - Type: `string` | `"pretty"` | `"json"`
- Default: `"pretty"` - Default: `"pretty"`
Logging format to use, should be either `pretty` or `json`, most users should probably use the default. Logging format to use, should be either `pretty` or `json`, most users should probably use the default.