From a3beda41eda3eea0debd1a02b6defb62bd74899b Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Tue, 5 Aug 2025 22:32:56 +0200 Subject: [PATCH] refac CORS_ALLOW_CUSTOM_SCHEME Fix "Default" description, add more details about what this env var does --- docs/getting-started/env-configuration.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index ee992221..00bf4b7a 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -1043,8 +1043,20 @@ Read more about `offline mode` in this [guide](/docs/tutorials/offline-mode.md). #### `CORS_ALLOW_CUSTOM_SCHEME` - Type `str` -- Default `` -- Description: Sets a list of further allowed schemes for Cross-Origin Resource Sharing (CORS). +- Default: `""` (empty string) +- Description: Sets a list of further allowed schemes for Cross-Origin Resource Sharing (CORS). Allows you to specify additional custom URL schemes, beyond the standard `http` and `https`, that are permitted as valid origins for Cross-Origin Resource Sharing (CORS). + +:::info + +This is particularly useful for scenarios such as: + - Integrating with desktop applications that use custom protocols (e.g., `app://`, `custom-app-scheme://`). + - Local development environments or testing setups that might employ non-standard schemes (e.g., `file://` if applicable, or `electron://`). + +Provide a semicolon-separated list of scheme names without the `://`. For example: `app;file;electron;my-custom-scheme`. + +When configured, these custom schemes will be validated alongside `http` and `https` for any origins specified in `CORS_ALLOW_ORIGIN`. + +::: #### `RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE`