diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index faa6200..f44aed4 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -13,7 +13,7 @@ As new variables are introduced, this page will be updated to reflect the growin :::info -This page is up-to-date with Open WebUI release version [v0.6.5](https://github.com/open-webui/open-webui/releases/tag/v0.6.5), but is still a work in progress to later include more accurate descriptions, listing out options available for environment variables, defaults, and improving descriptions. +This page is up-to-date with Open WebUI release version [v0.6.9](https://github.com/open-webui/open-webui/releases/tag/v0.6.9), but is still a work in progress to later include more accurate descriptions, listing out options available for environment variables, defaults, and improving descriptions. ::: @@ -236,7 +236,7 @@ This will run the Open WebUI on port `9999`. The `PORT` environment variable is - Description: List of banners to show to users. The format for banners are: ```json -[{"id": "string","type": "string [info, success, warning, error]","title": "string","content": "string","dismissible": False,"timestamp": 1000}] +[{"id": "string", "type": "string [info, success, warning, error]", "title": "string", "content": "string", "dismissible": false, "timestamp": 1000}] ``` - Persistence: This environment variable is a `PersistentConfig` variable. @@ -255,8 +255,7 @@ WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Your message - Type: `bool` - Default: `False` -- Description: Builds the Docker image with NVIDIA CUDA support. Enables GPU acceleration -for local Whisper and embeddings. +- Description: Builds the Docker image with NVIDIA CUDA support. Enables GPU acceleration for local Whisper and embeddings. #### `EXTERNAL_PWA_MANIFEST_URL` @@ -1275,6 +1274,7 @@ When using Pinecone as the vector store, the following environment variables are - Type: `str` - Options: - Leave empty to use default + - `external` - Use external loader - `tika` - Use a local Apache Tika server - `docling` - Use Docling engine - `document_intelligence` - Use Document Intelligence engine @@ -1289,6 +1289,20 @@ When using Pinecone as the vector store, the following environment variables are - Description: Specifies the Mistral OCR API key to use. - Persistence: This environment variable is a `PersistentConfig` variable. +#### `EXTERNAL_DOCUMENT_LOADER_URL` + +- Type: `str` +- Default: `None` +- Description: Sets the URL for the external document loader service. +- Persistence: This environment variable is a `PersistentConfig` variable. + +#### `EXTERNAL_DOCUMENT_LOADER_API_KEY` + +- Type: `str` +- Default: `None` +- Description: Sets the API key for authenticating with the external document loader service. +- Persistence: This environment variable is a `PersistentConfig` variable. + #### `TIKA_SERVER_URL` - Type: `str` @@ -1470,6 +1484,18 @@ When configuring `RAG_FILE_MAX_SIZE` and `RAG_FILE_MAX_COUNT`, ensure that the v ::: +#### `RAG_ALLOWED_FILE_EXTENSIONS` + +- Type: `list` of `str` +- Default: `[]` (which means all supported file types are allowed) +- Description: Specifies which file extensions are permitted for upload. + +```json +["pdf,docx,txt"] +``` + +- Persistence: This environment variable is a `PersistentConfig` variable. + #### `RAG_RERANKING_MODEL` - Type: `str` @@ -1587,21 +1613,21 @@ Strictly return in JSON format: #### `RAG_EMBEDDING_CONTENT_PREFIX` -- Type: +- Type: `str` - Default: `None` - Description: Specifies the prefix for the RAG embedding content. - Persistence: This environment variable is a `PersistentConfig` variable. #### `RAG_EMBEDDING_PREFIX_FIELD_NAME` -- Type: +- Type: `str` - Default: `None` - Description: Specifies the field name for the RAG embedding prefix. - Persistence: This environment variable is a `PersistentConfig` variable. #### `RAG_EMBEDDING_QUERY_PREFIX` -- Type: +- Type: `str` - Default: `None` - Description: Specifies the prefix for the RAG embedding query. - Persistence: This environment variable is a `PersistentConfig` variable. @@ -1662,7 +1688,7 @@ When enabling `GOOGLE_DRIVE_INTEGRATION`, ensure that you have configured `GOOGL - Type: `bool` - Default: `False` -- Description: Enable web search toggle +- Description: Enable web search toggle. - Persistence: This environment variable is a `PersistentConfig` variable. #### `ENABLE_SEARCH_QUERY_GENERATION` @@ -1880,7 +1906,7 @@ the search query. Example: `http://searxng.local/search?q=` - Default: `safe_web` - Description: Specifies the loader to use for retrieving and processing web content. - Options: - - '' - Uses the `requests` module with enhanced error handling. + - `requests` - Uses the Requests module with enhanced error handling. - `playwright` - Uses Playwright for more advanced web page rendering and interaction. - Persistence: This environment variable is a `PersistentConfig` variable. @@ -2436,8 +2462,7 @@ Strictly return in JSON format: - Type: `bool` - Default: `False` - Description: If enabled, merges OAuth accounts with existing accounts using the same email -address. This is considered unsafe as not all OAuth providers will verify email addresses and can lead to -potential account takeovers. +address. This is considered unsafe as not all OAuth providers will verify email addresses and can lead to potential account takeovers. - Persistence: This environment variable is a `PersistentConfig` variable. #### `OAUTH_UPDATE_PICTURE_ON_LOGIN` @@ -2465,13 +2490,13 @@ See https://support.google.com/cloud/answer/6158849?hl=en #### `GOOGLE_CLIENT_ID` - Type: `str` -- Description: Sets the client ID for Google OAuth +- Description: Sets the client ID for Google OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. #### `GOOGLE_CLIENT_SECRET` - Type: `str` -- Description: Sets the client secret for Google OAuth +- Description: Sets the client secret for Google OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. #### `GOOGLE_OAUTH_SCOPE` @@ -2485,7 +2510,7 @@ See https://support.google.com/cloud/answer/6158849?hl=en - Type: `str` - Default: `/oauth/google/callback` -- Description: Sets the redirect URI for Google OAuth +- Description: Sets the redirect URI for Google OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. ### Microsoft @@ -2495,19 +2520,19 @@ See https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-registe #### `MICROSOFT_CLIENT_ID` - Type: `str` -- Description: Sets the client ID for Microsoft OAuth +- Description: Sets the client ID for Microsoft OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. #### `MICROSOFT_CLIENT_SECRET` - Type: `str` -- Description: Sets the client secret for Microsoft OAuth +- Description: Sets the client secret for Microsoft OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. #### `MICROSOFT_CLIENT_TENANT_ID` - Type: `str` -- Description: Sets the tenant ID for Microsoft OAuth +- Description: Sets the tenant ID for Microsoft OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. #### `MICROSOFT_OAUTH_SCOPE` @@ -2521,7 +2546,7 @@ See https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-registe - Type: `str` - Default: `/oauth/microsoft/callback` -- Description: Sets the redirect URI for Microsoft OAuth +- Description: Sets the redirect URI for Microsoft OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. ### GitHub @@ -2531,7 +2556,7 @@ See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-o #### `GITHUB_CLIENT_ID` - Type: `str` -- Description: Sets the client ID for GitHub OAuth +- Description: Sets the client ID for GitHub OAuth. - Persistence: This environment variable is a `PersistentConfig` variable. #### `GITHUB_CLIENT_SECRET` @@ -2559,13 +2584,13 @@ See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-o #### `OAUTH_CLIENT_ID` - Type: `str` -- Description: Sets the client ID for OIDC +- Description: Sets the client ID for OIDC. - Persistence: This environment variable is a `PersistentConfig` variable. #### `OAUTH_CLIENT_SECRET` - Type: `str` -- Description: Sets the client secret for OIDC +- Description: Sets the client secret for OIDC. - Persistence: This environment variable is a `PersistentConfig` variable. #### `OPENID_PROVIDER_URL` @@ -2777,7 +2802,7 @@ See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-o #### `USER_PERMISSIONS_CHAT_CONTROLS` -- Type: `str` +- Type: `bool` - Default: `True` - Description: Enables or disables user permission to access chat controls. - Persistence: This environment variable is a `PersistentConfig` variable. @@ -2805,14 +2830,14 @@ See https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-o #### `USER_PERMISSIONS_CHAT_STT` -- Type: `str` +- Type: `bool` - Default: `True` - Description: Enables or disables user permission to use Speech-to-Text in chats. - Persistence: This environment variable is a `PersistentConfig` variable. #### `USER_PERMISSIONS_CHAT_TTS` -- Type: `str` +- Type: `bool` - Default: `True` - Description: Enables or disables user permission to use Text-to-Speech in chats. - Persistence: This environment variable is a `PersistentConfig` variable. @@ -2998,7 +3023,7 @@ These variables are not specific to Open WebUI but can still be valuable in cert - Type: `str` - Default: `False` - Description: Enables S3 object tagging after uploads for better organization, searching, and integration with file management policies. Always set to `False` when using Cloudflare R2, as R2 does not support object tagging. -- + #### Google Cloud Storage #### `GOOGLE_APPLICATION_CREDENTIALS_JSON`