🌍 Конфигурация переменных окружения

Обзор

Open WebUI предоставляет широкий набор переменных окружения, которые позволяют настроить и конфигурировать различные аспекты приложения. Эта страница служит подробным справочником для всех доступных переменных окружения, предоставляя их типы, значения по умолчанию и описания. По мере добавления новых переменных эта страница будет обновляться, отражая растущие возможности конфигурации.

к сведению

Эта страница актуальна для версии Open WebUI v0.6.9, но все еще находится в процессе доработки, чтобы позже включить более точные описания, варианты возможных значений переменных окружения, их значения по умолчанию и улучшенные описания.

Важное замечание о переменных окружения PersistentConfig

примечание

При первом запуске Open WebUI все переменные окружения рассматриваются одинаково и могут использоваться для настройки приложения. Однако для переменных окружения, помеченных как PersistentConfig, их значения сохраняются и хранятся внутренне.

После первого запуска, при перезапуске контейнера, переменные окружения PersistentConfig больше не будут использовать значения внешних переменных окружения. Вместо этого они будут использовать внутренне сохраненные значения.

В отличие от этого, обычные переменные окружения будут продолжать обновляться и применяться при каждом последующем перезапуске.

Вы можете обновить значения переменных окружения PersistentConfig непосредственно из Open WebUI, и эти изменения будут сохранены внутренне. Это позволяет вам управлять этими настройками конфигурации независимо от внешних переменных окружения.

Обратите внимание, что переменные окружения PersistentConfig четко обозначены в данной документации, чтобы вы могли знать, как они будут вести себя.

Приложение/Бэкенд

Следующие переменные окружения используются backend/open_webui/config.py для предоставления настроек запуска Open WebUI. Обратите внимание, что некоторые переменные могут иметь разные значения по умолчанию в зависимости от того, запускаете ли вы Open WebUI напрямую или через Docker. Более подробную информацию о переменных окружения для логирования смотрите в нашей документации по логированию.

Общие

WEBUI_URL

• Тип: str
• Значение по умолчанию: http://localhost:3000
• Описание: Указывает URL, по которому доступен Open WebUI. В настоящее время используется для поддержки поисковых систем.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

ENABLE_SIGNUP

• Тип: bool
• Значение по умолчанию: True
• Описание: Переключает возможность создания учетных записей пользователей.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

ENABLE_LOGIN_FORM

• Тип: bool
• Значение по умолчанию: True
• Описание: Переключает элементы электронной почты, пароля, входа в систему и "или" (только если ENABLE_OAUTH_SIGNUP установлен на True).
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

осторожно

Эта настройка должна быть установлена в значение False только если ENABLE_OAUTH_SIGNUP также используется и установлена в значение True. Невыполнение этого требования приведет к невозможности входа в систему.

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.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

ENABLE_ADMIN_EXPORT

• Тип: bool
• По умолчанию: True
• Описание: Управляет разрешением для администраторов экспортировать данные.

ENABLE_ADMIN_CHAT_ACCESS

• Тип: bool
• По умолчанию: True
• Описание: Позволяет администраторам получать доступ ко всем чатам.

ENABLE_USER_WEBHOOKS

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает пользовательские вебхуки.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RESPONSE_WATERMARK

• Тип: str
• По умолчанию: Пустая строка ( )
• Описание: Устанавливает пользовательский текст, который будет добавляться при копировании сообщения в чате. Например, "Этот текст сгенерирован ИИ" -> добавит "Этот текст сгенерирован ИИ" к каждому скопированному сообщению.
• Постоянство: Эта переменная окружения является переменной типа 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 - Включает документацию API FastAPI на /docs.
  • prod - Автоконфигурирует несколько переменных окружения.
• По умолчанию:
  • Backend Default: dev
  • Docker Default: 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.

к сведению

Если вы запускаете приложение через Python, используя команду open-webui serve, вы не можете установить порт с помощью конфигурации PORT. Вместо этого вы должны указать его напрямую в виде аргумента командной строки, используя флаг --port. Например:

open-webui serve --port 9999

Это позволит запустить Open WebUI на порту 9999. Переменная окружения PORT в этом режиме игнорируется.

ENABLE_REALTIME_CHAT_SAVE

• Тип: bool
• По умолчанию: False
• Описание: Если включено, система будет сохранять каждый фрагмент данных потокового чата в базу данных в реальном времени для максимальной сохранности данных. Эта функция обеспечивает надежное восстановление данных и позволяет точно отслеживать сессии. Однако это увеличивает задержку, так как сохранение в базу данных приводит к задержке. Выключение этой функции может улучшить производительность и уменьшить задержки, но увеличивает риск потери данных в случае сбоя системы или аварии. Используйте, исходя из требований вашего приложения и приемлемых компромиссов.

BYPASS_MODEL_ACCESS_CONTROL

• Тип: bool
• По умолчанию: False
• Описание: Обходит контроль доступа к модели.

WEBUI_BUILD_HASH

• Тип: str
• По умолчанию: dev-build
• Описание: Используется для идентификации Git SHA сборки для релизов.

WEBUI_BANNERS

• Тип: list из dict
• По умолчанию: []
• Описание: Список баннеров для отображения пользователям. Формат баннеров такой:

[{"id": "string", "type": "string [info, success, warning, error]", "title": "string", "content": "string", "dismissible": false, "timestamp": 1000}]

• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

к сведению

При установке этой переменной окружения в файле .env убедитесь, что кавычки экранированы, обернув все значение в двойные кавычки и используя экранированные кавычки (\") для внутренних кавычек. Пример:

WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Ваши сообщения сохраняются.\", \"content\": \"Ваши сообщения сохраняются и могут быть просмотрены людьми. LLMы склонны к галлюцинациям, проверяйте источники.\", \"dismissible\": true, \"timestamp\": 1000}]"

USE_CUDA_DOCKER

• Тип: bool
• По умолчанию: False
• Описание: Создает образ Docker с поддержкой NVIDIA CUDA. Включает GPU-ускорение для локального Whisper и встраиваний.

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 из dict
• Значение по умолчанию: [] (что означает использование встроенных предложений запросов по умолчанию)
• Описание: Список предложений запросов. Формат предложений запросов:

[{"title": ["Часть заголовка 1", "Часть заголовка 2"], "content": "запрос"}]

Клиент AIOHTTP

AIOHTTP_CLIENT_TIMEOUT

• Тип: int
• Значение по умолчанию: 300
• Описание: Указывает длительность ожидания в секундах для клиента AIOHTTP. Это влияет на такие аспекты, как соединения с Ollama и конечными точками OpenAI.

к сведению

Это максимальное время, которое клиент будет ждать ответа перед завершением ожидания. Если установлено значение пустой строки (' '), время ожидания будет установлено как None, фактически отключая ограничение времени ожидания и позволяя клиенту ждать бесконечно.

AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST

• Тип: int
• Значение по умолчанию: 10
• Описание: Устанавливает длительность ожидания в секундах для получения списка моделей. Это может быть полезно в случаях, когда задержки в сети требуют увеличения времени ожидания для успешного получения списка моделей.

примечание

AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST установлено как 10 секунд по умолчанию, чтобы обеспечить доступность всех необходимых соединений при открытии веб-интерфейса. Эта длительность позволяет достаточно времени для получения списка моделей даже в случаях повышенной задержки сети. Вы можете уменьшить это значение, если предпочитаете более быстрые таймауты, но учитывайте, что это может привести к пропуску некоторых соединений в зависимости от условий вашей сети.

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
• Описание: Включает использование API Ollama.
• Устойчивость: Эта переменная окружения является переменной 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
• Описание: Настраивает URL бекенда Ollama.

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
• Описание: Сборка образа Docker с включенной Ollama.

K8S_FLAG

• Тип: bool
• Значение по умолчанию: False
• Описание: Если установлено, предполагает развертывание через Helm chart и устанавливает OLLAMA_BASE_URL как http://ollama-service.open-webui.svc.cluster.local:11434

OpenAI

ENABLE_OPENAI_API

• Тип: bool
• Значение по умолчанию: True
• Описание: Включает использование API OpenAI.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

OPENAI_API_BASE_URL

• Тип: str
• Значение по умолчанию: https://api.openai.com/v1
• Описание: Настраивает базовый URL API OpenAI.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

OPENAI_API_BASE_URLS

• Тип: str
• Описание: Поддерживает балансировку нагрузки между базовыми URL API OpenAI, разделенными точкой с запятой.
• Пример: http://host-one:11434;http://host-two:11434
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

OPENAI_API_KEY

• Тип: str
• Описание: Устанавливает ключ API OpenAI.
• Пример: sk-124781258123
• Персистентность: Эта переменная окружения является переменной PersistentConfig.

OPENAI_API_KEYS

• Тип: str
• Описание: Поддерживает несколько API-ключей OpenAI, разделённых точкой с запятой.
• Пример: 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": "ваш лаконичный заголовок тут" }
### Примеры:
- { "title": "📉 Тренды фондового рынка" },
- { "title": "🍪 Идеальный рецепт печенья с шоколадной крошкой" },
- { "title": "Эволюция музыкального стриминга" },
- { "title": "Советы по продуктивности удалённой работы" },
- { "title": "Искусственный интеллект в здравоохранении" },
- { "title": "🎮 Инсайты разработки видеоигр" }
### История чата:
<chat_history>
{{MESSAGES:END:2}}
</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": []
   }

- Если запрос соответствует одному или нескольким инструментам, создайте ответ в формате JSON, содержащий массив "tool_calls" с объектами, включающими:
   - "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
• Описание: Указывает URL Jupyter для выполнения кода.
• Персистентность: Эта переменная окружения является переменной 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 установлено по умолчанию.
• Описание: Указывает URL-адрес Jupyter для интерпретации кода.
• Постоянство: Эта переменная среды является переменной 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 Tool Servers)

ENABLE_DIRECT_CONNECTIONS

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает прямые подключения.
• Постоянство: Эта переменная среды является переменной PersistentConfig.

Автозаполнение

ENABLE_AUTOCOMPLETE_GENERATION

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает генерацию автозаполнения.
• Постоянство: Эта переменная среды является переменной PersistentConfig.

к сведению

При включении 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:

### Задача:
Вы являетесь системой автозаполнения. Продолжите текст в `<text>` на основе **типа завершения** в `<type>` и указанного языка.

### **Инструкции**:
1. Проанализируйте `<text>` для понимания контекста и смысла.
2. Используйте `<type>` для направления вашего вывода:
   - **Общее**: Предоставьте естественное, краткое продолжение.
   - **Поисковый запрос**: Завершите, как если бы создавали реалистичный поисковый запрос.
3. Начните так, как будто вы напрямую продолжаете `<text>`. Не **повторяйте**, не перефразируйте и не отвечайте как модель. Просто продолжите текст.
4. Убедитесь, что продолжение:
   - Естественно вытекает из `<text>`.
   - Избегает повторений, избыточных объяснений или несвязанных идей.
5. Если не уверены, верните: `{ "text": "" }`.

### **Правила вывода**:
- Ответ только в формате JSON: `{ "text": "<your_completion>" }`.

### **Примеры**:
#### Пример 1:
Ввод:
<type>Общее</type>
<text>Солнце садилось за горизонт, окрашивая небо</text>
Вывод:
{ "text": "яркими оттенками оранжевого и розового." }

#### Пример 2:
Ввод:
<type>Поисковый запрос</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 сообщений) или слишком разнообразное, используйте только ["Общее"]
- Используйте основной язык чата; по умолчанию — английский, если чат многоязычный
- Отдавайте предпочтение точности над специфичностью

### Результат:
Формат JSON: { "tags": ["тег1", "тег2", "тег3"] }

### История чата:
<история_чата>
{{MESSAGES:END:6}}
</история_чата>

• Описание: Устанавливает шаблон подсказки для генерации тегов.
• Устойчивость: Эта переменная среды является переменной 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.

примечание

Значение 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
• Описание: Передает информацию о пользователе (имя, идентификатор, email, роль) как заголовки X в API OpenAI и API Ollama. Если включено, следующие заголовки будут переданы:
  • X-OpenWebUI-User-Name
  • X-OpenWebUI-User-Id
  • X-OpenWebUI-User-Email
  • X-OpenWebUI-User-Role

ENABLE_WEB_LOADER_SSL_VERIFICATION

• Тип: bool
• По умолчанию: True
• Описание: Обходит проверку SSL для RAG на веб-сайтах.
• Устойчивость: Эта переменная среды является переменной PersistentConfig.

WEBUI_SESSION_COOKIE_SAME_SITE

• Тип: str
• Варианты:
  • lax - Устанавливает атрибут SameSite как lax, позволяя отправлять сессионные cookies с запросами, инициированными сторонними веб-сайтами.
  • strict - Устанавливает атрибут SameSite как strict, блокируя отправку сессионных cookies с запросами, инициированными сторонними веб-сайтами.
  • none - Устанавливает атрибут SameSite как none, позволяя отправлять сессионные cookies с запросами, инициированными сторонними веб-сайтами, но только через HTTPS.
• По умолчанию: lax
• Описание: Устанавливает атрибут SameSite для сессионных cookies.

warning

Когда ENABLE_OAUTH_SIGNUP включен, установка WEBUI_SESSION_COOKIE_SAME_SITE в значение strict может привести к ошибкам входа. Это связано с тем, что Open WebUI использует сессионный cookie для проверки обратного вызова от провайдера OAuth, что помогает предотвратить атаки CSRF.

Однако строгое значение атрибута cookie не отправляется с запросом обратного вызова, что может привести к проблемам входа. Если вы столкнулись с этой проблемой, используйте значение по умолчанию lax.

WEBUI_SESSION_COOKIE_SECURE

• Тип: bool
• По умолчанию: False
• Описание: Устанавливает атрибут Secure для сессионных cookies, если установлено значение True.

WEBUI_AUTH_COOKIE_SAME_SITE

• Тип: str
• Варианты:
  • lax - Устанавливает атрибут SameSite как lax, позволяя отправлять auth cookies с запросами, инициированными сторонними веб-сайтами.
  • strict - Устанавливает атрибут SameSite как strict, блокируя отправку auth cookies с запросами, инициированными сторонними веб-сайтами.
  • none - Устанавливает атрибут SameSite как none, позволяя отправлять auth cookies с запросами, инициированными сторонними веб-сайтами, но только через HTTPS.
• По умолчанию: lax
• Описание: Устанавливает атрибут SameSite для auth cookies.

к сведению

Если значение не установлено, будет использоваться значение WEBUI_SESSION_COOKIE_SAME_SITE как резервное.

WEBUI_AUTH_COOKIE_SECURE

• Тип: bool
• По умолчанию: False
• Описание: Устанавливает атрибут Secure для cookie аутентификации, если установлен в True.

:::информация

Если значение не установлено, будет использоваться резервный параметр WEBUI_SESSION_COOKIE_SECURE.

:::

WEBUI_AUTH

• Тип: bool
• По умолчанию: True
• Описание: Эта настройка включает или отключает аутентификацию.

:::внимание

Если установлено в False, аутентификация будет отключена для вашей Open WebUI версии. Однако, важно заметить, что отключение аутентификации возможно только для новых установок без существующих пользователей. Если пользователи уже зарегистрированы, отключить аутентификацию напрямую будет невозможно. Убедитесь, что в базе данных нет пользователей, если вы намереваетесь отключить WEBUI_AUTH.

:::

WEBUI_SECRET_KEY

• Тип: str
• По умолчанию: t0p-s3cr3t
• По умолчанию (Docker): Случайно сгенерировано при первом запуске
• Описание: Заменяет случайно сгенерированную строку, используемую для JSON Web Token.

:::информация

При развертывании Open-WebUI в многозадачном кластере с балансировщиком нагрузки необходимо убедиться, что значение WEBUI_SECRET_KEY одинаково для всех экземпляров, чтобы пользователи могли продолжать работу, если один из узлов перезапущен или их сессия перемещена на другой узел. Без этого им придется входить в систему заново каждый раз, когда изменяется базовый узел.

:::

OFFLINE_MODE

• Тип: bool
• По умолчанию: False
• Описание: Включает или отключает оффлайн-режим.

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 embeddings.

CHROMA_DATABASE

• Тип: str
• По умолчанию: Значение chromadb.DEFAULT_DATABASE (константа в модуле chromadb)
• Описание: Устанавливает базу данных в арендатора ChromaDB для использования в RAG embeddings.

CHROMA_HTTP_HOST

• Тип: str
• Описание: Указывает имя хоста удаленного сервера ChromaDB. Если не установлено, используется локальный экземпляр ChromaDB.

CHROMA_HTTP_PORT

• Тип: int
• По умолчанию: 8000
• Описание: Указывает порт удаленного сервера ChromaDB.

CHROMA_HTTP_HEADERS

• Тип: str
• Описание: Список HTTP-заголовков, разделенных запятыми, для включения в каждый запрос к ChromaDB.
• Пример: Authorization=Bearer heuhagfuahefj,User-Agent=OpenWebUI.

CHROMA_HTTP_SSL

• Тип: bool
• По умолчанию: False
• Описание: Определяет, использовать ли SSL для соединений с сервером ChromaDB.

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 установлено по умолчанию.
• Описание: Указывает API-ключ Elasticsearch.
• Персистентность: Эта переменная окружения является переменной PersistentConfig.

ELASTICSEARCH_CA_CERTS

• Тип: str
• По умолчанию: Пустая строка (' '), так как значение None установлено по умолчанию.
• Описание: Указывает путь к сертификатам CA для Elasticsearch.
• Персистентность: Эта переменная окружения является переменной PersistentConfig.

ELASTICSEARCH_CLOUD_ID

• Тип: str
• По умолчанию: Пустая строка (' '), так как значение None установлено по умолчанию.
• Описание: Указывает Cloud ID для Elasticsearch.
• Персистентность: Эта переменная окружения является переменной PersistentConfig.

ELASTICSEARCH_INDEX_PREFIX

• Тип: str
• По умолчанию: open_webui_collections
• Описание: Указывает префикс для индекса Elasticsearch.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

ELASTICSEARCH_PASSWORD

• Тип: str
• По умолчанию: пустая строка ( ), так как по умолчанию задано значение None.
• Описание: Указывает пароль для Elasticsearch.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

ELASTICSEARCH_URL

• Тип: str
• По умолчанию: https://localhost:9200
• Описание: Указывает URL-адрес для экземпляра Elasticsearch.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

ELASTICSEARCH_USERNAME

• Тип: str
• По умолчанию: пустая строка ( ), так как по умолчанию задано значение None.
• Описание: Указывает имя пользователя для Elasticsearch.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

Milvus

MILVUS_URI

• Тип: str
• По умолчанию: ${DATA_DIR}/vector_db/milvus.db
• Описание: Указывает URI для подключения к базе данных Milvus. Это может быть локальный или удаленный сервер 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
• Описание: Указывает параметр M для типа индекса HNSW в Milvus. Это влияет на количество двунаправленных связей, создаваемых для каждого нового элемента при построении. Действительно только если MILVUS_INDEX_TYPE равно HNSW.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

MILVUS_HNSW_EFCONSTRUCTION

• Тип: int
• По умолчанию: 100
• Описание: Указывает параметр efConstruction для типа индекса HNSW в Milvus. Это влияет на размер динамического списка ближайших соседей при построении индекса. Действительно только если MILVUS_INDEX_TYPE равно HNSW.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

MILVUS_IVF_FLAT_NLIST

• Тип: int
• По умолчанию: 128
• Описание: Указывает параметр nlist для типа индекса IVF_FLAT в Milvus. Это количество кластерных единиц. Действительно только если MILVUS_INDEX_TYPE равно IVF_FLAT.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

OpenSearch

OPENSEARCH_CERT_VERIFY

• Тип: bool
• По умолчанию: False
• Описание: Включает или отключает проверку сертификата OpenSearch.

OPENSEARCH_PASSWORD

• Тип: str
• По умолчанию: None
• Описание: Устанавливает пароль для OpenSearch.

OPENSEARCH_SSL

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает SSL для OpenSearch.

OPENSEARCH_URI

• Тип: str
• По умолчанию: https://localhost:9200
• Описание: Устанавливает URI для OpenSearch.

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
• Описание: Устанавливает ключ API для Qdrant.

QDRANT_URI

• Тип: str
• Описание: Устанавливает URI для Qdrant.

QDRANT_ON_DISK

• Тип: bool
• По умолчанию: False
• Описание: Включает использование memmap (известного также как on-disk) хранилища.

QDRANT_PREFER_GRPC

• Тип: bool
• По умолчанию: False
• Описание: Использовать интерфейс gRPC, когда это возможно.

QDRANT_GRPC_PORT

• Тип: int
• По умолчанию: 6334
• Описание: Устанавливает номер порта gRPC для Qdrant.

ENABLE_QDRANT_MULTITENANCY_MODE

• Тип: bool
• По умолчанию: False
• Описание: Включает многопользовательский режим управления коллекциями Qdrant, что значительно снижает использование оперативной памяти и вычислительные накладные расходы за счет консолидации похожих структур векторных данных. Рекомендуется включить.

