⏱️ Быстрый старт

Sponsored by n8n

Does your interface have a backend yet? Try n8n

Важное замечание о ролях пользователей и конфиденциальности:

• Создание администратора: Первая учетная запись, созданная в Open WebUI, получает привилегии администратора, позволяющие управлять пользователями и настройками системы.
• Регистрация пользователей: Последующие регистрации начинают с ожидающего статуса, требующего одобрения администратора для получения доступа.
• Конфиденциальность и безопасность данных: Все ваши данные, включая данные для входа, хранятся локально на вашем устройстве. Open WebUI обеспечивает строгую конфиденциальность и отсутствие внешних запросов для повышения уровня конфиденциальности и безопасности.
  • Все модели по умолчанию являются приватными. Модели должны быть явно поделены через группы или сделаны общедоступными. Если модель назначена группе, только члены этой группы могут её видеть. Если модель сделана общедоступной, её могут видеть все пользователи данного экземпляра.

Выберите предпочтительный метод установки ниже:

• Docker: Официально поддерживается и рекомендуется для большинства пользователей
• Python: Подходит для сред с низкими ресурсами или предпочитающих ручную настройку
• Kubernetes: Идеально для корпоративных развертываний, требующих масштабирования и оркестрации

Docker

Docker

Быстрый старт с Docker 🐳

Следуйте этим шагам, чтобы установить Open WebUI с помощью Docker.

Шаг 1: Загрузка образа Open WebUI

Начните с загрузки последнего Docker-образа Open WebUI из реестра контейнеров GitHub.

docker pull ghcr.io/open-webui/open-webui:main

Шаг 2: Запуск контейнера

Запустите контейнер с настройками по умолчанию. Эта команда включает маппинг тома для обеспечения постоянного хранения данных.

docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main

Важные Флаги

• Маппинг тома (-v open-webui:/app/backend/data): Обеспечивает постоянное хранение ваших данных. Это предотвращает потерю данных между перезапусками контейнера.
• Маппинг портов (-p 3000:8080): Открывает доступ к WebUI на порту 3000 вашей локальной машины.

Использование GPU

Для поддержки GPU Nvidia добавьте --gpus all в команду docker run:

docker run -d -p 3000:8080 --gpus all -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:cuda

Однопользовательский режим (отключение входа)

Чтобы обойти страницу входа в режиме одного пользователя, установите переменную окружения WEBUI_AUTH в значение False:

docker run -d -p 3000:8080 -e WEBUI_AUTH=False -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main

warning

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

Расширенная конфигурация: Подключение к Ollama на другом сервере

Чтобы подключить Open WebUI к серверу Ollama, расположенному на другом хосте, добавьте переменную окружения OLLAMA_BASE_URL:

docker run -d -p 3000:8080 -e OLLAMA_BASE_URL=https://example.com -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main

Доступ к WebUI

После запуска контейнера, откройте доступ к Open WebUI по адресу:

http://localhost:3000

Для подробной помощи по каждому флагу Docker, смотрите документацию Docker.

Обновление

Чтобы обновить вашу локальную установку Docker до последней версии, вы можете использовать Watchtower или вручную обновить контейнер.

Вариант 1: Использование Watchtower

С помощью Watchtower вы можете автоматизировать процесс обновления:

docker run --rm --volume /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once open-webui

(Замените open-webui на имя вашего контейнера, если оно отличается.)

Вариант 2: Ручное обновление

1. Остановите и удалите текущий контейнер:

   docker rm -f open-webui

2. Скачайте последнюю версию:

   docker pull ghcr.io/open-webui/open-webui:main

3. Запустите контейнер снова:

   docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main

Оба метода позволят обновить ваш Docker до последней сборки и запустить его.

Docker Compose

Настройка Docker Compose

Использование Docker Compose упрощает управление многоконтейнерными приложениями Docker.

Если у вас не установлен Docker, ознакомьтесь с нашим руководством по установке Docker.

Docker Compose требует установки дополнительного пакета, docker-compose-v2.

