Skip to main content

🌍 环境变量配置

概览​

Open WebUI 提供了大量的环境变量，允许您自定义和配置应用程序的各个方面。本页面作为所有可用环境变量的综合参考，提供它们的类型、默认值和描述。随着新变量的引入，本页面将更新以反映不断增长的配置选项。

info

本页面与 Open WebUI 发布版本 v0.6.9 保持同步，但仍在进行中，以便稍后包含更准确的描述、列出环境变量的可用选项、默认值和改进描述。

关于 PersistentConfig 环境变量的重要说明​

note

当首次启动 Open WebUI 时，所有环境变量都被平等对待，可以用来配置应用程序。但是，对于标记为 PersistentConfig 的环境变量，它们的值会被持久化并存储在内部。

在初始启动后，如果您重启容器，PersistentConfig 环境变量将不再使用外部环境变量值。相反，它们将使用内部存储的值。

相比之下，常规环境变量将在每次后续重启时继续更新和应用。

您可以直接从 Open WebUI 内部更新 PersistentConfig 环境变量的值，这些更改将存储在内部。这允许您独立于外部环境变量管理这些配置设置。

请注意，PersistentConfig 环境变量在下面的文档中明确标记为这样，因此您可以了解它们的行为方式。

要禁用 PersistentConfig 并让 Open WebUI 平等对待所有变量，您可以将 ENABLE_PERSISTENT_CONFIG 设置为 False。

应用程序/后端​

以下环境变量由 backend/open_webui/config.py 使用，为 Open WebUI 启动配置提供支持。请注意，某些变量可能根据您是直接运行 Open WebUI 还是通过 Docker 运行而有不同的默认值。有关日志环境变量的更多信息，请参阅我们的日志文档。

常规​

WEBUI_URL​

  • 类型: str
  • 默认值: http://localhost:3000
  • 描述: 指定您的 Open WebUI 安装可访问的 URL。搜索引擎支持和 OAuth/SSO 需要此设置。
  • 持久性: 此环境变量是 PersistentConfig 变量。
warning

此变量必须在您开始使用 OAuth/SSO 进行身份验证之前设置。 由于这是一个持久配置环境变量，您只能通过以下选项之一更改它：

  • 使用 ENABLE_PERSISTENT_CONFIG 临时禁用持久配置
  • 在管理面板 > 设置中更改 WEBUI_URL 并更改"WebUI URL"。

在使用 OAuth/SSO 之前未能设置 WEBUI_URL 将导致登录失败。

ENABLE_SIGNUP​

  • 类型: bool
  • 默认值: True
  • 描述: 切换用户账户创建。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_LOGIN_FORM​

  • 类型: bool
  • 默认值: True
  • 描述: 切换电子邮件、密码、登录和"或"（仅当 ENABLE_OAUTH_SIGNUP 设置为 True 时）元素。
  • 持久性: 此环境变量是 PersistentConfig 变量。
danger

这应该仅在同时使用 ENABLE_OAUTH_SIGNUP 并设置为 True 时设置为 False。否则将导致无法登录。

DEFAULT_LOCALE​

  • 类型: str
  • 默认值: en
  • 描述: 设置应用程序的默认语言环境。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DEFAULT_MODELS​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None。
  • 描述: 设置默认语言模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DEFAULT_USER_ROLE​

  • 类型: str
  • 选项:
    • pending - 新用户处于待定状态，直到管理员手动激活其账户。
    • user - 新用户自动激活，具有常规用户权限。
    • admin - 新用户自动激活，具有管理员权限。
  • 默认值: pending
  • 描述: 设置分配给新用户的默认角色。
  • 持久性: 此环境变量是 PersistentConfig 变量。

PENDING_USER_OVERLAY_TITLE​

  • 类型: str
  • 默认值: 空字符串 (' ')
  • 描述: 为待定用户覆盖层设置自定义标题。
  • 持久性: 此环境变量是 PersistentConfig 变量。

PENDING_USER_OVERLAY_CONTENT​

  • 类型: str
  • 默认值: 空字符串 (' ')
  • 描述: 为待定用户覆盖层设置自定义文本内容。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_CHANNELS​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用频道支持。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WEBHOOK_URL​

  • 类型: str
  • 描述: 设置与 Discord/Slack/Microsoft Teams 集成的 webhook。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_ADMIN_EXPORT​

  • 类型: bool
  • 默认值: True
  • 描述: 控制管理员用户是否可以导出数据。

ENABLE_ADMIN_CHAT_ACCESS​

  • 类型: bool
  • 默认值: True
  • 描述: 启用管理员用户访问所有聊天。

ENABLE_USER_WEBHOOKS​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用用户 webhooks。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RESPONSE_WATERMARK​

  • 类型: str
  • 默认值: 空字符串 (' ')
  • 描述: 设置在聊天中复制消息时将包含的自定义文本。例如 "此文本由 AI 生成" -> 将在复制时为每条消息添加"此文本由 AI 生成"。
  • 持久性: 此环境变量是 PersistentConfig 变量。

THREAD_POOL_SIZE​

  • 类型: int
  • 默认值: 0
  • 描述: 设置 FastAPI/AnyIO 阻塞调用的线程池大小。默认情况下（当设置为 0 时）FastAPI/AnyIO 使用 40 个线程。在大型实例和许多并发用户的情况下，可能需要增加 THREAD_POOL_SIZE 以防止阻塞。

SHOW_ADMIN_DETAILS​

  • 类型: bool
  • 默认值: True
  • 描述: 切换是否在界面中显示管理员用户详细信息。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ADMIN_EMAIL​

  • 类型: str
  • 描述: 设置 SHOW_ADMIN_DETAILS 显示的管理员电子邮件
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENV​

  • 类型: str
  • 选项:
    • dev - 在 /docs 上启用 FastAPI API 文档
    • prod - 自动配置几个环境变量
  • 默认值:
    • 后端默认: dev
    • Docker 默认: prod
  • 描述: 环境设置。

ENABLE_PERSISTENT_CONFIG​

  • 类型: bool
  • 默认值: True
  • 描述: 如果设置为 False，所有 PersistentConfig 变量都被视为常规变量。

CUSTOM_NAME​

  • 类型: str
  • 描述: 设置 WEBUI_NAME 但会轮询 api.openwebui.com 获取元数据。

WEBUI_NAME​

  • 类型: str
  • 默认值: Open WebUI
  • 描述: 设置主要的 WebUI 名称。如果被覆盖，会附加 (Open WebUI)。

PORT​

  • 类型: int
  • 默认值: 8080
  • 描述: 设置运行 Open WebUI 的端口。
info

如果您通过 Python 运行应用程序并使用 open-webui serve 命令，您无法使用 PORT 配置设置端口。相反，您必须使用 --port 标志直接指定为命令行参数。例如：

open-webui serve --port 9999

这将在端口 9999 上运行 Open WebUI。在此模式下，PORT 环境变量将被忽略。

ENABLE_REALTIME_CHAT_SAVE​

  • 类型: bool
  • 默认值: False
  • 描述: 启用时，系统会实时将每个流式聊天数据块保存到数据库，以确保最大的数据持久性。此功能提供了强大的数据恢复能力，并允许准确的会话跟踪。但是，代价是增加了延迟，因为保存到数据库会引入延迟。禁用此功能可以提高性能并减少延迟，但在系统故障或崩溃时存在潜在的数据丢失风险。根据您的应用程序要求和可接受的权衡来使用。

BYPASS_MODEL_ACCESS_CONTROL​

  • 类型: bool
  • 默认值: False
  • 描述: 绕过模型访问控制。

WEBUI_BUILD_HASH​

  • 类型: str
  • 默认值: dev-build
  • 描述: 用于识别发布版本的 Git SHA。

WEBUI_BANNERS​

  • 类型: list of dict
  • 默认值: []
  • 描述: 向用户显示的横幅列表。横幅的格式为：
[{"id": "string", "type": "string [info, success, warning, error]", "title": "string", "content": "string", "dismissible": false, "timestamp": 1000}]
  • 持久性: 此环境变量是 PersistentConfig 变量。
info

在 .env 文件中设置此环境变量时，请确保通过将整个值包装在双引号中并对内部引号使用转义引号 (\") 来转义引号。示例：

WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Your messages are stored.\", \"content\": \"Your messages are stored and may be reviewed by human people. LLM's are prone to hallucinations, check sources.\", \"dismissible\": true, \"timestamp\": 1000}]"

USE_CUDA_DOCKER​

  • 类型: bool
  • 默认值: False
  • 描述: 使用 NVIDIA CUDA 支持构建 Docker 镜像。启用本地 Whisper 和嵌入的 GPU 加速。

EXTERNAL_PWA_MANIFEST_URL​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 当定义为完全限定的 URL（例如，https://path/to/manifest.webmanifest）时，发送到 /manifest.json 的请求将使用外部清单文件。当未定义时，将使用默认的 manifest.json 文件。

ENABLE_TITLE_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用聊天标题生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LICENSE_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 指定要使用的许可证密钥（仅限企业用户）。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SSL_ASSERT_FINGERPRINT​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定要使用的 SSL 断言指纹。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DEFAULT_PROMPT_SUGGESTIONS​

  • 类型: list of dict
  • 默认值: []（意味着使用内置的默认提示建议）
  • 描述: 提示建议列表。提示建议的格式为：
[{"title": ["Title part 1", "Title part 2"], "content": "prompt"}]

AIOHTTP 客户端​

AIOHTTP_CLIENT_TIMEOUT​

  • 类型: int
  • 默认值: 300
  • 描述: 指定 AIOHTTP 客户端的超时持续时间（秒）。这会影响诸如连接到 Ollama 和 OpenAI 端点等事务。
info

这是客户端在超时之前等待响应的最长时间。 如果设置为空字符串 (' ')，超时将设置为 None，有效地禁用超时并允许客户端无限期等待。

AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST​

  • 类型: int
  • 默认值: 10
  • 描述: 设置获取模型列表的超时时间（秒）。在网络延迟需要更长超时持续时间才能成功检索模型列表的情况下，这会很有用。
note

AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST 默认设置为 10 秒，以帮助确保在打开 Web UI 时所有必要的连接都可用。此持续时间允许有足够的时间检索模型列表，即使在较高网络延迟的情况下也是如此。如果您希望更快的超时，可以降低此值，但请记住，这样做可能会导致某些连接被断开，具体取决于您的网络条件。

AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST​

  • 类型: int
  • 描述: 设置获取模型列表的超时时间（秒）。在网络延迟需要更长超时持续时间才能成功检索模型列表的情况下，这会很有用。

目录​

DATA_DIR​

  • 类型: str
  • 默认值: ./data
  • 描述: 指定数据存储的基本目录，包括上传、缓存、向量数据库等。

FONTS_DIR​

  • 类型: str
  • 描述: 指定字体目录。

FRONTEND_BUILD_DIR​

  • 类型: str
  • 默认值: ../build
  • 描述: 指定构建的前端文件的位置。

STATIC_DIR​

  • 类型: str
  • 默认值: ./static
  • 描述: 指定静态文件目录，例如网站图标。

Ollama​

ENABLE_OLLAMA_API​

  • 类型: bool
  • 默认值: True
  • 描述: 启用使用 Ollama API。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OLLAMA_BASE_URL (OLLAMA_API_BASE_URL 已弃用)​

  • 类型: str
  • 默认值: http://localhost:11434
  • Docker 默认值:
    • 如果设置了 K8S_FLAG: http://ollama-service.open-webui.svc.cluster.local:11434
    • 如果 USE_OLLAMA_DOCKER=True: http://localhost:11434
    • 否则 http://host.docker.internal:11434
  • 描述: 配置 Ollama 后端 URL。

OLLAMA_BASE_URLS​

  • 类型: str
  • 描述: 配置负载均衡的 Ollama 后端主机，用 ; 分隔。请参阅OLLAMA_BASE_URL。优先于OLLAMA_BASE_URL。
  • 示例: http://host-one:11434;http://host-two:11434
  • 持久性: 此环境变量是 PersistentConfig 变量。

USE_OLLAMA_DOCKER​

  • 类型: bool
  • 默认值: False
  • 描述: 使用捆绑的 Ollama 实例构建 Docker 镜像。

K8S_FLAG​

  • 类型: bool
  • 默认值: False
  • 描述: 如果设置，假设 Helm 图表部署并将 OLLAMA_BASE_URL 设置为 http://ollama-service.open-webui.svc.cluster.local:11434

OpenAI​

ENABLE_OPENAI_API​

  • 类型: bool
  • 默认值: True
  • 描述: 启用使用 OpenAI API。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OPENAI_API_BASE_URL​

  • 类型: str
  • 默认值: https://api.openai.com/v1
  • 描述: 配置 OpenAI 基础 API URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OPENAI_API_BASE_URLS​

  • 类型: str
  • 描述: 支持负载均衡的 OpenAI 基础 API URL，用分号分隔。
  • 示例: http://host-one:11434;http://host-two:11434
  • 持久性: 此环境变量是 PersistentConfig 变量。

OPENAI_API_KEY​

  • 类型: str
  • 描述: 设置 OpenAI API 密钥。
  • 示例: sk-124781258123
  • 持久性: 此环境变量是 PersistentConfig 变量。

OPENAI_API_KEYS​

  • 类型: str
  • 描述: 支持多个 OpenAI API 密钥，用分号分隔。
  • 示例: sk-124781258123;sk-4389759834759834
  • 持久性: 此环境变量是 PersistentConfig 变量。

任务​

TASK_MODEL​

  • 类型: str
  • 描述: 使用 Ollama 模型时用于标题和网络搜索查询生成等任务的默认模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TASK_MODEL_EXTERNAL​

  • 类型: str
  • 描述: 使用 OpenAI 兼容端点时用于标题和网络搜索查询生成等任务的默认模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TITLE_GENERATION_PROMPT_TEMPLATE​

  • 类型: str
  • 描述: 生成聊天标题时使用的提示。
  • 默认值: DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE 环境变量的值。

DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE:

### 任务:
生成一个简洁的3-5个词的标题，带有表情符号，总结聊天历史。
### 指导原则:
- 标题应清楚地代表对话的主要主题或主题。
- 使用能增强对主题理解的表情符号，但避免引号或特殊格式。
- 用聊天的主要语言写标题；如果是多语言，则默认为英语。
- 优先考虑准确性而非过度创造性；保持清晰简单。
### 输出:
JSON 格式: { "title": "your concise title here" }
### 示例:
- { "title": "📉 股市趋势" },
- { "title": "🍪 完美巧克力曲奇食谱" },
- { "title": "音乐流媒体的演进" },
- { "title": "远程工作生产力技巧" },
- { "title": "人工智能在医疗保健中的应用" },
- { "title": "🎮 视频游戏开发洞察" }
### 聊天历史:
<chat_history>
{{MESSAGES:END:2}}
</chat_history>
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_FOLLOW_UP_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用后续问题生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

FOLLOW_UP_GENERATION_PROMPT_TEMPLATE​

  • 类型: str
  • 描述: 用于生成几个相关后续问题的提示。
  • 默认值: DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE 环境变量的值。

DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE:

### 任务:
根据聊天历史，建议 3-5 个用户可能会自然地作为**用户**在此对话中提出的相关后续问题或提示，以帮助继续或深化讨论。
### 指导原则:
- 从用户的角度写所有后续问题，针对助手。
- 使问题简洁、清晰，并与讨论的主题直接相关。
- 只建议基于聊天内容有意义且不重复已涵盖内容的后续问题。
- 如果对话很短或不具体，建议用户可能会问的更一般（但相关）的后续问题。
- 使用对话的主要语言；如果是多语言，则默认为英语。
- 响应必须是字符串的 JSON 数组，没有额外的文本或格式。
### 输出:
JSON 格式: { "follow_ups": ["Question 1?", "Question 2?", "Question 3?"] }
### 聊天历史:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>"
  • 持久性: 此环境变量是 PersistentConfig 变量。

TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE​

  • 类型: str
  • 描述: 调用工具时使用的提示。
  • 默认值: DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE 环境变量的值。

DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE:

可用工具: {{TOOLS}}

您的任务是根据查询从可用工具列表中选择并返回正确的工具。遵循以下指导原则：

- 仅返回 JSON 对象，不包含任何额外的文本或解释。

- 如果没有工具匹配查询，返回空数组： 
   {
     "tool_calls": []
   }

- 如果一个或多个工具匹配查询，构造一个包含"tool_calls"数组的 JSON 响应，其中包含对象：
   - "name": 工具的名称。
   - "parameters": 必需参数及其对应值的字典。

JSON 响应的格式严格为：
{
  "tool_calls": [
    {"name": "toolName1", "parameters": {"key1": "value1"}},
    {"name": "toolName2", "parameters": {"key2": "value2"}}
  ]
}
  • 持久性: 此环境变量是 PersistentConfig 变量。

代码执行​

ENABLE_CODE_EXECUTION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用代码执行。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_EXECUTION_ENGINE​

  • 类型: str
  • 默认值: pyodide
  • 描述: 指定要使用的代码执行引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_EXECUTION_JUPYTER_URL​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于代码执行的 Jupyter URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_EXECUTION_JUPYTER_AUTH​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于代码执行的 Jupyter 身份验证方法。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_EXECUTION_JUPYTER_AUTH_TOKEN​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于代码执行的 Jupyter 身份验证令牌。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_EXECUTION_JUPYTER_AUTH_PASSWORD​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于代码执行的 Jupyter 身份验证密码。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_EXECUTION_JUPYTER_TIMEOUT​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Jupyter 代码执行的超时时间。
  • 持久性: 此环境变量是 PersistentConfig 变量。

代码解释器​

ENABLE_CODE_INTERPRETER​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用代码解释器。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_ENGINE​

  • 类型: str
  • 默认值: pyodide
  • 描述: 指定要使用的代码解释器引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_PROMPT_TEMPLATE​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于代码解释器的提示模板。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_JUPYTER_URL​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定用于代码解释器的 Jupyter URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_JUPYTER_AUTH​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定用于代码解释器的 Jupyter 身份验证方法。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_JUPYTER_AUTH_TOKEN​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定用于代码解释器的 Jupyter 身份验证令牌。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定用于代码解释器的 Jupyter 身份验证密码。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CODE_INTERPRETER_JUPYTER_TIMEOUT​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Jupyter 代码解释器的超时时间。
  • 持久性: 此环境变量是 PersistentConfig 变量。

直接连接（OpenAPI/MCPO 工具服务器）​

ENABLE_DIRECT_CONNECTIONS​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用直接连接。
  • 持久性: 此环境变量是 PersistentConfig 变量。

自动完成​

ENABLE_AUTOCOMPLETE_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用自动完成生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。
info

启用 ENABLE_AUTOCOMPLETE_GENERATION 时，请确保您也相应地配置 AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH 和 AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE。

AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH​

  • 类型: int
  • 默认值: -1
  • 描述: 设置自动完成生成的最大输入长度。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE​

  • 类型: str
  • 默认值: DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE 环境变量的值。

DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE:

### 任务:
您是一个自动完成系统。根据 `<type>` 中的**完成类型**和给定的语言，继续 `<text>` 中的文本。

### **说明**:
1. 分析 `<text>` 的上下文和含义。
2. 使用 `<type>` 指导您的输出：
   - **General**: 提供自然、简洁的续写。
   - **Search Query**: 完成时就像生成一个真实的搜索查询。
3. 开始时就像您直接在继续 `<text>`。**不要**重复、改写或作为模型回应。只需完成文本。
4. 确保续写：
   - 从 `<text>` 自然流畅地继续。
   - 避免重复、过度解释或无关的想法。
5. 如果不确定，返回：`{ "text": "" }`。

### **输出规则**:
- 仅以 JSON 格式回应：`{ "text": "<your_completion>" }`。

### **示例**:
#### 示例 1:
输入:
<type>General</type>
<text>太阳正在地平线上落下，把天空染成</text>
输出:
{ "text": "了鲜艳的橙色和粉红色。" }

#### 示例 2:
输入:
<type>Search Query</type>
<text>评分最高的餐厅在</text>
输出:
{ "text": "纽约市的意大利美食。" }

---
### 上下文:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
<type>{{TYPE}}</type>
<text>{{PROMPT}}</text>
#### 输出:
  • 描述: 设置自动完成生成的提示模板。
  • 持久性: 此环境变量是 PersistentConfig 变量。

评估竞技场模型​

ENABLE_EVALUATION_ARENA_MODELS​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用评估竞技场模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_MESSAGE_RATING​

  • 类型: bool
  • 默认值: True
  • 描述: 启用消息评分功能。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_COMMUNITY_SHARING​

  • 类型: bool
  • 默认值: True
  • 描述: 控制是否向用户显示分享到社区的按钮。
  • 持久性: 此环境变量是 PersistentConfig 变量。

标签生成​

ENABLE_TAGS_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用标签生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TAGS_GENERATION_PROMPT_TEMPLATE​

  • 类型: str
  • 默认值: DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE 环境变量的值。

DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE:

### 任务:
生成 1-3 个分类聊天历史主要主题的广泛标签，以及 1-3 个更具体的子主题标签。

### 指导原则:
- 从高级域开始（例如科学、技术、哲学、艺术、政治、商业、健康、体育、娱乐、教育）
- 如果相关子领域/子域在整个对话中有强烈体现，考虑包含它们
- 如果内容太短（少于3条消息）或太多样化，仅使用 ["General"]
- 使用聊天的主要语言；如果是多语言，则默认为英语
- 优先考虑准确性而非特定性

### 输出:
JSON 格式: { "tags": ["tag1", "tag2", "tag3"] }

### 聊天历史:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
  • 描述: 设置标签生成的提示模板。
  • 持久性: 此环境变量是 PersistentConfig 变量。

API 密钥端点限制​

ENABLE_API_KEY​

  • 类型: bool
  • 默认值: True
  • 描述: 启用 API 密钥身份验证。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_API_KEY_ENDPOINT_RESTRICTIONS​

  • 类型: bool
  • 默认值: False
  • 描述: 启用 API 密钥端点限制以增强安全性和可配置性。
  • 持久性: 此环境变量是 PersistentConfig 变量。

API_KEY_ALLOWED_ENDPOINTS​

  • 类型: str
  • 描述: 当启用 API 密钥端点限制时，指定允许的 API 端点的逗号分隔列表。
  • 持久性: 此环境变量是 PersistentConfig 变量。
note

API_KEY_ALLOWED_ENDPOINTS 的值应该是端点 URL 的逗号分隔列表，例如 /api/v1/messages, /api/v1/channels。

JWT_EXPIRES_IN​

  • 类型: int
  • 默认值: -1
  • 描述: 设置 JWT 过期时间（秒）。有效的时间单位：s、m、h、d、w 或 -1 表示不过期。
  • 持久性: 此环境变量是 PersistentConfig 变量。

安全变量​

ENABLE_FORWARD_USER_INFO_HEADERS​

  • 类型: bool
  • 默认值: False
  • 描述: 将用户信息（姓名、ID、电子邮件和角色）作为 X-headers 转发到 OpenAI API 和 Ollama API。 如果启用，将转发以下头部：
    • X-OpenWebUI-User-Name
    • X-OpenWebUI-User-Id
    • X-OpenWebUI-User-Email
    • X-OpenWebUI-User-Role

ENABLE_WEB_LOADER_SSL_VERIFICATION​

  • 类型: bool
  • 默认值: True
  • 描述: 为网站上的 RAG 绕过 SSL 验证。
  • 持久性: 此环境变量是 PersistentConfig 变量。
  • 类型: str
  • 选项:
    • lax - 将 SameSite 属性设置为 lax，允许会话 cookie 与第三方网站发起的请求一起发送。
    • strict - 将 SameSite 属性设置为 strict，阻止会话 cookie 与第三方网站发起的请求一起发送。
    • none - 将 SameSite 属性设置为 none，允许会话 cookie 与第三方网站发起的请求一起发送，但仅通过 HTTPS。
  • 默认值: lax
  • 描述: 设置会话 cookie 的 SameSite 属性。
warning

当启用 ENABLE_OAUTH_SIGNUP 时，将 WEBUI_SESSION_COOKIE_SAME_SITE 设置为 strict 可能导致登录失败。这是因为 Open WebUI 使用会话 cookie 来验证来自 OAuth 提供商的回调，这有助于防止 CSRF 攻击。

但是，strict 会话 cookie 不会与回调请求一起发送，导致潜在的登录问题。如果您遇到此问题，请改用默认的 lax 值。

  • 类型: bool
  • 默认值: False
  • 描述: 如果设置为 True，为会话 cookie 设置 Secure 属性。
  • 类型: str
  • 选项:
    • lax - 将 SameSite 属性设置为 lax，允许身份验证 cookie 与第三方网站发起的请求一起发送。
    • strict - 将 SameSite 属性设置为 strict，阻止身份验证 cookie 与第三方网站发起的请求一起发送。
    • none - 将 SameSite 属性设置为 none，允许身份验证 cookie 与第三方网站发起的请求一起发送，但仅通过 HTTPS。
  • 默认值: lax
  • 描述: 设置身份验证 cookie 的 SameSite 属性。
info

如果未设置值，将使用 WEBUI_SESSION_COOKIE_SAME_SITE 作为后备。

  • 类型: bool
  • 默认值: False
  • 描述: 如果设置为 True，为身份验证 cookie 设置 Secure 属性。
info

如果未设置值，将使用 WEBUI_SESSION_COOKIE_SECURE 作为后备。

WEBUI_AUTH​

  • 类型: bool
  • 默认值: True
  • 描述: 此设置启用或禁用身份验证。
danger

如果设置为 False，您的 Open WebUI 实例将禁用身份验证。但是，重要的是要注意，只有在没有任何现有用户的全新安装中才能关闭身份验证。如果已有用户注册，您无法直接禁用身份验证。如果您打算关闭 WEBUI_AUTH，请确保数据库中没有用户。

WEBUI_SECRET_KEY​

  • 类型: str
  • 默认值: t0p-s3cr3t
  • Docker 默认值: 首次启动时随机生成
  • 描述: 覆盖用于 JSON Web Token 的随机生成字符串。
info

在具有负载均衡器的多节点/工作器集群中部署 Open-WebUI 时，您必须确保所有实例的 WEBUI_SECRET_KEY 值相同，以便用户在节点被回收或其会话转移到不同节点时能够继续工作。没有它，每次底层节点更改时他们都需要重新登录。

OFFLINE_MODE​

  • 类型: bool
  • 默认值: False
  • 描述: 禁用 Open WebUI 的网络连接以进行更新检查和自动模型下载。
info

启用时禁用的功能:

  • 自动版本更新检查
  • 从 Hugging Face Hub 下载嵌入模型
    • 如果您在激活 OFFLINE_MODE 之前没有下载嵌入模型，任何 RAG、网络搜索和文档分析功能可能无法正常工作
  • UI 中的更新通知

仍然有效的功能:

  • 外部 LLM API 连接（OpenAI 等）
  • OAuth 身份验证提供商
  • 使用外部 API 的网络搜索和 RAG

RESET_CONFIG_ON_START​

  • 类型: bool
  • 默认值: False
  • 描述: 在启动时重置 config.json 文件。

SAFE_MODE​

  • 类型: bool
  • 默认值: False
  • 描述: 启用安全模式，禁用潜在不安全的功能，停用所有函数。

CORS_ALLOW_ORIGIN​

  • 类型: str
  • 默认值: *
  • 描述: 设置跨域资源共享（CORS）的允许来源。

RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE​

  • 类型: bool
  • 默认值: False
  • 描述: 确定是否允许在 Hub 上的自定义模型在其自己的建模文件中定义。

RAG_RERANKING_MODEL_TRUST_REMOTE_CODE​

  • 类型: bool
  • 默认值: False
  • 描述: 确定是否允许在 Hub 上的自定义模型在其自己的建模文件中定义用于重新排序。

RAG_EMBEDDING_MODEL_AUTO_UPDATE​

  • 类型: bool
  • 默认值: True
  • 描述: 切换 Sentence-Transformer 模型的自动更新。

RAG_RERANKING_MODEL_AUTO_UPDATE​

  • 类型: bool
  • 默认值: True
  • 描述: 切换重新排序模型的自动更新。

向量数据库​

VECTOR_DB​

  • 类型: str
  • 选项:
  • chroma、elasticsearch、milvus、opensearch、pgvector、qdrant、pinecone
  • 默认值: chroma
  • 描述: 指定要使用的向量数据库系统。此设置确定将使用哪个向量存储系统来管理嵌入。

ChromaDB​

CHROMA_TENANT​

  • 类型: str
  • 默认值: chromadb.DEFAULT_TENANT 的值（chromadb 模块中的常量）
  • 描述: 设置 ChromaDB 用于 RAG 嵌入的租户。

CHROMA_DATABASE​

  • 类型: str
  • 默认值: chromadb.DEFAULT_DATABASE 的值（chromadb 模块中的常量）
  • 描述: 设置 ChromaDB 租户中用于 RAG 嵌入的数据库。

CHROMA_HTTP_HOST​

  • 类型: str
  • 描述: 指定远程 ChromaDB 服务器的主机名。如果未设置，则使用本地 ChromaDB 实例。

CHROMA_HTTP_PORT​

  • 类型: int
  • 默认值: 8000
  • 描述: 指定远程 ChromaDB 服务器的端口。

CHROMA_HTTP_HEADERS​

  • 类型: str
  • 描述: 每个 ChromaDB 请求要包含的 HTTP 头的逗号分隔列表。
  • 示例: Authorization=Bearer heuhagfuahefj,User-Agent=OpenWebUI。

CHROMA_HTTP_SSL​

  • 类型: bool
  • 默认值: False
  • 描述: 控制是否对 ChromaDB 服务器连接使用 SSL。

CHROMA_CLIENT_AUTH_PROVIDER​

  • 类型: str
  • 描述: 为远程 ChromaDB 服务器指定身份验证提供商。
  • 示例: chromadb.auth.basic_authn.BasicAuthClientProvider

CHROMA_CLIENT_AUTH_CREDENTIALS​

  • 类型: str
  • 描述: 指定远程 ChromaDB 服务器的身份验证凭据。
  • 示例: username:password

Elasticsearch​

ELASTICSEARCH_API_KEY​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Elasticsearch API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ELASTICSEARCH_CA_CERTS​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Elasticsearch CA 证书的路径。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ELASTICSEARCH_CLOUD_ID​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Elasticsearch 云 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ELASTICSEARCH_INDEX_PREFIX​

  • 类型: str
  • 默认值: open_webui_collections
  • 描述: 指定 Elasticsearch 索引的前缀。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ELASTICSEARCH_PASSWORD​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Elasticsearch 的密码。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ELASTICSEARCH_URL​

  • 类型: str
  • 默认值: https://localhost:9200
  • 描述: 指定 Elasticsearch 实例的 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ELASTICSEARCH_USERNAME​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Elasticsearch 的用户名。
  • 持久性: 此环境变量是 PersistentConfig 变量。

Milvus​

MILVUS_URI​

  • 类型: str
  • 默认值: ${DATA_DIR}/vector_db/milvus.db
  • 描述: 指定连接到 Milvus 向量数据库的 URI。根据部署配置，这可以指向本地或远程 Milvus 服务器。

MILVUS_DB​

  • 类型: str
  • 默认值: default
  • 描述: 指定要连接到 Milvus 实例中的数据库。

MILVUS_TOKEN​

  • 类型: str
  • 默认值: None
  • 描述: 为 Milvus 指定可选的连接令牌。

MILVUS_INDEX_TYPE​

  • 类型: str
  • 默认值: HNSW
  • 选项: AUTOINDEX、FLAT、IVF_FLAT、HNSW
  • 描述: 指定在 Milvus 中创建新集合时使用的索引类型。AUTOINDEX 通常推荐用于 Milvus 独立版。HNSW 可能提供更好的性能，但通常需要集群化的 Milvus 设置。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MILVUS_METRIC_TYPE​

  • 类型: str
  • 默认值: COSINE
  • 选项: COSINE、IP、L2
  • 描述: 指定 Milvus 中向量相似性搜索的度量类型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MILVUS_HNSW_M​

  • 类型: int
  • 默认值: 16
  • 描述: 指定 Milvus 中 HNSW 索引类型的 M 参数。这影响在构建期间为每个新元素创建的双向链接数量。仅在 MILVUS_INDEX_TYPE 为 HNSW 时适用。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MILVUS_HNSW_EFCONSTRUCTION​

  • 类型: int
  • 默认值: 100
  • 描述: 指定 Milvus 中 HNSW 索引类型的 efConstruction 参数。这影响索引构建期间最近邻动态列表的大小。仅在 MILVUS_INDEX_TYPE 为 HNSW 时适用。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MILVUS_IVF_FLAT_NLIST​

  • 类型: int
  • 默认值: 128
  • 描述: 指定 Milvus 中 IVF_FLAT 索引类型的 nlist 参数。这是集群单元的数量。仅在 MILVUS_INDEX_TYPE 为 IVF_FLAT 时适用。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OpenSearch​

OPENSEARCH_CERT_VERIFY​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 OpenSearch 证书验证。

OPENSEARCH_PASSWORD​

  • 类型: str
  • 默认值: None
  • 描述: 设置 OpenSearch 的密码。

OPENSEARCH_SSL​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用 OpenSearch 的 SSL。

OPENSEARCH_URI​

  • 类型: str
  • 默认值: https://localhost:9200
  • 描述: 设置 OpenSearch 的 URI。

OPENSEARCH_USERNAME​

  • 类型: str
  • 默认值: None
  • 描述: 设置 OpenSearch 的用户名。

PGVector​

PGVECTOR_DB_URL​

  • 类型: str
  • 默认值: DATABASE_URL 环境变量的值
  • 描述: 设置模型存储的数据库 URL。

PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH​

  • 类型: str
  • 默认值: 1536
  • 描述: 指定 PGVector 初始化的最大向量长度。

Qdrant​

QDRANT_API_KEY​

  • 类型: str
  • 描述: 设置 Qdrant 的 API 密钥。

QDRANT_URI​

  • 类型: str
  • 描述: 设置 Qdrant 的 URI。

QDRANT_ON_DISK​

  • 类型: bool
  • 默认值: False
  • 描述: 启用内存映射（也称为磁盘上）存储的使用

QDRANT_PREFER_GRPC​

  • 类型: bool
  • 默认值: False
  • 描述: 尽可能使用 gRPC 接口

QDRANT_GRPC_PORT​

  • 类型: int
  • 默认值: 6334
  • 描述: 设置 Qdrant 的 gRPC 端口号。

ENABLE_QDRANT_MULTITENANCY_MODE​

  • 类型: bool
  • 默认值: False
  • 描述: 为 Qdrant 集合管理启用多租户模式，通过整合类似的向量数据结构显著减少 RAM 使用和计算开销。建议开启
info

这将断开在之前模式（非多租户）中创建的所有 Qdrant 集合。转到 管理设置 > 文档 > 重新索引知识库 来迁移现有知识。

在之前模式中创建的 Qdrant 集合仍将消耗资源。

目前，UI 中没有仅重置向量数据库的按钮。如果您想将知识迁移到多租户：

  • 使用原生 Qdrant 客户端删除所有带有 open_webui-knowledge 前缀的集合（或 open_webui 前缀以删除与 Open WebUI 相关的所有集合）
  • 转到 管理设置 > 文档 > 重新索引知识库 来迁移现有知识库

重新索引知识库 将仅迁移知识库

danger

如果您决定使用多租户模式作为默认设置，并且不需要迁移旧知识，请转到 管理设置 > 文档 重置向量和知识，这将删除所有带有 open_webui 前缀的集合和所有存储的知识。

Pinecone​

使用 Pinecone 作为向量存储时，以下环境变量用于控制其行为。确保在您的 .env 文件或部署环境中设置这些变量。

PINECONE_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置用于与 Pinecone 服务进行身份验证的 API 密钥。

PINECONE_ENVIRONMENT​

  • 类型: str
  • 默认值: None
  • 描述: 指定要连接的 Pinecone 环境（例如，us-west1-gcp、gcp-starter 等）。

PINECONE_INDEX_NAME​

  • 类型: str
  • 默认值: open-webui-index
  • 描述: 定义将用于存储和查询向量嵌入的 Pinecone 索引名称。

PINECONE_DIMENSION​

  • 类型: int
  • 默认值: 1536
  • 描述: 向量嵌入的维度。必须与索引期望的维度匹配（根据使用的模型，通常为 768、1024、1536 或 3072）。

PINECONE_METRIC​

  • 类型: str
  • 默认值: cosine
  • 选项: cosine、dotproduct、euclidean
  • 描述: 指定在 Pinecone 索引中用于向量比较的相似性度量。

PINECONE_CLOUD​

  • 类型: str
  • 默认值: aws
  • 选项: aws、gcp、azure
  • 描述: 指定托管 Pinecone 索引的云提供商。

RAG 内容提取引擎​

CONTENT_EXTRACTION_ENGINE​

  • 类型: str
  • 选项:
    • 留空使用默认值
    • external - 使用外部加载器
    • tika - 使用本地 Apache Tika 服务器
    • docling - 使用 Docling 引擎
    • document_intelligence - 使用文档智能引擎
    • mistral_ocr - 使用 Mistral OCR 引擎
  • 描述: 设置用于文档摄取的内容提取引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MISTRAL_OCR_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 指定要使用的 Mistral OCR API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

EXTERNAL_DOCUMENT_LOADER_URL​

  • 类型: str
  • 默认值: None
  • 描述: 设置外部文档加载器服务的 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

EXTERNAL_DOCUMENT_LOADER_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置用于与外部文档加载器服务进行身份验证的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TIKA_SERVER_URL​

  • 类型: str
  • 默认值: http://localhost:9998
  • 描述: 设置 Apache Tika 服务器的 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DOCLING_SERVER_URL​

  • 类型: str
  • 默认值: http://docling:5001
  • 描述: 指定 Docling 服务器的 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DOCLING_OCR_ENGINE​

  • 类型: str
  • 默认值: tesseract
  • 描述: 指定 Docling 使用的 OCR 引擎。 支持的值包括：tesseract（默认）、easyocr、ocrmac、rapidocr 和 tesserocr。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DOCLING_OCR_LANG​

  • 类型: str
  • 默认值: eng,fra,deu,spa（使用默认的 tesseract 引擎时）
  • 描述: 指定与配置的 DOCLING_OCR_ENGINE 一起使用的 OCR 语言。 格式和可用的语言代码取决于所选的 OCR 引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

检索增强生成（RAG）​

RAG_EMBEDDING_ENGINE​

  • 类型: str
  • 选项:
    • 留空表示 默认（SentenceTransformers） - 使用 SentenceTransformers 进行嵌入。
    • ollama - 使用 Ollama API 进行嵌入。
    • openai - 使用 OpenAI API 进行嵌入。
  • 描述: 选择用于 RAG 的嵌入引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_EMBEDDING_MODEL​

  • 类型: str
  • 默认值: sentence-transformers/all-MiniLM-L6-v2
  • 描述: 设置嵌入模型。本地使用 Sentence-Transformer 模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。
  • 类型: bool
  • 默认值: False
  • 描述: 启用使用 BM25 + ChromaDB 的集成搜索，使用 sentence_transformers 模型进行重新排序。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_TOP_K​

  • 类型: int
  • 默认值: 3
  • 描述: 设置使用 RAG 时嵌入考虑的默认结果数量。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_TOP_K_RERANKER​

  • 类型: int
  • 默认值: 3
  • 描述: 设置使用 RAG 时重新排序器考虑的默认结果数量。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_RELEVANCE_THRESHOLD​

  • 类型: float
  • 默认值: 0.0
  • 描述: 设置与重新排序一起使用时文档考虑的相关性阈值。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_HYBRID_BM25_WEIGHT​

  • 类型: float
  • 默认值: 0.5
  • 描述: 设置混合搜索期间给予关键词搜索（BM25）的权重。1 表示仅关键词搜索，0 表示仅向量搜索。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_TEMPLATE​

  • 类型: str
  • 默认值: DEFAULT_RAG_TEMPLATE 环境变量的值。

DEFAULT_RAG_TEMPLATE:

### 任务:
使用提供的上下文响应用户查询，**仅当 <source> 标记包含明确的 id 属性时**（例如，<source id="1">），以 [id] 格式包含内联引用。

### 指导原则:
- 如果您不知道答案，请明确说明。
- 如果不确定，请要求用户澄清。
- 使用与用户查询相同的语言回应。
- 如果上下文不可读或质量差，请通知用户并提供最佳可能的答案。
- 如果答案不在上下文中但您拥有知识，请向用户解释这一点，并使用您自己的理解提供答案。
- **仅当 <source> 标记包含 id 属性时，才使用 [id]（例如，[1]、[2]）包含内联引用。**
- 如果 <source> 标记不包含 id 属性，请不要引用。
- 不要在响应中使用 XML 标记。
- 确保引用简洁且与提供的信息直接相关。

### 引用示例:
如果用户询问特定主题，信息在具有提供的 id 属性的源中找到，响应应包括像以下示例中的引用：
* "根据研究，提出的方法将效率提高了 20% [1]。"

### 输出:
为用户的查询提供清晰直接的响应，仅当上下文中存在带有 id 属性的 <source> 标记时，才包含 [id] 格式的内联引用。

<context>
{{CONTEXT}}
</context>

<user_query>
{{QUERY}}
</user_query>
  • 描述: 将 RAG 文档注入聊天完成时使用的模板
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_TEXT_SPLITTER​

  • 类型: str
  • 选项:
    • character
    • token
  • 默认值: character
  • 描述: 设置 RAG 模型的文本分割器。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TIKTOKEN_CACHE_DIR​

  • 类型: str
  • 默认值: {CACHE_DIR}/tiktoken
  • 描述: 设置 TikToken 缓存目录。

TIKTOKEN_ENCODING_NAME​

  • 类型: str
  • 默认值: cl100k_base
  • 描述: 设置 TikToken 的编码名称。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CHUNK_SIZE​

  • 类型: int
  • 默认值: 1000
  • 描述: 设置嵌入的文档块大小。
  • 持久性: 此环境变量是 PersistentConfig 变量。

CHUNK_OVERLAP​

  • 类型: int
  • 默认值: 100
  • 描述: 指定块之间应有多少重叠。
  • 持久性: 此环境变量是 PersistentConfig 变量。

PDF_EXTRACT_IMAGES​

  • 类型: bool
  • 默认值: False
  • 描述: 在加载文档时使用 OCR 从 PDF 中提取图像。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_FILE_MAX_SIZE​

  • 类型: int
  • 描述: 设置可以上传用于文档摄取的文件的最大大小（以兆字节为单位）。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_FILE_MAX_COUNT​

  • 类型: int
  • 描述: 设置一次可以上传用于文档摄取的文件的最大数量。
  • 持久性: 此环境变量是 PersistentConfig 变量。
info

配置 RAG_FILE_MAX_SIZE 和 RAG_FILE_MAX_COUNT 时，确保值合理以防止过度文件上传和潜在的性能问题。

RAG_ALLOWED_FILE_EXTENSIONS​

  • 类型: list of str
  • 默认值: []（意味着允许所有支持的文件类型）
  • 描述: 指定允许上传的文件扩展名。
["pdf,docx,txt"]
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_RERANKING_MODEL​

  • 类型: str
  • 描述: 设置重新排序结果的模型。本地使用 Sentence-Transformer 模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_OPENAI_API_BASE_URL​

  • 类型: str
  • 默认值: ${OPENAI_API_BASE_URL}
  • 描述: 设置用于 RAG 嵌入的 OpenAI 基础 API URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_OPENAI_API_KEY​

  • 类型: str
  • 默认值: ${OPENAI_API_KEY}
  • 描述: 设置用于 RAG 嵌入的 OpenAI API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_EMBEDDING_OPENAI_BATCH_SIZE​

  • 类型: int
  • 默认值: 1
  • 描述: 设置 OpenAI 嵌入的批处理大小。

RAG_EMBEDDING_BATCH_SIZE​

  • 类型: int
  • 默认值: 1
  • 描述: 设置 RAG（检索增强生成器）模型中嵌入的批处理大小。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_OLLAMA_API_KEY​

  • 类型: str
  • 描述: 设置 RAG 模型中使用的 Ollama API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_OLLAMA_BASE_URL​

  • 类型: str
  • 描述: 设置 RAG 模型中使用的 Ollama API 的基础 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_RETRIEVAL_QUERY_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用检索查询生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

QUERY_GENERATION_PROMPT_TEMPLATE​

  • 类型: str
  • 默认值: DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE 环境变量的值。

DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE:

### 任务:
分析聊天历史以确定是否需要用给定语言生成搜索查询。默认情况下，**优先生成 1-3 个广泛且相关的搜索查询**，除非绝对确定不需要额外信息。目标是检索全面、更新和有价值的信息，即使在最小的不确定性下也是如此。如果明确不需要搜索，则返回空列表。

### 指导原则:
- **仅**响应 JSON 对象。严格禁止任何形式的额外评论、解释或附加文本。
- 生成搜索查询时，按以下格式响应：{ "queries": ["query1", "query2"] }，确保每个查询都是独特、简洁且与主题相关的。
- 当且仅当完全确定搜索无法检索到有用结果时，返回：{ "queries": [] }。
- 如果**有任何可能**搜索查询可能提供有用或更新的信息，则倾向于建议搜索查询。
- 要简洁，专注于编写高质量的搜索查询，避免不必要的阐述、评论或假设。
- 今天的日期是：{{CURRENT_DATE}}。
- 始终优先提供可操作的广泛查询，最大化信息覆盖范围。

### 输出:
严格以 JSON 格式返回：
{
  "queries": ["query1", "query2"]
}

### 聊天历史:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
  • 描述: 设置查询生成的提示模板。
  • 持久性: 此环境变量是 PersistentConfig 变量。

BYPASS_EMBEDDING_AND_RETRIEVAL​

  • 类型: bool
  • 默认值: False
  • 描述: 绕过嵌入和检索过程。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DOCUMENT_INTELLIGENCE_ENDPOINT​

  • 类型: str
  • 默认值: None
  • 描述: 指定文档智能的端点。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DOCUMENT_INTELLIGENCE_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 指定文档智能的密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_RAG_LOCAL_WEB_FETCH​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 RAG 的本地网络获取。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_EMBEDDING_CONTENT_PREFIX​

  • 类型: str
  • 默认值: None
  • 描述: 指定 RAG 嵌入内容的前缀。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_EMBEDDING_PREFIX_FIELD_NAME​

  • 类型: str
  • 默认值: None
  • 描述: 指定 RAG 嵌入前缀的字段名称。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_EMBEDDING_QUERY_PREFIX​

  • 类型: str
  • 默认值: None
  • 描述: 指定 RAG 嵌入查询的前缀。
  • 持久性: 此环境变量是 PersistentConfig 变量。

RAG_FULL_CONTEXT​

  • 类型: bool
  • 默认值: False
  • 描述: 指定是否为 RAG 使用完整上下文。
  • 持久性: 此环境变量是 PersistentConfig 变量。

Google Drive​

ENABLE_GOOGLE_DRIVE_INTEGRATION​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 Google Drive 集成。如果设置为 true，并且 GOOGLE_DRIVE_CLIENT_ID 和 GOOGLE_DRIVE_API_KEY 都已配置，Google Drive 将在聊天 UI 中显示为上传选项。
  • 持久性: 此环境变量是 PersistentConfig 变量。
info

启用 GOOGLE_DRIVE_INTEGRATION 时，请确保您已正确配置 GOOGLE_DRIVE_CLIENT_ID 和 GOOGLE_DRIVE_API_KEY，并已查看 Google 的服务条款和使用指南。

GOOGLE_DRIVE_CLIENT_ID​

  • 类型: str
  • 描述: 设置 Google Drive 的客户端 ID（客户端必须配置为启用 Drive API 和 Picker API）。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GOOGLE_DRIVE_API_KEY​

  • 类型: str
  • 描述: 设置 Google Drive 集成的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OneDrive​

ENABLE_ONEDRIVE_INTEGRATION​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 OneDrive 集成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ONEDRIVE_CLIENT_ID​

  • 类型: str
  • 默认值: None
  • 描述: 指定 OneDrive 集成的客户端 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

网络搜索​

  • 类型: bool
  • 默认值: False
  • 描述: 启用网络搜索切换。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_SEARCH_QUERY_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用搜索查询生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WEB_SEARCH_TRUST_ENV​

  • 类型: bool
  • 默认值: False
  • 描述: 在网络搜索内容获取期间启用由 http_proxy 和 https_proxy 设置的代理。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WEB_SEARCH_RESULT_COUNT​

  • 类型: int
  • 默认值: 3
  • 描述: 要爬取的搜索结果的最大数量。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WEB_SEARCH_CONCURRENT_REQUESTS​

  • 类型: int
  • 默认值: 10
  • 描述: 爬取从搜索结果返回的网页的并发请求数量。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WEB_SEARCH_ENGINE​

  • 类型: str
  • 选项:
  • 持久性: 此环境变量是 PersistentConfig 变量。

BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL​

  • 类型: bool
  • 默认值: False
  • 描述: 绕过网络搜索嵌入和检索过程。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SEARXNG_QUERY_URL​

  • 类型: str
  • 描述: 支持 JSON 输出的 SearXNG 搜索 API URL。<query> 被替换为搜索查询。示例: http://searxng.local/search?q=<query>
  • 持久性: 此环境变量是 PersistentConfig 变量。

GOOGLE_PSE_API_KEY​

  • 类型: str
  • 描述: 设置 Google 可编程搜索引擎（PSE）服务的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GOOGLE_PSE_ENGINE_ID​

  • 类型: str
  • 描述: Google 可编程搜索引擎（PSE）服务的引擎 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

BRAVE_SEARCH_API_KEY​

  • 类型: str
  • 描述: 设置 Brave 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

KAGI_SEARCH_API_KEY​

  • 类型: str
  • 描述: 设置 Kagi 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MOJEEK_SEARCH_API_KEY​

  • 类型: str
  • 描述: 设置 Mojeek 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SERPSTACK_API_KEY​

  • 类型: str
  • 描述: 设置 Serpstack 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SERPSTACK_HTTPS​

  • 类型: bool
  • 默认值: True
  • 描述: 配置 Serpstack 请求是否使用 HTTPS。免费层请求仅限于 HTTP。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SERPER_API_KEY​

  • 类型: str
  • 描述: 设置 Serper 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SERPLY_API_KEY​

  • 类型: str
  • 描述: 设置 Serply 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SEARCHAPI_API_KEY​

  • 类型: str
  • 描述: 设置 SearchAPI 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SEARCHAPI_ENGINE​

  • 类型: str
  • 描述: 设置 SearchAPI 引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TAVILY_API_KEY​

  • 类型: str
  • 描述: 设置 Tavily 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

JINA_API_KEY​

  • 类型: str
  • 描述: 设置 Jina 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

BING_SEARCH_V7_ENDPOINT​

  • 类型: str
  • 描述: 设置 Bing 搜索 API 的端点。
  • 持久性: 此环境变量是 PersistentConfig 变量。

BING_SEARCH_V7_SUBSCRIPTION_KEY​

  • 类型: str
  • 默认值: https://api.bing.microsoft.com/v7.0/search
  • 描述: 设置 Bing 搜索 API 的订阅密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

BOCHA_SEARCH_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置 Bocha 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

EXA_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置 Exa 搜索 API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SERPAPI_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置 SerpAPI 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SERPAPI_ENGINE​

  • 类型: str
  • 默认值: None
  • 描述: 指定 SerpAPI 使用的搜索引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SOUGOU_API_SID​

  • 类型: str
  • 默认值: None
  • 描述: 设置搜狗 API SID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

SOUGOU_API_SK​

  • 类型: str
  • 默认值: None
  • 描述: 设置搜狗 API SK。
  • 持久性: 此环境变量是 PersistentConfig 变量。

TAVILY_EXTRACT_DEPTH​

  • 类型: str
  • 默认值: basic
  • 描述: 指定 Tavily 搜索结果的提取深度。
  • 持久性: 此环境变量是 PersistentConfig 变量。

网页加载器配置​

WEB_LOADER_ENGINE​

  • 类型: str
  • 默认值: safe_web
  • 描述: 指定用于检索和处理网页内容的加载器。
  • 选项:
    • requests - 使用具有增强错误处理的 Requests 模块。
    • playwright - 使用 Playwright 进行更高级的网页渲染和交互。
  • 持久性: 此环境变量是 PersistentConfig 变量。
info

使用 playwright 时，您有两个选择：

  1. 如果未设置 PLAYWRIGHT_WS_URI，Playwright 和 Chromium 依赖项将在 Open WebUI 容器启动时自动安装。
  2. 如果设置了 PLAYWRIGHT_WS_URI，Open WebUI 将连接到远程浏览器实例，而不是在本地安装依赖项。

PLAYWRIGHT_WS_URL​

  • 类型: str
  • 默认值: None
  • 描述: 指定远程 Playwright 浏览器实例的 WebSocket URI。设置后，Open WebUI 将使用此远程浏览器而不是在本地安装浏览器依赖项。这在容器化环境中特别有用，您希望保持 Open WebUI 容器的轻量级并分离浏览器问题。示例: ws://playwright:3000
  • 持久性: 此环境变量是 PersistentConfig 变量。
tip

通过 PLAYWRIGHT_WS_URL 使用远程 Playwright 浏览器可能有益于：

  • 减少 Open WebUI 容器的大小
  • 使用默认 Chromium 以外的不同浏览器
  • 连接到非无头（GUI）浏览器

FIRECRAWL_API_BASE_URL​

  • 类型: str
  • 默认值: https://api.firecrawl.dev
  • 描述: 设置 Firecrawl API 的基础 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

FIRECRAWL_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置 Firecrawl API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

PERPLEXITY_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 设置 Perplexity API 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

PLAYWRIGHT_TIMEOUT​

  • 类型: int
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 Playwright 请求的超时时间。
  • 持久性: 此环境变量是 PersistentConfig 变量。

YouTube 加载器​

YOUTUBE_LOADER_PROXY_URL​

  • 类型: str
  • 描述: 设置 YouTube 加载器的代理 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

YOUTUBE_LOADER_LANGUAGE​

  • 类型: str
  • 默认值: en
  • 描述: 获取 YouTube 视频转录时尝试的语言代码的逗号分隔列表，按优先级顺序。
  • 示例: 如果设置为 es,de，将首先尝试西班牙语转录，如果西班牙语不可用则尝试德语，最后尝试英语。注意：如果指定的语言都不可用且您的列表中没有 en，系统将自动尝试英语作为最终后备。
  • 持久性: 此环境变量是 PersistentConfig 变量。

音频​

Whisper 语音转文本（本地）​

WHISPER_MODEL​

  • 类型: str
  • 默认值: base
  • 描述: 设置用于语音转文本的 Whisper 模型。后端使用 faster_whisper 并量化为 int8。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WHISPER_MODEL_DIR​

  • 类型: str
  • 默认值: ${DATA_DIR}/cache/whisper/models
  • 描述: 指定存储 Whisper 模型文件的目录。

WHISPER_VAD_FILTER​

  • 类型: bool
  • 默认值: False
  • 描述: 指定是否对 Whisper 语音转文本应用语音活动检测（VAD）过滤器。
  • 持久性: 此环境变量是 PersistentConfig 变量。

WHISPER_MODEL_AUTO_UPDATE​

  • 类型: bool
  • 默认值: False
  • 描述: 切换 Whisper 模型的自动更新。

WHISPER_LANGUAGE​

  • 类型: str
  • 默认值: None
  • 描述: 指定 Whisper 用于 STT 的 ISO 639-1 语言（夏威夷语和粤语使用 ISO 639-2）。Whisper 默认预测语言。

语音转文本（OpenAI）​

AUDIO_STT_ENGINE​

  • 类型: str
  • 选项:
    • 留空使用内置的本地 Whisper 引擎进行语音转文本。
    • openai - 使用 OpenAI 引擎进行语音转文本。
    • deepgram - 使用 Deepgram 引擎进行语音转文本。
    • azure - 使用 Azure 引擎进行语音转文本。
  • 描述: 指定要使用的语音转文本引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_STT_MODEL​

  • 类型: str
  • 默认值: whisper-1
  • 描述: 指定用于 OpenAI 兼容端点的语音转文本模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_STT_OPENAI_API_BASE_URL​

  • 类型: str
  • 默认值: ${OPENAI_API_BASE_URL}
  • 描述: 设置用于语音转文本的 OpenAI 兼容基础 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_STT_OPENAI_API_KEY​

  • 类型: str
  • 默认值: ${OPENAI_API_KEY}
  • 描述: 设置用于语音转文本的 OpenAI API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

语音转文本（Azure）​

AUDIO_STT_AZURE_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于语音转文本的 Azure API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_STT_AZURE_REGION​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于语音转文本的 Azure 区域。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_STT_AZURE_LOCALES​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于 Azure 语音转文本的语言环境。
  • 持久性: 此环境变量是 PersistentConfig 变量。

语音转文本（Deepgram）​

DEEPGRAM_API_KEY​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于语音转文本的 Deepgram API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

文本转语音​

AUDIO_TTS_API_KEY​

  • 类型: str
  • 描述: 设置文本转语音的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_TTS_ENGINE​

  • 类型: str
  • 选项:
    • 留空使用内置的 WebAPI 引擎进行文本转语音。
    • azure - 使用 Azure 引擎进行文本转语音。
    • elevenlabs - 使用 ElevenLabs 引擎进行文本转语音。
    • openai - 使用 OpenAI 引擎进行文本转语音。
    • transformers - 使用 SentenceTransformers 进行文本转语音。
  • 描述: 指定要使用的文本转语音引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_TTS_MODEL​

  • 类型: str
  • 默认值: tts-1
  • 描述: 指定要使用的 OpenAI 文本转语音模型。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_TTS_VOICE​

  • 类型: str
  • 默认值: alloy
  • 描述: 设置要使用的 OpenAI 文本转语音声音。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_TTS_SPLIT_ON​

  • 类型: str
  • 默认值: punctuation
  • 描述: 设置要使用的 OpenAI 文本转语音分割方式。
  • 持久性: 此环境变量是 PersistentConfig 变量。

Azure 文本转语音​

AUDIO_TTS_AZURE_SPEECH_REGION​

  • 类型: str
  • 描述: 设置 Azure 文本转语音的区域。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT​

  • 类型: str
  • 描述: 设置 Azure 文本转语音的输出格式。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OpenAI 文本转语音​

AUDIO_TTS_OPENAI_API_BASE_URL​

  • 类型: str
  • 默认值: ${OPENAI_API_BASE_URL}
  • 描述: 设置用于文本转语音的 OpenAI 兼容基础 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUDIO_TTS_OPENAI_API_KEY​

  • 类型: str
  • 默认值: ${OPENAI_API_KEY}
  • 描述: 设置用于文本转语音的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

图像生成​

IMAGE_GENERATION_ENGINE​

  • 类型: str
  • 选项:
    • openai - 使用 OpenAI DALL-E 进行图像生成。
    • comfyui - 使用 ComfyUI 引擎进行图像生成。
    • automatic1111 - 使用 AUTOMATIC1111 引擎进行图像生成。
    • gemini - 使用 Gemini 进行图像生成。
  • 默认值: openai
  • 描述: 指定用于图像生成的引擎。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_IMAGE_GENERATION​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用图像生成功能。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_IMAGE_PROMPT_GENERATION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用图像提示生成。
  • 持久性: 此环境变量是 PersistentConfig 变量。

IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE​

  • 类型: str
  • 默认值: None
  • 描述: 指定用于生成图像提示的模板。
  • 持久性: 此环境变量是 PersistentConfig 变量。

DEFAULT_IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE:

### 任务:
基于给定的语言和上下文生成图像生成任务的详细提示。描述图像时就像您在向看不见它的人解释一样。包括相关的细节、颜色、形状和任何其他重要元素。

### 指导原则:
- 要描述性和详细，专注于图像最重要的方面。
- 避免做出假设或添加图像中不存在的信息。
- 使用聊天的主要语言；如果是多语言则默认为英语。
- 如果图像太复杂，专注于最突出的元素。

### 输出:
严格以 JSON 格式返回:
{
    "prompt": "您的详细描述在这里。"
}

### 聊天历史:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>

IMAGE_SIZE​

  • 类型: str
  • 默认值: 512x512
  • 描述: 设置要生成的默认图像大小。
  • 持久性: 此环境变量是 PersistentConfig 变量。

IMAGE_STEPS​

  • 类型: int
  • 默认值: 50
  • 描述: 设置图像生成的默认迭代步数。用于 ComfyUI 和 AUTOMATIC1111。
  • 持久性: 此环境变量是 PersistentConfig 变量。

IMAGE_GENERATION_MODEL​

  • 类型: str
  • 描述: 用于图像生成的默认模型
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUTOMATIC1111​

AUTOMATIC1111_BASE_URL​

  • 类型: str
  • 描述: 指定 AUTOMATIC1111 的 Stable Diffusion API URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUTOMATIC1111_API_AUTH​

  • 类型: str
  • 描述: 设置 AUTOMATIC1111 API 身份验证。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUTOMATIC1111_CFG_SCALE​

  • 类型: float
  • 描述: 设置 AUTOMATIC1111 推理的缩放比例。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUTOMATIC1111_SAMPLER​

  • 类型: str
  • 描述: 设置 AUTOMATIC1111 推理的采样器。
  • 持久性: 此环境变量是 PersistentConfig 变量。

AUTOMATIC1111_SCHEDULER​

  • 类型: str
  • 描述: 设置 AUTOMATIC1111 推理的调度器。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ComfyUI​

COMFYUI_BASE_URL​

  • 类型: str
  • 描述: 指定 ComfyUI 图像生成 API 的 URL。
  • 持久性: 此环境变量是 PersistentConfig 变量。

COMFYUI_API_KEY​

  • 类型: str
  • 描述: 设置 ComfyUI 的 API 密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

COMFYUI_WORKFLOW​

  • 类型: str
  • 默认值: [ComfyUI 工作流 JSON 配置]
  • 描述: 设置 ComfyUI 工作流配置。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAuth 身份验证​

OAuth 允许用户使用现有服务提供商账户登录 Open WebUI。

通用 OAuth 配置​

ENABLE_OAUTH_SIGNUP​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 OAuth 注册。
  • 持久性: 此环境变量是 PersistentConfig 变量。

Google​

GOOGLE_CLIENT_ID​

  • 类型: str
  • 描述: 设置 Google OAuth 的客户端 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GOOGLE_CLIENT_SECRET​

  • 类型: str
  • 描述: 设置 Google OAuth 的客户端密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GOOGLE_OAUTH_SCOPE​

  • 类型: str
  • 默认值: openid email profile
  • 描述: 设置 Google OAuth 身份验证的范围。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GOOGLE_REDIRECT_URI​

  • 类型: str
  • 默认值: <backend>/oauth/google/callback
  • 描述: 设置 Google OAuth 的重定向 URI。
  • 持久性: 此环境变量是 PersistentConfig 变量。

Microsoft​

MICROSOFT_CLIENT_ID​

  • 类型: str
  • 描述: 设置 Microsoft OAuth 的客户端 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MICROSOFT_CLIENT_SECRET​

  • 类型: str
  • 描述: 设置 Microsoft OAuth 的客户端密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MICROSOFT_CLIENT_TENANT_ID​

  • 类型: str
  • 描述: 设置 Microsoft OAuth 的租户 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MICROSOFT_OAUTH_SCOPE​

  • 类型: str
  • 默认值: openid email profile
  • 描述: 设置 Microsoft OAuth 身份验证的范围。
  • 持久性: 此环境变量是 PersistentConfig 变量。

MICROSOFT_REDIRECT_URI​

  • 类型: str
  • 默认值: <backend>/oauth/microsoft/callback
  • 描述: 设置 Microsoft OAuth 的重定向 URI。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GitHub​

参见 https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps

GITHUB_CLIENT_ID​

  • 类型: str
  • 描述: 设置 GitHub OAuth 的客户端 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GITHUB_CLIENT_SECRET​

  • 类型: str
  • 描述: 设置 GitHub OAuth 的客户端密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GITHUB_CLIENT_SCOPE​

  • 类型: str
  • 默认值: user:email
  • 描述: 指定 GitHub OAuth 身份验证的范围。
  • 持久性: 此环境变量是 PersistentConfig 变量。

GITHUB_CLIENT_REDIRECT_URI​

  • 类型: str
  • 默认值: <backend>/oauth/github/callback
  • 描述: 设置 GitHub OAuth 的重定向 URI。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OpenID (OIDC)​

OAUTH_CLIENT_ID​

  • 类型: str
  • 描述: 设置 OIDC 的客户端 ID。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_CLIENT_SECRET​

  • 类型: str
  • 描述: 设置 OIDC 的客户端密钥。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OPENID_PROVIDER_URL​

  • 类型: str
  • 描述: .well-known/openid-configuration 端点的路径
  • 持久性: 此环境变量是 PersistentConfig 变量。

OPENID_REDIRECT_URI​

  • 类型: str
  • 默认值: <backend>/oauth/oidc/callback
  • 描述: 设置 OIDC 的重定向 URI
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_SCOPES​

  • 类型: str
  • 默认值: openid email profile
  • 描述: 设置 OIDC 身份验证的范围。openid 和 email 是必需的。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_CODE_CHALLENGE_METHOD​

  • 类型: str
  • 默认值: 空字符串 (' ')，因为 None 设置为默认值。
  • 描述: 指定 OAuth 身份验证的代码质询方法。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_PROVIDER_NAME​

  • 类型: str
  • 默认值: SSO
  • 描述: 设置 OIDC 提供商的名称。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_USERNAME_CLAIM​

  • 类型: str
  • 默认值: name
  • 描述: 设置 OpenID 的用户名声明。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_EMAIL_CLAIM​

  • 类型: str
  • 默认值: email
  • 描述: 设置 OpenID 的电子邮件声明。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_PICTURE_CLAIM​

  • 类型: str
  • 默认值: picture
  • 描述: 设置 OpenID 的头像（avatar）声明。
  • 持久性: 此环境变量是 PersistentConfig 变量。
info

如果 OAUTH_PICTURE_CLAIM 设置为 ''（空字符串），则禁用 OAuth 头像声明，用户头像将不会被保存。

OAUTH_GROUP_CLAIM​

  • 类型: str
  • 默认值: groups
  • 描述: 指定 OAuth 身份验证的组声明。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_OAUTH_ROLE_MANAGEMENT​

  • 类型: bool
  • 默认值: False
  • 描述: 启用 OAuth 委派的角色管理。
  • 持久性: 此环境变量是 PersistentConfig 变量。

ENABLE_OAUTH_GROUP_MANAGEMENT​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 OAuth 组管理。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_ROLES_CLAIM​

  • 类型: str
  • 默认值: roles
  • 描述: 设置要在 OIDC 令牌中查找的角色声明。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_ALLOWED_ROLES​

  • 类型: str
  • 默认值: user,admin
  • 描述: 设置允许访问平台的角色。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_ADMIN_ROLES​

  • 类型: str
  • 默认值: admin
  • 描述: 设置被视为管理员的角色。
  • 持久性: 此环境变量是 PersistentConfig 变量。

OAUTH_ALLOWED_DOMAINS​

  • 类型: str
  • 默认值: *
  • 描述: 指定 OAuth 身份验证允许的域。（例如 "example1.com,example2.com"）。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP​

ENABLE_LDAP​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用 LDAP 身份验证。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_SERVER_LABEL​

  • 类型: str
  • 描述: 设置 LDAP 服务器的标签。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_SERVER_HOST​

  • 类型: str
  • 默认值: localhost
  • 描述: 设置 LDAP 服务器的主机名。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_SERVER_PORT​

  • 类型: int
  • 默认值: 389
  • 描述: 设置 LDAP 服务器的端口号。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_ATTRIBUTE_FOR_MAIL​

  • 类型: str
  • 描述: 设置用作 LDAP 身份验证邮件的属性。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_ATTRIBUTE_FOR_USERNAME​

  • 类型: str
  • 描述: 设置用作 LDAP 身份验证用户名的属性。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_APP_DN​

  • 类型: str
  • 描述: 设置 LDAP 应用程序的专有名称。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_APP_PASSWORD​

  • 类型: str
  • 描述: 设置 LDAP 应用程序的密码。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_SEARCH_BASE​

  • 类型: str
  • 描述: 设置 LDAP 身份验证的搜索基础。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_SEARCH_FILTER​

  • 类型: str
  • 默认值: None
  • 描述: 设置用于 LDAP 搜索的单个过滤器。替代 LDAP_SEARCH_FILTERS。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_SEARCH_FILTERS​

  • 类型: str
  • 默认值: (&(objectClass=inetOrgPerson)(uid={username}))
  • 描述: 设置 LDAP 搜索过滤器以对 LDAP 服务器进行身份验证。要使用多个过滤器，请提供一个 JSON 格式的列表。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_USE_TLS​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用 LDAP 连接的 TLS。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_CA_CERT_FILE​

  • 类型: str
  • 默认值: None
  • 描述: 指定 LDAP 连接的 CA 证书文件。
  • 持久性: 此环境变量是 PersistentConfig 变量。

LDAP_CIPHERS​

  • 类型: str
  • 默认值: ALL
  • 描述: 设置 LDAP 连接的密码套件。
  • 持久性: 此环境变量是 PersistentConfig 变量。

用户权限​

功能权限​

USER_PERMISSIONS_CHAT_DELETION​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用用户删除聊天的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_CHAT_EDITING​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用用户编辑聊天的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_CHAT_TEMPORARY​

  • 类型: bool
  • 默认值: True
  • 描述: 启用或禁用用户创建临时聊天的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_FEATURES_IMAGE_GENERATION​

  • 类型: str
  • 默认值: True
  • 描述: 启用或禁用用户使用图像生成功能的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_FEATURES_CODE_INTERPRETER​

  • 类型: str
  • 默认值: True
  • 描述: 启用或禁用用户使用代码解释器功能的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

工作区权限​

USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用用户访问工作区模型的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用用户访问工作区知识的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用用户访问工作区提示的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS​

  • 类型: bool
  • 默认值: False
  • 描述: 启用或禁用用户访问工作区工具的权限。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_PUBLIC_SHARING​

  • 类型: str
  • 默认值: False
  • 描述: 启用或禁用工作区模型的公共分享。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ALLOW_PUBLIC_SHARING​

  • 类型: str
  • 默认值: False
  • 描述: 启用或禁用工作区知识的公共分享。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_PUBLIC_SHARING​

  • 类型: str
  • 默认值: False
  • 描述: 启用或禁用工作区提示的公共分享。
  • 持久性: 此环境变量是 PersistentConfig 变量。

USER_PERMISSIONS_WORKSPACE_TOOLS_ALLOW_PUBLIC_SHARING​

  • 类型: str
  • 默认值: False
  • 描述: 启用或禁用工作区工具的公共分享。
  • 持久性: 此环境变量是 PersistentConfig 变量。

杂项环境变量​

这些变量不是 Open WebUI 特有的，但在某些情况下仍然有价值。

云存储​

STORAGE_PROVIDER​

  • 类型: str
  • 选项:
  • 默认值: 空字符串 (' ')，默认为 local
  • 描述: 设置存储提供商。

Amazon S3 存储​

S3_ACCESS_KEY_ID​

  • 类型: str
  • 描述: 设置 S3 存储的访问密钥 ID。

S3_ADDRESSING_STYLE​

  • 类型: str
  • 默认值: None
  • 描述: 指定 S3 存储使用的寻址样式（例如，'path'、'virtual'）。

S3_BUCKET_NAME​

  • 类型: str
  • 描述: 设置 S3 存储的存储桶名称。

S3_ENDPOINT_URL​

  • 类型: str
  • 描述: 设置 S3 存储的端点 URL。

S3_KEY_PREFIX​

  • 类型: str
  • 描述: 设置 S3 对象的密钥前缀。

S3_REGION_NAME​

  • 类型: str
  • 描述: 设置 S3 存储的区域名称。

S3_SECRET_ACCESS_KEY​

  • 类型: str
  • 描述: 设置 S3 存储的秘密访问密钥。

S3_USE_ACCELERATE_ENDPOINT​

  • 类型: str
  • 默认值: False
  • 描述: 指定是否为 S3 存储使用加速端点。

S3_ENABLE_TAGGING​

  • 类型: str
  • 默认值: False
  • 描述: 启用上传后的 S3 对象标记以改善组织、搜索和与文件管理策略的集成。使用 Cloudflare R2 时始终设置为 False，因为 R2 不支持对象标记。

Google Cloud Storage​

GOOGLE_APPLICATION_CREDENTIALS_JSON​

  • 类型: str
  • 描述: Google 应用程序凭据 JSON 文件的内容。
    • 可选 - 如果未提供，凭据将从环境中获取。如果在本地运行则为用户凭据，如果在 Google 计算引擎上运行则为 Google 元数据服务器。
    • 可以按照此指南为服务账户生成文件。

GCS_BUCKET_NAME​

  • 类型: str
  • 描述: 设置 Google Cloud Storage 的存储桶名称。存储桶必须已存在。

Microsoft Azure Storage​

AZURE_STORAGE_ENDPOINT​

  • 类型: str
  • 描述: 设置 Azure Storage 的端点 URL。

AZURE_STORAGE_CONTAINER_NAME​

  • 类型: str
  • 描述: 设置 Azure Storage 的容器名称。

AZURE_STORAGE_KEY​

  • 类型: str
  • 描述: 设置 Azure Storage 的访问密钥。
    • 可选 - 如果未提供，凭据将从环境中获取。如果在本地运行则为用户凭据，如果在 Azure 服务中运行则为托管身份。

数据库池​

DATABASE_URL​

  • 类型: str
  • 默认值: sqlite:///${DATA_DIR}/webui.db
  • 描述: 指定要连接的数据库 URL。
info

支持 SQLite 和 Postgres。更改 URL 不会在数据库之间迁移数据。 URL 方案的文档可在此处获得。

DATABASE_SCHEMA​

  • 类型: str
  • 默认值: None
  • 描述: 指定要连接的数据库模式。

DATABASE_POOL_SIZE​

  • 类型: int
  • 默认值: 0
  • 描述: 指定数据库池的大小。值 0 禁用池。

DATABASE_POOL_MAX_OVERFLOW​

  • 类型: int
  • 默认值: 0
  • 描述: 指定数据库池的最大溢出。
info

有关此设置的更多信息可在此处找到。

DATABASE_POOL_TIMEOUT​

  • 类型: int
  • 默认值: 30
  • 描述: 指定获取连接的数据库池超时时间（秒）。
info

有关此设置的更多信息可在此处找到。

DATABASE_POOL_RECYCLE​

  • 类型: int
  • 默认值: 3600
  • 描述: 指定数据库池回收时间（秒）。
info

有关此设置的更多信息可在此处找到。

Redis​

REDIS_URL​

  • 类型: str
  • 示例: redis://localhost:6379/0
  • 描述: 指定用于应用状态的 Redis 实例 URL。
info

在负载均衡器的多节点/工作器集群中部署 Open-WebUI 时，必须确保设置 REDIS_URL 值。没有它，应用状态中的会话、持久性和一致性问题将发生，因为工作器将无法通信。

REDIS_SENTINEL_HOSTS​

  • 类型: str
  • 描述: 用于应用状态的 Redis Sentinels 的逗号分隔列表。如果指定，REDIS_URL 中的"主机名"将被解释为 Sentinel 服务名称。

REDIS_SENTINEL_PORT​

  • 类型: int
  • 默认值: 26379
  • 描述: 应用状态 Redis 的 Sentinel 端口。

ENABLE_WEBSOCKET_SUPPORT​

  • 类型: bool
  • 默认值: True
  • 描述: 在 Open WebUI 中启用 websocket 支持。
info

在负载均衡器的多节点/工作器集群中部署 Open-WebUI 时，必须确保设置 ENABLE_WEBSOCKET_SUPPORT 值。没有它，websocket 一致性和持久性问题将发生。

WEBSOCKET_MANAGER​

  • 类型: str
  • 默认值: redis
  • 描述: 指定要使用的 websocket 管理器（在这种情况下，Redis）。
info

在负载均衡器的多节点/工作器集群中部署 Open-WebUI 时，必须确保设置 WEBSOCKET_MANAGER 值并使用像 Redis 这样的键值 NoSQL 数据库。没有它，websocket 一致性和持久性问题将发生。

WEBSOCKET_REDIS_URL​

  • 类型: str
  • 默认值: ${REDIS_URL}
  • 描述: 指定用于 websocket 通信的 Redis 实例 URL。它与 REDIS_URL 不同，在实践中，建议同时设置两者。
info

在负载均衡器的多节点/工作器集群中部署 Open-WebUI 时，必须确保设置 WEBSOCKET_REDIS_URL 值并使用像 Redis 这样的键值 NoSQL 数据库。没有它，websocket 一致性和持久性问题将发生。

WEBSOCKET_SENTINEL_HOSTS​

  • 类型: str
  • 描述: 用于 websocket 的 Redis Sentinels 的逗号分隔列表。如果指定，WEBSOCKET_REDIS_URL 中的"主机名"将被解释为 Sentinel 服务名称。

WEBSOCKET_SENTINEL_PORT​

  • 类型: int
  • 默认值: 26379
  • 描述: websocket Redis 的 Sentinel 端口。

Uvicorn 设置​

UVICORN_WORKERS​

  • 类型: int
  • 默认值: 1
  • 描述: 控制 Uvicorn 生成的工作进程数量以处理请求。每个工作器在单独的进程中运行应用程序的自己实例。
info

在像 Kubernetes 这样的编排环境中或使用 Helm charts 时，建议将 UVICORN_WORKERS 设置为 1。容器编排平台已经通过 pod 复制提供了自己的扩展机制，在容器内使用多个工作器可能导致资源分配问题并使水平扩展策略复杂化。

如果您使用 UVICORN_WORKERS，您还需要确保为可扩展的多实例设置相应地设置相关环境变量。

代理设置​

Open WebUI 支持为 HTTP 和 HTTPS 检索使用代理。要指定代理设置， Open WebUI 使用以下环境变量：

http_proxy​

  • 类型: str
  • 描述: 设置 HTTP 代理的 URL。

https_proxy​

  • 类型: str
  • 描述: 设置 HTTPS 代理的 URL。

no_proxy​

  • 类型: str
  • 描述: 列出不应使用代理的域扩展名（或 IP 地址），用逗号分隔。例如，将 no_proxy 设置为 '.mit.edu' 确保在访问来自 MIT 的文档时绕过代理。

安装所需的 Python 包​

Open WebUI 提供环境变量来自定义 pip 安装过程。以下是 Open WebUI 用于调整包安装行为的环境变量：

PIP_OPTIONS​

  • 类型: str
  • 描述: 指定 pip 在安装包时应使用的其他命令行选项。例如，您可以包含 --upgrade、--user 或 --no-cache-dir 等标志来控制安装过程。

PIP_PACKAGE_INDEX_OPTIONS​

  • 类型: str
  • 描述: 定义 pip 的自定义包索引行为。这可以包括指定其他或替代索引 URL（例如，--extra-index-url）、身份验证凭据或其他参数来管理从不同位置检索包的方式。