From 5f75fe66a9a728dedbe8f44fbff0e9c55a9d7933 Mon Sep 17 00:00:00 2001 From: qtchaos <72168435+qtchaos@users.noreply.github.com> Date: Sun, 31 Dec 2023 17:01:56 +0200 Subject: [PATCH] Small fixes. --- content/3.client/3.configuration.md | 30 +++++++++++++--------------- content/4.backend/2.configuration.md | 2 +- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/content/3.client/3.configuration.md b/content/3.client/3.configuration.md index 3c452bc..526598a 100644 --- a/content/3.client/3.configuration.md +++ b/content/3.client/3.configuration.md @@ -33,18 +33,21 @@ window.__CONFIG__ = { ### `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). ::alert{type="danger"} **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` ⚠ +- 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). 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.** :: -Example: `"https://example1.example.com,https://example2.example.com"` - -Default: N/A - ### `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. -Example: `"dmca@example.com"` - -Default: `""` - ### `VITE_NORMAL_ROUTER` +- Type: `boolean` +- 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: `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. -Example: `true` - -Default: `false` - ### `VITE_BACKEND_URL` - Type: `string` diff --git a/content/4.backend/2.configuration.md b/content/4.backend/2.configuration.md index 0e8b43d..502c348 100644 --- a/content/4.backend/2.configuration.md +++ b/content/4.backend/2.configuration.md @@ -100,7 +100,7 @@ All configurations related to how the HTTP server will log. This is not related ### `logging.format` -- Type: `string` | `"pretty" | "json"` +- Type: `string` | `"pretty"` | `"json"` - Default: `"pretty"` Logging format to use, should be either `pretty` or `json`, most users should probably use the default.