Внимание: Ранние руководства по Docker Compose могут использовать синтаксис версии 1, где команды выглядят как docker-compose build. Убедитесь, что вы используете синтаксис версии 2, где команды выглядят как docker compose build (обратите внимание на пробел вместо дефиса).

Пример файла docker-compose.yml

Вот пример конфигурационного файла для настройки Open WebUI с помощью Docker Compose:

version: 3
services:
  openwebui:
    image: ghcr.io/open-webui/open-webui:main
    ports:
      - "3000:8080"
    volumes:
      - open-webui:/app/backend/data
volumes:
  open-webui:

Запуск сервисов

Чтобы запустить сервисы, выполните следующую команду:

docker compose up -d

Вспомогательный скрипт

В кодовой базе имеется полезный вспомогательный скрипт run-compose.sh. Этот скрипт помогает выбрать файлы Docker Compose для включения в вашу настройку, упрощая процесс развертывания.

---

Примечание: Для поддержки GPU Nvidia замените образ ghcr.io/open-webui/open-webui:main на ghcr.io/open-webui/open-webui:cuda и добавьте следующий код в определение вашего сервиса в файле docker-compose.yml:

deploy:
  resources:
    reservations:
      devices:
        - driver: nvidia
          count: all
          capabilities: [gpu]

Эта настройка гарантирует, что ваше приложение сможет использовать ресурсы GPU, если они доступны.

Podman

Использование Podman

Podman — это бездемонный контейнерный движок для разработки, управления и запуска OCI-контейнеров.

Основные команды

• Запуск контейнера:

  podman run -d --name openwebui -p 3000:8080 -v open-webui:/app/backend/data ghcr.io/open-webui/open-webui:main

• Список работающих контейнеров:

  podman ps

Сетевые настройки с Podman

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

Убедитесь, что у вас установлен slirp4netns, удалите предыдущий контейнер, если он существует, с помощью podman rm и запустите новый контейнер с

  podman run -d --network=slirp4netns:allow_host_loopback=true --name openwebui -p 3000:8080 -v open-webui:/app/backend/data ghcr.io/open-webui/open-webui:main

Если вы используете Ollama с вашего компьютера (не внутри контейнера),

После входа в open-webui перейдите в Настройки > Настройки администратора > Соединения и создайте новое API-соединение Ollama на http://10.0.2.2:[OLLAMA PORT]. По умолчанию порт Ollama — 11434.

Обратитесь к документации Podman для получения информации о расширенных настройках.

Docker Swarm

Docker Swarm

Этот метод установки требует знания Docker Swarm, так как используется стек-файл для развертывания трех отдельных контейнеров как сервисов в Docker Swarm.

Включаются изолированные контейнеры ChromaDB, Ollama и OpenWebUI. Дополнительно предоставлены предзаполненные переменные окружения для лучшего понимания настройки.

Выберите подходящую команду в зависимости от аппаратной конфигурации:

• Перед началом:

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

  Текущий пример использует изолированный каталог data, который находится в том же директории, что и docker-stack.yaml.

  • Например:

    mkdir -p data/open-webui data/chromadb data/ollama

