🌍 Конфигурация переменных окружения
Обзор
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
- Backend Default:
- Описание: Настройка окружения.
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
.