к сведению

Это отключит все коллекции Qdrant, созданные в предыдущем режиме, который является немногопользовательским. Перейдите в Admin Settings > Documents > Reindex Knowledge Base, чтобы перенести существующие знания.

Коллекции Qdrant, созданные с использованием предыдущего шаблона, все еще будут расходовать ресурсы.

В настоящее время нет кнопки в интерфейсе для сброса только векторной базы данных. Если вы хотите перенести знания в режим мультиаренды:

• Удалите все коллекции с префиксом open_webui-knowledge (или с префиксом open_webui, чтобы удалить все коллекции, связанные с Open WebUI), используя нативный клиент Qdrant
• Перейдите в Настройки администратора > Документы > Переиндексация базы знаний, чтобы перенести существующую базу знаний

Переиндексация базы знаний перенесет ТОЛЬКО базу знаний

:::опасно

Если вы решили использовать режим мультиаренды по умолчанию и не нуждаетесь в переносе старых знаний, перейдите в Настройки администратора > Документы для сброса векторов и базы знаний, что удалит все коллекции с префиксом open_webui и все сохраненные знания.

:::

Pinecone

При использовании Pinecone в качестве хранилища векторов используются следующие переменные окружения для управления его поведением. Убедитесь, что эти переменные заданы в вашем .env файле или среде развертывания.

PINECONE_API_KEY

• Тип: str
• Значение по умолчанию: None
• Описание: Устанавливает ключ API, используемый для аутентификации с сервисом Pinecone.

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 - Использовать движок Document Intelligence
  • mistral_ocr - Использовать движок Mistral OCR
• Описание: Устанавливает движок извлечения контента для обработки документов.
• Сохранность: Эта переменная окружения является переменной PersistentConfig.

MISTRAL_OCR_API_KEY

• Тип: str
• Значение по умолчанию: None
• Описание: Указывает используемый ключ API для Mistral OCR.
• Сохранность: Эта переменная окружения является переменной 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
• Описание: Задает URL для сервера Apache Tika.
• Сохранность: Эта переменная окружения является переменной PersistentConfig.

DOCLING_SERVER_URL

• Тип: str
• Значение по умолчанию: http://docling:5001
• Описание: Указывает URL для сервера Docling.
• Сохранность: Эта переменная окружения является переменной PersistentConfig.

DOCLING_OCR_ENGINE

• Тип: str
• Значение по умолчанию: tesseract
• Описание: Указывает OCR-движок, используемый Docling.
  Поддерживаемые значения включают: tesseract (по умолчанию), easyocr, ocrmac, rapidocr и tesserocr.
• Сохранность: Эта переменная окружения является переменной PersistentConfig.

DOCLING_OCR_LANG

• Тип: str
• Значение по умолчанию: eng,fra,deu,spa (при использовании OCR-движка tesseract по умолчанию)
• Описание: Указывает язык(-и) OCR, используемый(-е) с настроенным DOCLING_OCR_ENGINE.
  Формат и доступные коды языков зависят от выбранного OCR-движка.
• Сохранность: Эта переменная окружения является переменной PersistentConfig.

Генерация с дополнением поиска (RAG)

RAG_EMBEDDING_ENGINE

• Тип: str
• Варианты:
  • Оставьте пустым для Default (SentenceTransformers) - используется SentenceTransformers для создания векторов.
  • ollama - используется Ollama API для создания векторов.
  • openai - используется OpenAI API для создания векторов.
• Описание: Выбирает движок для создания векторов для RAG.
• Сохранность: Эта переменная окружения является переменной PersistentConfig.

RAG_EMBEDDING_MODEL

• Тип: str
• Значение по умолчанию: sentence-transformers/all-MiniLM-L6-v2
• Описание: Устанавливает модель для создания векторов. Локально используется модель Sentence-Transformer.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

ENABLE_RAG_HYBRID_SEARCH

• Тип: bool
• По умолчанию: False
• Описание: Включает использование ансамблевого поиска с BM25 + ChromaDB с повторным ранжированием с использованием моделей sentence_transformers.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RAG_TOP_K

• Тип: int
• По умолчанию: 3
• Описание: Устанавливает количество результатов, которые необходимо учитывать для встроения при использовании RAG.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RAG_TOP_K_RERANKER

• Тип: int

• По умолчанию: 3

• Описание: Устанавливает количество результатов, которые необходимо учитывать для повторного ранжирования при использовании RAG.

• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

• Тип: float

• По умолчанию: 0.0

• Описание: Устанавливает порог релевантности для документов, которые учитываются при повторном ранжировании.

• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RAG_HYBRID_BM25_WEIGHT

• Тип: float
• По умолчанию: 0.5
• Описание: Устанавливает вес, присваиваемый поиску по ключевым словам (BM25) во время гибридного поиска. 1 означает только поиск по ключевым словам, 0 означает только поиск по векторам.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RAG_TEMPLATE

• Тип: str
• По умолчанию: Значение переменной окружения DEFAULT_RAG_TEMPLATE.

DEFAULT_RAG_TEMPLATE:

### Задача:
Ответьте на запрос пользователя, используя предоставленный контекст, включая встроенные цитаты в формате [id] **только если тег <source> содержит явный атрибут id** (например, <source id="1">).

### Руководство:
- Если вы не знаете ответ, чётко заявите об этом.
- Если не уверены, попросите пользователя уточнить.
- Отвечайте на том же языке, что и запрос пользователя.
- Если контекст нечитаемый или низкого качества, сообщите об этом пользователю и предоставьте наилучший возможный ответ.
- Если ответа нет в контексте, но вы обладаете необходимыми знаниями, объясните это пользователю и предоставьте ответ на основе вашего собственного понимания.
- **Добавляйте встроенные цитаты только в формате [id] (например, [1], [2]), если тег <source> содержит атрибут id.**
- Не цитируйте, если тег <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
• Описание: Извлекает изображения из PDF-файлов с помощью OCR при загрузке документов.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RAG_FILE_MAX_SIZE

• Тип: int
• Описание: Устанавливает максимальный размер файла в мегабайтах, который можно загрузить для обработки документов.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

RAG_FILE_MAX_COUNT

• Тип: int
• Описание: Устанавливает максимальное количество файлов, которые можно загрузить одновременно для обработки документов.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

к сведению

При настройке RAG_FILE_MAX_SIZE и RAG_FILE_MAX_COUNT убедитесь, что значения разумны, чтобы предотвратить чрезмерную загрузку файлов и возможные проблемы с производительностью.

RAG_ALLOWED_FILE_EXTENSIONS

• Описание: Указывает, какие расширения файлов разрешены для загрузки.

["pdf,docx,txt"]

• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_RERANKING_MODEL

• Тип: str
• Описание: Устанавливает модель для перестановки результатов. Локально используется модель Sentence-Transformer.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_OPENAI_API_BASE_URL

• Тип: str
• По умолчанию: ${OPENAI_API_BASE_URL}
• Описание: Устанавливает базовый URL API OpenAI для использования в RAG embeddings.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_OPENAI_API_KEY

