From e69f972fdcfcfdca57b0a4986a3edbb54f3d3110 Mon Sep 17 00:00:00 2001
From: silentoplayz <50341825+silentoplayz@users.noreply.github.com>
Date: Wed, 11 Sep 2024 16:48:58 +0000
Subject: [PATCH] Update env-configuration.md

Bump
---
 docs/getting-started/env-configuration.md | 122 ++++++++++++++++++++++
 1 file changed, 122 insertions(+)

diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md
index 4ef7ac0..bb6be1b 100644
--- a/docs/getting-started/env-configuration.md
+++ b/docs/getting-started/env-configuration.md
@@ -4,6 +4,12 @@
 
 Open WebUI provides a range of environment variables that allow you to customize and configure various aspects of the application. This page serves as a comprehensive reference for all available environment variables, including their types, default values, and descriptions.
 
+:::info
+
+  Last updated: v0.3.20
+
+:::
+
 ## App/Backend
 
 The following environment variables are used by `backend/config.py` to provide Open WebUI startup configuration. Please note that some variables may have different default values depending on whether you're running Open WebUI directly or via Docker. For more information on logging environment variables, see our [logging documentation](/getting-started/logging#appbackend).
@@ -131,6 +137,18 @@ The following environment variables are used by `backend/config.py` to provide O
 - Default: `True`
 - Description: Toggles user permission to delete chats.
 
+#### `USER_PERMISSIONS_CHAT_EDITING`
+
+- Type: `bool`
+- Default: `True`
+- Description: Toggles user permission to edit chats.
+
+#### `USER_PERMISSIONS_CHAT_TEMPORARY`
+
+- Type: `bool`
+- Default: `True`
+- Description: Toggles user permission to create temporary chats.
+
 #### `ENABLE_MODEL_FILTER`
 
 - Type: `bool`
@@ -154,12 +172,24 @@ The following environment variables are used by `backend/config.py` to provide O
 - Default: `True`
 - Description: Controls whether admin users can export data.
 
+#### `ENABLE_ADMIN_CHAT_ACCESS`
+
+- Type: `bool`
+- Default: `True`
+- Description: Enables admin users to access all chats.
+
 #### `ENABLE_COMMUNITY_SHARING`
 
 - Type: `bool`
 - Default: `True`
 - Description: Controls whether users are shown the share to community button.
 
+#### `ENABLE_MESSAGE_RATING`
+
+- Type: `bool`
+- Default: `True`
+- Description: Enables message rating feature.
+
 #### `WEBUI_BUILD_HASH`
 
 - Type: `str`
@@ -224,6 +254,18 @@ The following environment variables are used by `backend/config.py` to provide O
 - Default: `False`
 - Description: Resets the `config.json` file on startup.
 
+#### `DEFAULT_LOCALE`
+
+- Type: `str`
+- Default: `en`
+- Description: Sets the default locale for the application.
+
+#### `FUNCTIONS_DIR`
+
+- Type: `str`
+- Default: `./functions`
+- Description: Specifies the directory for custom functions.
+
 #### `SHOW_ADMIN_DETAILS`
 
 - Type: `bool`
@@ -262,6 +304,11 @@ The following environment variables are used by `backend/config.py` to provide O
 - Type: `int`
 - Description: Sets the timeout in seconds for internal aiohttp connections. This impacts things such as connections to Ollama and OpenAI endpoints.
 
+#### `FONTS_DIR`
+
+- Type: `str`
+- Description: Specifies the directory for fonts.
+
 ### Ollama
 
 #### `ENABLE_OLLAMA_API`
