⏱️ 快速开始

Sponsored by n8n

Does your interface have a backend yet? Try n8n

关于用户角色和隐私的重要说明：

• 管理员创建： 在 Open WebUI 上创建的第一个账户会获得 管理员权限，用于管理用户和系统设置。
• 用户注册： 后续注册的用户默认获得 待处理 状态，需管理员批准后才能进行访问。
• 隐私和数据安全： 所有您的数据，包括登录信息，均 存储在您的设备上。Open WebUI 确保 严格保密，不会发起任何外部请求，以增强隐私和安全性。
  • 所有模型默认是私有的。 模型必须通过组共享或设置为公开才能访问。如果模型被分配到某个组，则只有该组成员才能访问它。如果模型设置为公开，则实例上的任何人都可以访问。

选择您喜欢的安装方式：

• Docker： 官方支持，推荐大多数用户使用
• Python： 适用于低资源环境或想进行手动安装的用户
• Kubernetes： 理想的企业部署方案，支持扩展和编排

Docker

Docker

使用 Docker 快速开始 🐳

按照以下步骤使用 Docker 安装 Open WebUI。

第一步：拉取 Open WebUI 镜像

首先，从 GitHub 容器注册表中拉取最新的 Open WebUI Docker 镜像。

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

第二步：运行容器

以默认设置运行容器。此命令包括一个卷映射，以确保持久化数据存储。

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 支持

对于 Nvidia GPU 支持，向 docker run 命令添加 --gpus all：

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

注意

进行此更改后，无法再在单用户模式和多账户模式之间切换。

高级配置：连接到其他服务器上的 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

以下是使用 Docker Compose 来设置 Open WebUI 的示例配置文件：

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 文件，从而简化了设置流程。

---

**注意：**如果需要 Nvidia GPU 支持，请将镜像从 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 调整 pod 的网络设置，以允许容器访问您计算机的端口。

确保您已安装 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 后，导航到 设置 > 管理设置 > 连接，然后创建一个新的 Ollama API 连接到 http://10.0.2.2:[OLLAMA 端口]。默认情况下，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. 启用 Docker GPU 支持，请参考Nvidia 容器工具包。
    3. 按照指南配置 Docker Swarm 以与 GPU 一起工作。
    • 在 /etc/nvidia-container-runtime/config.toml 中确保启用了 GPU Resource，并通过取消注释 swarm-resource = "DOCKER_RESOURCE_GPU" 来启用 GPU 资源广告。在更新每个节点上的这些文件后，必须重新启动 Docker 守护进程。

• 支持 CPU：

  修改 docker-stack.yaml 中的 Ollama 服务并移除 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 堆栈：

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

Python

UV

使用 uv 安装

uv 运行时管理器可确保像 Open WebUI 这样的应用程序的 Python 环境管理无缝运行。按照以下步骤开始操作：

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更新

要使用pip将您本地安装的 Open-WebUI 包更新到最新版本，请按照以下简单步骤操作：

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更新

要使用pip将您本地安装的 Open-WebUI 包更新到最新版本，请按照以下简单步骤操作：

pip install -U open-webui

-U（或 --upgrade）标志确保了pip将包升级到最新可用版本。

就这样！您的 Open-WebUI 包现已更新并准备使用。

Venv

使用虚拟环境

使用 venv 创建隔离的 Python 环境。

步骤

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更新

要使用pip将您本地安装的 Open-WebUI 包更新到最新版本，请按照以下简单步骤操作：

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 Chart：

   helm install openwebui open-webui/open-webui

3. 验证安装：

   kubectl get pods

注意

如果您打算在集群环境中使用多个节点/Pods/工作进程来扩展 Open WebUI，则需要设置一个 NoSQL 键值数据库。 必须为所有服务实例设置相同的 环境变量，否则将会出现一致性问题、会话故障以及其他问题！

访问 WebUI

设置端口转发或负载均衡以从集群外部访问 Open WebUI。

Kustomize

Kubernetes的Kustomize设置

Kustomize允许您自定义Kubernetes YAML配置。

前提条件

• 已设置好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

注意

如果您打算在集群环境中通过多个节点/Pod/工作线程来扩展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！

使用 Ollama 的 Open WebUI

如果您使用 Open WebUI 配合 Ollama，请查看我们的 Ollama 入门指南，以了解如何使用 Open WebUI 管理您的 Ollama 实例。

加入社区

需要帮助？有问题？欢迎加入我们的社区：

• Open WebUI Discord
• GitHub 问题