• Тип: str
• По умолчанию: ${OPENAI_API_KEY}
• Описание: Устанавливает ключ API OpenAI для использования в RAG embeddings.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_EMBEDDING_OPENAI_BATCH_SIZE

• Тип: int
• По умолчанию: 1
• Описание: Устанавливает размер пакета для embeddings OpenAI.

RAG_EMBEDDING_BATCH_SIZE

• Тип: int
• По умолчанию: 1
• Описание: Устанавливает размер пакета для embeddings в моделях RAG (Retrieval-Augmented Generator).
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_OLLAMA_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Ollama API, используемого в моделях RAG.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_OLLAMA_BASE_URL

• Тип: str
• Описание: Устанавливает базовый URL для Ollama API, используемого в моделях RAG.
• Устойчивость: Эта переменная окружения является переменной 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": ["запрос1", "запрос2"] }, убеждаясь, что каждый запрос уникален, лаконичен и релевантен теме.
- Если и только если вы абсолютно уверены, что поисковый запрос не даст полезных результатов, верните: { "queries": [] }.
- При малейших сомнениях отдавайте предпочтение генерации поисковых запросов, чтобы получить полезную или обновленную информацию.
- Будьте лаконичны и сосредоточьтесь на составлении качественных поисковых запросов, избегая излишних объяснений, комментариев или предположений.
- Сегодняшняя дата: {{CURRENT_DATE}}.
- Всегда отдавайте приоритет создающим ценность и широким запросам для максимального информационного охвата.

### Вывод:
Строго возвращайте в формате JSON:
{
  "queries": ["запрос1", "запрос2"]
}

### История чата:
<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
• Описание: Указывает префикс для содержания embeddings RAG.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_EMBEDDING_PREFIX_FIELD_NAME

• Тип: str
• По умолчанию: None
• Описание: Указывает имя поля для префикса embeddings в RAG.
• Устойчивость: Эта переменная окружения является переменной PersistentConfig.

RAG_EMBEDDING_QUERY_PREFIX

• Тип: str
• По умолчанию: None
• Описание: Указывает префикс для запросов embeddings в 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 будет отображаться в качестве варианта загрузки в интерфейсе чата.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

к сведению

При включении GOOGLE_DRIVE_INTEGRATION убедитесь, что вы правильно настроили GOOGLE_DRIVE_CLIENT_ID и GOOGLE_DRIVE_API_KEY, а также ознакомьтесь с условиями предоставления услуг и рекомендациями по использованию Google.

GOOGLE_DRIVE_CLIENT_ID

• Тип: str
• Описание: Устанавливает идентификатор клиента для Google Drive (клиент должен быть настроен с включенными API Drive и Picker).
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

GOOGLE_DRIVE_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для интеграции Google Drive.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

OneDrive

ENABLE_ONEDRIVE_INTEGRATION

• Тип: bool
• По умолчанию: False
• Описание: Включает или отключает интеграцию с OneDrive.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

ONEDRIVE_CLIENT_ID

• Тип: str
• По умолчанию: None
• Описание: Указывает идентификатор клиента для интеграции с OneDrive.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

Веб-поиск

ENABLE_WEB_SEARCH

• Тип: 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
• Варианты:
  • searxng - Использует поисковую систему SearXNG.
  • google_pse - Использует Google Programmable Search Engine.
  • brave - Использует поисковую систему Brave.
  • kagi - Использует поисковую систему Kagi.
  • mojeek - Использует поисковую систему Mojeek.
  • bocha - Использует поисковую систему Bocha.
  • serpstack - Использует поисковую систему Serpstack.
  • serper - Использует поисковую систему Serper.
  • serply - Использует поисковую систему Serply.
  • searchapi - Использует поисковую систему SearchAPI.
  • serpapi - Использует поисковую систему SerpApi.
  • duckduckgo - Использует поисковую систему DuckDuckGo.
  • tavily - Использует поисковую систему Tavily.
  • jina - Использует поисковую систему Jina.
  • bing - Использует поисковую систему Bing.
  • exa - Использует поисковую систему Exa.
  • perplexity - Использует поисковую систему Perplexity AI.
  • sougou - Использует поисковую систему Sougou.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL

• Тип: bool
• По умолчанию: False
• Описание: Обходит процесс внедрения и извлечения веб-поиска.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

SEARXNG_QUERY_URL

• Тип: str
• Описание: URL SearXNG API поиска, поддерживающего выход JSON. <query> заменяется на поисковый запрос. Пример: http://searxng.local/search?q=<query>
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

GOOGLE_PSE_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для сервиса Google Programmable Search Engine (PSE).
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

GOOGLE_PSE_ENGINE_ID

• Тип: str
• Описание: Идентификатор поисковой системы для услуги Google Programmable Search Engine (PSE).
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

BRAVE_SEARCH_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Brave Search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

KAGI_SEARCH_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Kagi Search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

MOJEEK_SEARCH_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Mojeek Search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SERPSTACK_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для поискового API Serpstack.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SERPSTACK_HTTPS

• Тип: bool
• По умолчанию: True
• Описание: Настраивает использование HTTPS для запросов Serpstack. Запросы на уровне бесплатного тарифа ограничены только HTTP.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SERPER_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Serper search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SERPLY_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Serply search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SEARCHAPI_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для SearchAPI.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SEARCHAPI_ENGINE

• Тип: str
• Описание: Устанавливает поисковый движок для SearchAPI.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

TAVILY_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Tavily search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

JINA_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для Jina.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

BING_SEARCH_V7_ENDPOINT

• Тип: str
• Описание: Устанавливает конечную точку для Bing Search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

BING_SEARCH_V7_SUBSCRIPTION_KEY

• Тип: str
• По умолчанию: https://api.bing.microsoft.com/v7.0/search
• Описание: Устанавливает ключ подписки для Bing Search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

BOCHA_SEARCH_API_KEY

• Тип: str
• По умолчанию: None
• Описание: Устанавливает ключ API для Bocha Search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

EXA_API_KEY

• Тип: str
• По умолчанию: None
• Описание: Устанавливает ключ API для Exa search API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SERPAPI_API_KEY

• Тип: str
• По умолчанию: None
• Описание: Устанавливает ключ API для SerpAPI.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SERPAPI_ENGINE

• Тип: str
• По умолчанию: None
• Описание: Определяет поисковую систему для использования в SerpAPI.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SOUGOU_API_SID

• Тип: str
• По умолчанию: None
• Описание: Устанавливает SID для Sogou API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

SOUGOU_API_SK

• Тип: str
• По умолчанию: None
• Описание: Устанавливает SK для Sogou API.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

TAVILY_EXTRACT_DEPTH

• Тип: str
• По умолчанию: basic
• Описание: Определяет глубину извлечения для результатов Tavily.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

Конфигурация загрузчика веб-контента

WEB_LOADER_ENGINE

• Тип: str
• По умолчанию: safe_web
• Описание: Определяет загрузчик для получения и обработки веб-контента.
• Варианты:
  • requests - Использует модуль Requests с улучшенной обработкой ошибок.
  • playwright - Использует Playwright для более продвинутого рендеринга и взаимодействия с веб-страницами.
• Постоянство: Эта переменная окружения является переменной типа PersistentConfig.

к сведению