• С поддержкой GPU:

  Docker-stack.yaml

  version: '3.9'
  
  services:
    openWebUI:
      image: ghcr.io/open-webui/open-webui:main
      depends_on:
          - chromadb
          - ollama
      volumes:
        - ./data/open-webui:/app/backend/data
      environment:
        DATA_DIR: /app/backend/data 
        OLLAMA_BASE_URLS: http://ollama:11434
        CHROMA_HTTP_PORT: 8000
        CHROMA_HTTP_HOST: chromadb
        CHROMA_TENANT: default_tenant
        VECTOR_DB: chroma
        WEBUI_NAME: Awesome ChatBot
        CORS_ALLOW_ORIGIN: "*" # Это текущий настройка по умолчанию, необходимо изменить перед использованием в производстве
        RAG_EMBEDDING_ENGINE: ollama
        RAG_EMBEDDING_MODEL: nomic-embed-text-v1.5
        RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE: "True"
      ports:
        - target: 8080
          published: 8080
          mode: overlay
      deploy:
        replicas: 1
        restart_policy:
          condition: any
          delay: 5s
          max_attempts: 3
  
    chromadb:
      hostname: chromadb
      image: chromadb/chroma:0.5.15
      volumes:
        - ./data/chromadb:/chroma/chroma
      environment:
        - IS_PERSISTENT=TRUE
        - ALLOW_RESET=TRUE
        - PERSIST_DIRECTORY=/chroma/chroma
      ports: 
        - target: 8000
          published: 8000
          mode: overlay
      deploy:
        replicas: 1
        restart_policy:
          condition: any
          delay: 5s
          max_attempts: 3
      healthcheck: 
        test: ["CMD-SHELL", "curl localhost:8000/api/v1/heartbeat || exit 1"]
        interval: 10s
        retries: 2
        start_period: 5s
        timeout: 10s
  
    ollama:
      image: ollama/ollama:latest
      hostname: ollama
      ports:
        - target: 11434
          published: 11434
          mode: overlay
      deploy:
        resources:
          reservations:
            generic_resources:
              - discrete_resource_spec:
                  kind: "NVIDIA-GPU"
                  value: 0
        replicas: 1
        restart_policy:
          condition: any
          delay: 5s
          max_attempts: 3
      volumes:
        - ./data/ollama:/root/.ollama
  

  • Дополнительные требования:

    1. Убедитесь, что CUDA включена — следуйте инструкциям для вашей ОС и GPU.
    2. Включите поддержку GPU в Docker — смотрите Nvidia Container Toolkit
    3. Следуйте инструкции по настройке Docker Swarm для работы с GPU
    • Убедитесь, что GPU Resource включен в /etc/nvidia-container-runtime/config.toml, и включите рекламу ресурса GPU, раскомментировав swarm-resource = "DOCKER_RESOURCE_GPU". После обновления этих файлов на каждом узле необходимо перезапустить демон Docker.

• С поддержкой CPU:

  Измените сервис Ollama в docker-stack.yaml и удалите строки с generic_resources:

      ollama:
    image: ollama/ollama:latest
    hostname: ollama
    ports:
      - target: 11434
        published: 11434
        mode: overlay
    deploy:
      replicas: 1
      restart_policy:
        condition: any
        delay: 5s
        max_attempts: 3
    volumes:
      - ./data/ollama:/root/.ollama

• Развертывание Docker Stack:

  docker stack deploy -c docker-stack.yaml -d super-awesome-ai

Python

uv

Установка с помощью uv

Менеджер выполнения uv обеспечивает простое управление Python-окружениями для приложений, таких как Open WebUI. Следуйте этим шагам, чтобы начать:

1. Установите uv

Выберите соответствующую команду установки для вашей операционной системы:

• macOS/Linux:

  curl -LsSf https://astral.sh/uv/install.sh | sh

• Windows:

  powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

2. Запустите Open WebUI

После установки uv запуск Open WebUI становится простым. Используйте команду ниже, не забывая установить переменную среды DATA_DIR, чтобы избежать потери данных. Примеры путей указаны для каждой платформы:

• macOS/Linux:

  DATA_DIR=~/.open-webui uvx --python 3.11 open-webui@latest serve

• Windows (PowerShell):

  $env:DATA_DIR="C:\open-webui\data"; uvx --python 3.11 open-webui@latest serve

Обновление с помощью Python

Чтобы обновить локально установленный пакет Open-WebUI до последней версии с использованием pip, выполните следующие простые шаги:

pip install -U open-webui

Флаг -U (или --upgrade) гарантирует, что pip обновит пакет до последней доступной версии.

Вот и всё! Ваш пакет Open-WebUI обновлен и готов к использованию.

Conda

Установка с помощью Conda

1. Создайте окружение Conda:

   conda create -n open-webui python=3.11

2. Активируйте окружение:

   conda activate open-webui

3. Установите Open WebUI:

   pip install open-webui

4. Запустите сервер:

   open-webui serve

Обновление с помощью Python

Чтобы обновить локально установленный пакет Open-WebUI до последней версии с использованием pip, выполните следующие простые шаги:

pip install -U open-webui

Флаг -U (или --upgrade) гарантирует, что pip обновит пакет до последней доступной версии.

Вот и всё! Ваш пакет Open-WebUI обновлен и готов к использованию.

Venv

Использование виртуальных окружений

Создавайте изолированные окружения Python с помощью venv.

Шаги

1. Создайте виртуальное окружение:

   python3 -m venv venv

2. Активируйте виртуальное окружение:

   • На Linux/macOS:

     source venv/bin/activate

   • На Windows:

     venv\Scripts\activate

3. Установите Open WebUI:

   pip install open-webui

4. Запустите сервер:

   open-webui serve

Обновление с помощью Python

Чтобы обновить локально установленный пакет Open-WebUI до последней версии с использованием pip, выполните следующие простые шаги:

pip install -U open-webui

Флаг -U (или --upgrade) гарантирует, что pip обновит пакет до последней доступной версии.

Вот и всё! Ваш пакет Open-WebUI обновлен и готов к использованию.

Разработка

Настройка для разработки

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

Kubernetes

Helm

Настройка Helm для Kubernetes

Helm помогает управлять приложениями Kubernetes.

Требования

• Кластер Kubernetes настроен.
• Helm установлен.

Шаги

1. Добавьте репозиторий Open WebUI Helm:

   helm repo add open-webui https://open-webui.github.io/helm-charts
   helm repo update

2. Установите чарт Open WebUI:

   helm install openwebui open-webui/open-webui

3. Проверьте установку:

   kubectl get pods

warning

Если вы планируете масштабировать Open WebUI, используя несколько узлов/подов/воркеров в кластерной среде, вам необходимо настроить NoSQL key-value базу данных. Есть некоторые переменные окружения, которые нужно установить на одинаковые значения для всех экземпляров сервисов, в противном случае могут возникнуть проблемы с консистентностью, ошибочные сессии и другие проблемы!

Доступ к WebUI

Настройте перенаправление портов или балансировку нагрузки, чтобы получить доступ к Open WebUI извне кластера.

Kustomize

Настройка Kustomize для Kubernetes

Kustomize позволяет настраивать YAML-конфигурации Kubernetes.

Предварительные требования

• Кластер Kubernetes настроен.
• Kustomize установлен.

Шаги

1. Клонируйте манифесты Open WebUI:

   git clone https://github.com/open-webui/k8s-manifests.git
   cd k8s-manifests

2. Примените манифесты:

   kubectl apply -k .

3. Проверьте установку:

   kubectl get pods

warning

Если вы планируете масштабировать Open WebUI, используя несколько узлов/подов/воркеров в кластерной среде, необходимо настроить NoSQL базу данных, содержащую ключ-значение. Существует несколько переменных окружения, которые должны быть установлены одинаково для всех экземпляров сервиса, иначе возникнут проблемы с согласованностью, сбойные сессии и другие ошибки!

Доступ к WebUI

Настройте переадресацию портов или балансировку нагрузки, чтобы получить доступ к Open WebUI за пределами кластера.

Сторонние

Pinokio.computer

Установка Pinokio.computer

Для установки через Pinokio.computer, пожалуйста, посетите их веб-сайт:

https://pinokio.computer/

Поддержка этого метода установки предоставляется через их веб-сайт.

Дополнительные интеграции со сторонними сервисами

(Добавьте информацию о сторонних интеграциях по мере их появления.)

Следующие шаги

После установки посетите:

• http://localhost:3000, чтобы получить доступ к Open WebUI.
• или http://localhost:8080/, если используется развертывание на Python.

Теперь вы готовы начать использовать Open WebUI!

Использование Open WebUI с Ollama

Если вы используете Open WebUI с Ollama, обязательно ознакомьтесь с нашим Руководством по началу работы с Ollama, чтобы узнать, как управлять экземплярами Ollama с помощью Open WebUI.

Присоединяйтесь к сообществу

Нужна помощь? Есть вопросы? Присоединяйтесь к нашему сообществу:

• Open WebUI Discord
• GitHub Issues