🛠️ 开发指南

欢迎来到 Open WebUI 开发设置指南！ 无论你是新手还是经验丰富的开发者，本指南将帮助你为前端和后端组件搭建一个本地开发环境。让我们开始吧！🚀

系统要求

• 操作系统: Linux（或 Windows 上的 WSL）或 macOS
• Python 版本: Python 3.11+
• Node.js 版本: 20.10+

开发方法

本地设置

🐧 本地开发设置

1. 克隆仓库：

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

2. 前端设置：

   • 创建 .env 文件：

     cp -RPp .env.example .env

   • 安装依赖：

     npm install

   • 启动前端服务器：

     npm run dev

     🌐 可通过 http://localhost:5173 访问。

3. 后端设置：

   • 导航到后端目录：

     cd backend

   • 使用 Conda 设置环境：

     conda create --name open-webui python=3.11
     conda activate open-webui

   • 安装依赖：

     pip install -r requirements.txt -U

   • 启动后端：

     sh dev.sh

     📄 API 文档可通过 http://localhost:8080/docs 访问。

Docker 设置

🐳 基于 Docker 的开发设置

1. 创建 Docker Compose 文件：

   name: open-webui-dev
   
   services:
     frontend:
       build:
         context: .
         target: build
       command: ["npm", "run", "dev"]
       depends_on:
         - backend
       ports:
         - "3000:5173"
       extra_hosts:
         - host.docker.internal:host-gateway
       volumes:
         - ./src:/app/src
   
     backend:
       build:
         context: .
         target: base
       command: ["bash", "dev.sh"]
       env_file: ".env"
       environment:
         - ENV=dev
         - WEBUI_AUTH=False
       ports:
         - "8080:8080"
       extra_hosts:
         - host.docker.internal:host-gateway
       volumes:
         - ./backend:/app/backend
         - data:/app/backend/data
   
   volumes:
     data: {}

2. 启动开发容器：

   docker compose -f compose-dev.yaml up --watch

3. 停止容器：

   docker compose -f compose-dev.yaml down

可选 Conda 设置

Conda 环境设置

如果你更喜欢使用 Conda 来隔离环境：

1. 创建并激活环境：

   conda create --name open-webui-dev python=3.11
   conda activate open-webui-dev

2. 安装依赖：

   pip install -r requirements.txt

3. 运行服务器：

   • 前端：

     npm run dev

   • 后端：

     sh dev.sh

故障排除

🐛 故障排除

FATAL ERROR: Reached Heap Limit

如果在构建过程中遇到内存相关的错误，请增加 Node.js 堆大小：

1. 修改 Dockerfile：

   ENV NODE_OPTIONS=--max-old-space-size=4096

2. 分配至少 4 GB 内存给 Node.js。

---

其他问题

• 端口冲突：
  确保没有其他进程占用 端口 8080 或 5173。

• 热重载不起作用：
  检查是否已启用 前端和后端的 watch 模式。

贡献至 Open WebUI

本地工作流程

1. 定期提交更改以跟踪进度。

2. 同步主分支以避免冲突：

   git pull origin main

3. 推送前运行测试：

   npm run test

祝你编码愉快！🎉