При использовании playwright у вас есть два варианта:

1. Если PLAYWRIGHT_WS_URI не установлен, Playwright со всеми зависимостями Chromium будет автоматически установлен в контейнере Open WebUI при запуске.
2. Если PLAYWRIGHT_WS_URI установлен, Open WebUI подключится к удалённому экземпляру браузера вместо установки зависимостей локально.

PLAYWRIGHT_WS_URL

• Тип: str
• По умолчанию: None
• Описание: Указывает URI WebSocket удалённого экземпляра браузера Playwright. Если установлено, Open WebUI будет использовать этот удалённый браузер вместо установки зависимостей браузера локально. Это особенно полезно в контейнеризированных средах, где необходимо сделать контейнер Open WebUI лёгким и разделить использование браузеров. Пример: ws://playwright:3000
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

:::подсказка

Использование удалённого браузера Playwright через PLAYWRIGHT_WS_URL может быть полезным для:

• Уменьшения размера контейнера Open WebUI
• Использования другого браузера, кроме Chromium
• Подключения к браузеру с интерфейсом (небезголовый режим)

:::

FIRECRAWL_API_BASE_URL

• Тип: str
• Значение по умолчанию: https://api.firecrawl.dev
• Описание: Устанавливает базовый URL для API Firecrawl.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

FIRECRAWL_API_KEY

• Тип: str
• Значение по умолчанию: None
• Описание: Устанавливает ключ API для API Firecrawl.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

PERPLEXITY_API_KEY

• Тип: str
• Значение по умолчанию: None
• Описание: Устанавливает ключ API для API Perplexity.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

PLAYWRIGHT_TIMEOUT

• Тип: int
• Значение по умолчанию: Пустая строка ( ), так как значение None установлено по умолчанию.
• Описание: Указывает тайм-аут для запросов Playwright.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

Загрузчик YouTube

YOUTUBE_LOADER_PROXY_URL

• Тип: str
• Описание: Устанавливает URL прокси-сервера для загрузчика YouTube.
• Сохранение: Эта переменная окружения является переменной 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
• Описание: Указывает, нужно ли применять фильтр активности голоса (VAD) для системы преобразования речи Whisper.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

WHISPER_MODEL_AUTO_UPDATE

• Тип: bool
• Значение по умолчанию: False
• Описание: Включает автоматическое обновление модели Whisper.

WHISPER_LANGUAGE

• Тип: str
• Значение по умолчанию: None
• Описание: Указывает язык ISO 639-1, который Whisper использует для преобразования речи в текст (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}
• Описание: Устанавливает ключ API OpenAI для преобразования речи в текст.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

Распознавание речи (Azure)

AUDIO_STT_AZURE_API_KEY

• Тип: str
• Значение по умолчанию: None
• Описание: Указывает ключ API Azure для преобразования речи в текст.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

AUDIO_STT_AZURE_REGION

• Тип: str
• Значение по умолчанию: None
• Описание: Указывает регион Azure для преобразования речи в текст.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

AUDIO_STT_AZURE_LOCALES

• Тип: str
• Значение по умолчанию: None
• Описание: Указывает языковые локализации для преобразования речи в текст с использованием Azure.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

Распознавание речи (Deepgram)

DEEPGRAM_API_KEY

• Тип: str
• Значение по умолчанию: None
• Описание: Указывает ключ API Deepgram для преобразования речи в текст.
• Настойчивость: Эта переменная окружения является переменной 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 Text-to-Speech

AUDIO_TTS_AZURE_SPEECH_REGION

• Тип: str
• Описание: Устанавливает регион для Azure Text-to-Speech.
• Настойчивость: Эта переменная окружения является переменной PersistentConfig.

AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT

• Тип: str
• Описание: Устанавливает формат вывода для Azure Text-to-Speech.
• Настойчивость: Эта переменная окружения является переменной PersistentConfig.

OpenAI Text-to-Speech

AUDIO_TTS_OPENAI_API_BASE_URL

• Тип: str
• По умолчанию: ${OPENAI_API_BASE_URL}
• Описание: Устанавливает базовый URL, совместимый с OpenAI для конвертации текста в речь.
• Настойчивость: Эта переменная окружения является переменной 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 - Использует Gemини для генерации изображений.
• По умолчанию: 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
• Описание: Указывает URL для API Stable Diffusion от AUTOMATIC1111.
• Настойчивость: Эта переменная окружения является переменной PersistentConfig.

AUTOMATIC1111_API_AUTH

• Тип: str
• Описание: Устанавливает аутентификацию API AUTOMATIC1111.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

AUTOMATIC1111_CFG_SCALE

• Тип: float
• Описание: Устанавливает масштаб для выполнения AUTOMATIC1111.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

AUTOMATIC1111_SAMPLER

• Тип: str
• Описание: Устанавливает сэмплер для выполнения AUTOMATIC1111.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

AUTOMATIC1111_SCHEDULER

• Тип: str
• Описание: Устанавливает планировщик для выполнения AUTOMATIC1111.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

ComfyUI

COMFYUI_BASE_URL

• Тип: str
• Описание: Указывает URL API генерации изображений ComfyUI.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

COMFYUI_API_KEY

• Тип: str
• Описание: Устанавливает ключ API для ComfyUI.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

COMFYUI_WORKFLOW

• Тип: str
• По умолчанию:

{
  "3": {
    "входные данные": {
      "seed": 0,
      "steps": 20,
      "cfg": 8,
      "sampler_name": "euler",
      "scheduler": "normal",
      "denoise": 1,
      "model": [
        "4",
        0
      ],
      "positive": [
        "6",
        0
      ],
      "negative": [
        "7",
        0
      ],
      "latent_image": [
        "5",
        0
      ]
    },
    "class_type": "KSampler",
    "_meta": {
      "title": "KSampler"
    }
  },
  "4": {
    "входные данные": {
      "ckpt_name": "model.safetensors"
    },
    "class_type": "CheckpointLoaderSimple",
    "_meta": {
      "title": "Load Checkpoint"
    }
  },
  "5": {
    "входные данные": {
      "width": 512,
      "height": 512,
      "batch_size": 1
    },
    "class_type": "EmptyLatentImage",
    "_meta": {
      "title": "Empty Latent Image"
    }
  },
  "6": {
    "входные данные": {
      "text": "Prompt",
      "clip": [
        "4",
        1
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP Text Encode (Prompt)"
    }
  },
  "7": {
    "входные данные": {
      "text": "",
      "clip": [
        "4",
        1
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP Text Encode (Prompt)"
    }
  },
  "8": {
    "входные данные": {
      "samples": [
        "3",
        0
      ],
      "vae": [
        "4",
        2
      ]
    },
    "class_type": "VAEDecode",
    "_meta": {
      "title": "VAE Decode"
    }
  },
  "9": {
    "входные данные": {
      "filename_prefix": "ComfyUI",
      "images": [
        "8",
        0
      ]
    },
    "class_type": "SaveImage",
    "_meta": {
      "title": "Save Image"
    }
  }
}

• Описание: Устанавливает рабочий процесс ComfyUI.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

Gemini

GEMINI_API_BASE_URL

• Тип: str
• По умолчанию: None
• Описание: Указывает URL API Gemini.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

GEMINI_API_KEY

• Тип: str
• По умолчанию: None
• Описание: Устанавливает ключ API Gemini.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

IMAGES_GEMINI_API_BASE_URL

• Тип: str
• По умолчанию: None
• Описание: Указывает URL API генерации изображений Gemini.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

IMAGES_GEMINI_API_KEY

• Тип: str
• По умолчанию: None
• Описание: Устанавливает ключ API Gemini для генерации изображений.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

OpenAI DALL-E

IMAGES_OPENAI_API_BASE_URL

• Тип: str
• По умолчанию: ${OPENAI_API_BASE_URL}
• Описание: Устанавливает совместимый с OpenAI базовый URL для генерации изображений с использованием DALL-E.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

IMAGES_OPENAI_API_KEY

• Тип: str
• По умолчанию: ${OPENAI_API_KEY}
• Описание: Устанавливает ключ API для генерации изображений с использованием DALL-E.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

OAuth

ENABLE_OAUTH_SIGNUP

• Тип: bool
• По умолчанию: False
• Описание: Включает создание учетной записи при регистрации через OAuth. Отличается от ENABLE_SIGNUP.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

:::опасность

ENABLE_LOGIN_FORM должно быть установлено на False, если ENABLE_OAUTH_SIGNUP установлено на True. Несоблюдение этого требования приведет к невозможности входа в систему.

:::

OAUTH_MERGE_ACCOUNTS_BY_EMAIL

• Тип: bool
• По умолчанию: False
• Описание: Если включено, объединяет аккаунты OAuth с существующими аккаунтами с одинаковым email. Это считается небезопасным, так как не все поставщики OAuth проверяют email, что может привести к захвату аккаунтов.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

OAUTH_UPDATE_PICTURE_ON_LOGIN

• Тип: bool
• По умолчанию: False
• Описание: Если включено, обновляет локальное изображение профиля пользователя изображением, предоставленным OAuth, при входе.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

WEBUI_AUTH_TRUSTED_EMAIL_HEADER

• Тип: str
• Описание: Определяет доверенный заголовок запроса для аутентификации. См. документацию по SSO.

WEBUI_AUTH_TRUSTED_NAME_HEADER

• Тип: str
• Описание: Определяет доверенный заголовок запроса для имени пользователя любого, кто регистрируется с заголовком WEBUI_AUTH_TRUSTED_EMAIL_HEADER. См. документацию по SSO.

Google

См. https://support.google.com/cloud/answer/6158849?hl=en

GOOGLE_CLIENT_ID

• Тип: str
• Описание: Устанавливает идентификатор клиента для Google OAuth.
• Сохранение: Эта переменная окружения является переменной 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
• Описание: Устанавливает URI перенаправления для Google OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

Microsoft

См. https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

MICROSOFT_CLIENT_ID

• Тип: str
• Описание: Устанавливает идентификатор клиента для Microsoft OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

MICROSOFT_CLIENT_SECRET

• Тип: str
• Описание: Устанавливает секретный ключ клиента для Microsoft OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

MICROSOFT_CLIENT_TENANT_ID

• Тип: str
• Описание: Устанавливает идентификатор арендатора для Microsoft OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

MICROSOFT_OAUTH_SCOPE

• Тип: str
• По умолчанию: openid email profile
• Описание: Устанавливает область для аутентификации Microsoft OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

MICROSOFT_REDIRECT_URI

• Тип: str
• По умолчанию: <backend>/oauth/microsoft/callback
• Описание: Устанавливает URI перенаправления для Microsoft OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

GitHub

См. https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps

GITHUB_CLIENT_ID

• Тип: str
• Описание: Устанавливает идентификатор клиента для GitHub OAuth.
• Сохранение: Эта переменная окружения является переменной 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
• Описание: Устанавливает URI перенаправления для GitHub OAuth.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

OpenID (OIDC)

OAUTH_CLIENT_ID

• Тип: str
• Описание: Устанавливает идентификатор клиента для OIDC.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

OAUTH_CLIENT_SECRET

• Тип: str
• Описание: Устанавливает секретный ключ клиента для OIDC.
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

OPENID_PROVIDER_URL

• Тип: str
• Описание: Путь к конечной точке .well-known/openid-configuration
• Сохранение: Эта переменная окружения является переменной PersistentConfig.

OPENID_REDIRECT_URI

• Тип: str
• По умолчанию: <backend>/oauth/oidc/callback
• Описание: Устанавливает URI перенаправления для OIDC
• Сохранение: Эта переменная окружения является переменной 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.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

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
• Описание: Задает фильтр для поиска LDAP.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

LDAP_USE_TLS

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает TLS для подключения к LDAP.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

LDAP_CA_CERT_FILE

• Тип: str
• Описание: Устанавливает путь к файлу сертификата LDAP CA.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

LDAP_VALIDATE_CERT

• Тип: bool
• Описание: Указывает, следует ли проверять сертификат LDAP CA.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

LDAP_CIPHERS

• Тип: str
• По умолчанию: ALL
• Описание: Устанавливает шифры для подключения к LDAP.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

Права пользователей

Права чата

USER_PERMISSIONS_CHAT_CONTROLS

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователей на доступ к элементам управления чатом.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_FILE_UPLOAD

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на загрузку файлов в чаты.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_DELETE

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на удаление чатов.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_EDIT

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на редактирование чатов.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_STT

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на использование функции преобразования речи в текст в чатах.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_TTS

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на использование функции преобразования текста в речь в чатах.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_CALL

• Тип: str
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на совершение звонков в чатах.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_MULTIPLE_MODELS

• Тип: str
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на использование нескольких моделей в чатах.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_TEMPORARY

• Тип: bool
• По умолчанию: True
• Описание: Включает или отключает разрешение пользователя на создание временных чатов.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_CHAT_TEMPORARY_ENFORCED

• Тип: str
• По умолчанию: False
• Описание: Включает или отключает обязательное использование временных чатов для пользователей.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

Разрешения функций

USER_PERMISSIONS_FEATURES_DIRECT_TOOL_SERVERS

• Тип: str
• По умолчанию: False
• Описание: Включает или отключает разрешение пользователя на доступ к прямым серверным инструментам.
• Постоянство: Эта переменная окружения является переменной PersistentConfig.

USER_PERMISSIONS_FEATURES_WEB_SEARCH

• Тип: str
• По умолчанию: 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
• Опции:
  • s3 - использует библиотеку клиента S3 и соответствующие переменные окружения, упомянутые в Amazon S3 Storage
  • gcs - использует библиотеку клиента GCS и соответствующие переменные окружения, упомянутые в Google Cloud Storage
  • azure - использует библиотеку клиента Azure и соответствующие переменные окружения, упомянутые в Microsoft Azure Storage
• По умолчанию: пустая строка ( ), что означает использование local
• Описание: Устанавливает провайдера хранилища.

Amazon S3 Storage

S3_ACCESS_KEY_ID

• Тип: str
• Описание: Устанавливает идентификатор ключа доступа для хранилища S3.

S3_ADDRESSING_STYLE

• Тип: str
• По умолчанию: None
• Описание: Определяет стиль адресации для хранилища S3 (например, path, virtual).

S3_BUCKET_NAME

• Тип: str
• Описание: Устанавливает имя корзины для хранилища S3.

S3_ENDPOINT_URL

• Тип: str
• Описание: Устанавливает URL конечной точки для хранилища S3.

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 после загрузки для лучшей организации, поиска и интеграции с политиками управления файлами. Всегда устанавливайте False, если используется Cloudflare R2, так как R2 не поддерживает тегирование объектов.

Google Cloud Storage

GOOGLE_APPLICATION_CREDENTIALS_JSON

• Тип: str
• Описание: Содержит данные файла JSON учетных данных Google Application.
  • Необязательно - если не указано, учетные данные будут взяты из окружения. Учётные данные пользователя при локальной работе и сервер метаданных Google при использовании Google Compute Engine.
  • Файл можно создать для учетной записи службы, следуя этому руководству.

GCS_BUCKET_NAME

• Тип: str
• Описание: Устанавливает имя корзины для Google Cloud Storage. Корзина должна уже существовать.

Microsoft Azure Storage

AZURE_STORAGE_ENDPOINT

• Тип: str
• Описание: Устанавливает URL конечной точки для Azure Storage.

AZURE_STORAGE_CONTAINER_NAME

• Тип: str
• Описание: Устанавливает имя контейнера для Azure Storage.

AZURE_STORAGE_KEY

• Тип: str
• Описание: Устанавливает ключ доступа для Azure Storage.
  • Необязательно - если не указано, учетные данные будут взяты из окружения. Учётные данные пользователя при локальной работе и Управляемая идентичность при работе в сервисах Azure.

Пул базы данных

DATABASE_URL

• Тип: str
• По умолчанию: sqlite:///${DATA_DIR}/webui.db
• Описание: Указывает URL базы данных для подключения.

к сведению

Поддерживает SQLite и Postgres. Изменение URL-адреса не мигрирует данные между базами данных. Документация по схеме URL доступна здесь.

DATABASE_SCHEMA

• Тип: str
• По умолчанию: None
• Описание: Указывает схему базы данных для подключения.

DATABASE_POOL_SIZE

• Тип: int
• По умолчанию: 0
• Описание: Указывает размер пула базы данных. Значение 0 отключает пул.

DATABASE_POOL_MAX_OVERFLOW

• Тип: int
• По умолчанию: 0
• Описание: Указывает максимальное переполнение пула базы данных.

к сведению

Подробная информация об этом параметре доступна здесь.

DATABASE_POOL_TIMEOUT

• Тип: int
• По умолчанию: 30
• Описание: Указывает тайм-аут пула базы данных в секундах для получения соединения.

к сведению

Подробная информация об этом параметре доступна здесь.

DATABASE_POOL_RECYCLE

• Тип: int
• По умолчанию: 3600
• Описание: Указывает время рециркуляции пула базы данных в секундах.

к сведению

Подробная информация об этом параметре доступна здесь.

Redis

REDIS_URL

• Тип: str
• Пример: redis://localhost:6379/0
• Описание: Указывает URL экземпляра Redis для состояния приложения.

к сведению

При развертывании Open-WebUI в кластере с несколькими узлами/рабочими процессами необходимо убедиться, что REDIS_URL задан. Без этого возникнут проблемы с сессиями, устойчивостью и согласованностью состояния приложения, так как рабочие процессы не смогут взаимодействовать.

REDIS_SENTINEL_HOSTS

• Тип: str
• Описание: Список разделённых запятыми Redis Sentinel для состояния приложения. Если указано, "hostname" в REDIS_URL будет интерпретирован как имя сервиса Sentinel.

REDIS_SENTINEL_PORT

• Тип: int
• По умолчанию: 26379
• Описание: Порт Sentinel для Redis, используемого для состояния приложения.

ENABLE_WEBSOCKET_SUPPORT

• Тип: bool
• По умолчанию: True
• Описание: Включает поддержку веб-сокетов в Open WebUI.

к сведению

При развёртывании Open-WebUI в кластерной среде с несколькими узлами/воркерами необходимо убедиться, что значение ENABLE_WEBSOCKET_SUPPORT установлено. Без него возникнут проблемы с целостностью и постоянностью веб-сокетов.

WEBSOCKET_MANAGER

• Тип: str
• По умолчанию: redis
• Описание: Определяет менеджер веб-сокетов, который будет использоваться (в данном случае Redis).

к сведению

При развёртывании Open-WebUI в кластерной среде с несколькими узлами/воркерами необходимо убедиться, что значение WEBSOCKET_MANAGER установлено и используется NoSQL база данных ключ-значение, такая как Redis. Без этого возникнут проблемы с целостностью и постоянностью веб-сокетов.

WEBSOCKET_REDIS_URL

• Тип: str
• По умолчанию: ${REDIS_URL}
• Описание: Указывает URL экземпляра Redis, используемого для связи через веб-сокеты. Это отличается от REDIS_URL, и на практике рекомендуется устанавливать оба значения.

к сведению

При развёртывании Open-WebUI в кластерной среде с несколькими узлами/воркерами необходимо убедиться, что значение WEBSOCKET_REDIS_URL установлено и используется NoSQL база данных ключ-значение, такая как Redis. Без этого возникнут проблемы с целостностью и постоянностью веб-сокетов.

WEBSOCKET_SENTINEL_HOSTS

• Тип: str
• Описание: Список разделённых запятыми Redis Sentinel для веб-сокетов. Если указано, "hostname" в WEBSOCKET_REDIS_URL будет интерпретирован как имя сервиса Sentinel.

WEBSOCKET_SENTINEL_PORT

• Тип: int
• По умолчанию: 26379
• Описание: Порт Sentinel для Redis, используемого для веб-сокетов.

Настройки Uvicorn

UVICORN_WORKERS

• Тип: int
• По умолчанию: 1
• Описание: Управляет количеством рабочих процессов, создаваемых Uvicorn для обработки запросов. Каждый рабочий процесс запускает собственный экземпляр приложения в отдельном процессе.

к сведению

При развёртывании в оркестровочных средах, таких как Kubernetes или с использованием Helm charts, рекомендуется оставить значение UVICORN_WORKERS равным 1. Платформы оркестрации контейнеров уже предоставляют собственные механизмы масштабирования через репликацию подов, а использование нескольких рабочих процессов внутри контейнеров может привести к проблемам с распределением ресурсов и усложнить стратегии горизонтального масштабирования.

Если вы используете UVICORN_WORKERS, вам также необходимо убедиться, что соответствующие переменные окружения для масштабируемой настройки с несколькими экземплярами установлены правильно.

Настройки прокси

Open WebUI поддерживает использование прокси-серверов для запросов HTTP и HTTPS. Чтобы указать настройки прокси, Open WebUI использует следующие переменные окружения:

http_proxy

• Тип: str
• Описание: Устанавливает URL для HTTP-прокси.

https_proxy

• Тип: str
• Описание: Устанавливает URL для HTTPS-прокси.

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), учетные данные для аутентификации, или другие параметры для управления тем, как пакеты извлекаются из различных мест.