@@ -385,6 +432,12 @@ Interaction History:
 Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query. If a function tool matches, construct and return a JSON object in the format {\"name\": \"functionName\", \"parameters\": {\"requiredFunctionParamKey\": \"requiredFunctionParamValue\"}} using the appropriate tool and its parameters. Only return the object and limit the response to the JSON object without additional text.
 ```
 
+#### `CORS_ALLOW_ORIGIN`
+
+- Type: `str`
+- Default: `*`
+- Description: Sets the allowed origins for Cross-Origin Resource Sharing (CORS).
+
 ### RAG
 
 #### `DOCS_DIR`
@@ -567,6 +620,30 @@ Query: [query]
 - Default: `100`
 - Description: Specifies how much overlap there should be between chunks.
 
+#### `CONTENT_EXTRACTION_ENGINE`
+
+- Type: `str` (` `, `tika`)
+- Default: ` ` (empty)
+- Description: Sets the content extraction engine to use for document ingestion.
+
+#### `TIKA_SERVER_URL`
+
+- Type: `str`
+- Default: `http://localhost:9998`
+- Description: Sets the URL for the Apache Tika server.
+
+#### `RAG_FILE_MAX_COUNT`
+
+- Type: `int`
+- Default: `10`
+- Description: Sets the maximum number of files that can be uploaded at once for document ingestion.
+
+#### `RAG_FILE_MAX_SIZE`
+
+- Type: `int`
+- Default: `104857600` (100MB)
+- Description: Sets the maximum size of a file that can be uploaded for document ingestion.
+
 ### Web Search
 
 #### `ENABLE_RAG_WEB_SEARCH`
@@ -575,6 +652,12 @@ Query: [query]
 - Default: `false`
 - Description: Enable web search toggle
 
+#### `ENABLE_SEARCH_QUERY`
+
+- Type: `bool`
+- Default: `False`
+- Description: Enables the generation of search queries from prompts
+
 #### `RAG_WEB_SEARCH_ENGINE`
 
 - Type: `str` (enum: `searxng`, `google_pse`, `brave`, `serpstack`, `serper`, `serply`, `searchapi`, `duckduckgo`, `tavily`, `jina`)
@@ -649,6 +732,16 @@ Query: [query]
 - Default: `10`
 - Description: Number of concurrent requests to crawl web pages returned from search results.
 
+#### `SEARCHAPI_API_KEY`
+
+- Type: `str`
+- Description: Sets the SearchAPI API key.
+
+#### `SEARCHAPI_ENGINE`
+
+- Type: `str`
+- Description: Sets the SearchAPI engine.
+
 ### Speech to Text
 
 #### `AUDIO_STT_ENGINE`
@@ -706,6 +799,11 @@ Query: [query]
   - `openai` - Uses OpenAI engine for Text-to-Speech.
 - Description: Specifies the Text-to-Speech engine to use.
 
+#### `AUDIO_TTS_API_KEY`
+
+- Type: `str`
+- Description: Sets the API key for Text-to-Speech.
+
 #### `AUDIO_TTS_OPENAI_API_BASE_URL`
 
 - Type: `str`
@@ -730,6 +828,12 @@ Query: [query]
 - Default: `alloy`
 - Description: Sets the OpenAI text-to-speech voice to use.
 
+#### `AUDIO_TTS_SPLIT_ON`
+
+- Type: `str`
+- Default: `punctuation`
+- Description: Sets the OpenAI text-to-speech split on to use.
+
 ### Image Generation
 
 #### `ENABLE_IMAGE_GENERATION`
@@ -753,11 +857,21 @@ Query: [query]
 - Type: `str`
 - Description: Specifies the URL to Automatic1111's Stable Diffusion API.
 
+#### `AUTOMATIC1111_API_AUTH`
+
+- Type: `str`
+- Description: Sets the Automatic1111 API authentication.
+
 #### `COMFYUI_BASE_URL`
 
 - Type: `str`
 - Description: Specifies the URL to the ComfyUI image generation API.
 
+#### `COMFYUI_WORKFLOW`
+
+- Type: `str`
+- Description: Sets the ComfyUI workflow.
+
 #### `IMAGES_OPENAI_API_BASE_URL`
 
 - Type: `str`
@@ -898,3 +1012,11 @@ Query: [query]
 
 - Type: `str`
 - Description: Sets the redirect URI for OIDC
+
+### Tools
+
+#### `TOOLS_DIR`
+
+- Type: `str`
+- Default: `${DATA_DIR}/tools`
+- Description: Specifies the directory for custom tools.