⏱️ 快速開始

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。

步驟 1：拉取 Open WebUI 映像

首先從 GitHub 容器註冊表拉取最新的 Open WebUI Docker 映像。

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)：在您的本地機器的 3000 端口上公開 WebUI。

使用 GPU 支援

對於 Nvidia GPU 支援，將 --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

注意

進行此更改後，您無法在單用戶模式和多帳號模式之間切換。

高級配置：連接到不同服務器上的 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 PORT]。默認情況下，Ollama 的端口是 11434。

請參閱 Podman 文檔 了解高級配置。

Docker Swarm

Docker Swarm

此安裝方式需要瞭解 Docker Swarm，因為它使用 stack 文件在 Docker Swarm 中部署 3 個獨立的容器作為服務。

包括 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 Container Toolkit
    3. 按照這裡的指南配置 Docker Swarm 與您的 GPU
    • 在 /etc/nvidia-container-runtime/config.toml 文件中確保已啟用 GPU 資源，並通過取消註解 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 Stack：

  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 套件現在已更新並準備使用。

Development

開發環境設置

想要貢獻的開發者，請參考《高級主題》中的開發指南。

Kubernetes

Helm

Kubernetes 的 Helm 設定

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/Workers 來擴展 Open WebUI，您需要設定一個 NoSQL 鍵值資料庫。 有一些環境變數需要為所有服務實例設定為相同的值，否則會發生一致性問題、錯誤的會話以及其他問題！

存取 WebUI

設定埠轉發或負載均衡以從叢集外部存取 Open WebUI。

Kustomize

Kustomize 設置 Kubernetes

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

注意

如果您打算在集群環境中使用多個節點/Pods/工作者來擴展 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

如果您與 Ollama 一起使用 Open WebUI，請務必查看我們的 Ollama 開始指引，了解如何通過 Open WebUI 管理 Ollama 實例。

加入社區

需要幫助？有疑問？加入我們的社區：

• Open WebUI Discord
• GitHub Issues