cnqsxdy/openwebui

Open WebUI 定制分支

镜像概述和主要用途

本镜像为开源AI平台https://github.com/open-webui/open-webui%E7%9A%84%E7%A4%BE%E5%8C%BA%E5%AE%9A%E5%88%B6%E5%88%86%E6%94%AF%EF%BC%8C%E9%9D%9E%E5%AE%98%E6%96%B9%E7%BB%B4%E6%8A%A4%EF%BC%8C%E4%B8%8EOpen WebUI官方团队无关联。该版本在官方功能基础上增加了积分管理、***验证等拓展特性，适用于需要用户计费、权限管理的AI交互平台部署场景。

核心功能和特性

拓展特性

• 积分报表功能
• 全局积分设置
• 用户积分管理与充值功能
• 支持按Token或请求次数计费，并在对话Usage中显示扣费详情
• 注册***验证功能

使用场景和适用范围

适用于需要对用户使用AI服务进行计费管理、用户注册验证的场景，如企业内部AI平台、付费AI服务平台等。

部署方式

注意：部署本定制版本后，不能直接回退到官方镜像；如需使用官方镜像，请参考https://github.com/U8F69/open-webui/wiki/%E9%87%8D%E6%96%B0%E4%BD%BF%E7%94%A8%E5%AE%98%E6%96%B9%E9%95%9C%E5%83%8F%E5%A4%84%E7%90%86%E3%80%82

部署时仅需替换镜像及版本，其他部署流程与官方版本一致。版本号可在https://github.com/U8F69/open-webui/releases/latest%E4%B8%AD%E6%9F%A5%E7%9C%8B%EF%BC%8C%E9%95%9C%E5%83%8F%E5%9C%B0%E5%9D%80%E6%A0%BC%E5%BC%8F%EF%BC%9A

ghcr.io/u8f69/open-webui:<版本号>

拓展配置

注册***验证

需在管理端开启注册***验证并配置WebUI URL，同时设置以下环境变量：

# 缓存
REDIS_URL=redis://:<password>@<host>:6379/0

# 邮件相关
SMTP_HOST=smtp.email.qq.com
SMTP_PORT=465
SMTP_USERNAME=example@qq.com
SMTP_PASSWORD=password

品牌/LOGO定制能力说明

本项目尊重并遵守Open WebUI License的品牌保护条款，鼓励保留原有品牌以支持开源生态。如需自定义品牌标识（如LOGO、名称等）：

• 确保部署满足License要求的用户规模、授权条件（详见官方说明#9）
• 未经授权的商用或大规模去除品牌属违规行为，***风险由使用者自行承担
• 具体自定义方法见docs/BRANDING.md

Docker部署

快速开始

使用SQLite数据库快速启动：

bash
docker run -d \
  --name open-webui \
  -p 3000:8080 \
  -v open-webui:/app/backend/data \
  ghcr.io/cnqsxdy/openwebui:latest

使用特定版本

bash
docker run -d \
  --name open-webui \
  -p 3000:8080 \
  -v open-webui:/app/backend/data \
  ghcr.io/cnqsxdy/openwebui:<版本号>

使用MySQL和Redis

通过环境变量配置MySQL和Redis连接（替换实际连接信息）：

bash
docker run -d \
  --name open-webui \
  -p 3000:8080 \
  -v open-webui:/app/backend/data \
  -e DATABASE_URL="mysql+pymysql://user:password@your_mysql_host:3306/dbname" \
  -e REDIS_URL="redis://:password@your_redis_host:6379/0" \
  ghcr.io/cnqsxdy/openwebui:latest

确保your_mysql_host和your_redis_host可被Docker容器访问。

Docker Compose部署

快速启动 (SQLite)

在项目根目录执行，默认使用SQLite数据库：

bash
docker compose up -d

使用MySQL和Redis

修改docker-compose.yaml文件，取消mysql和redis服务注释，配置环境变量后执行：

bash
docker compose up -d

需确保在.env文件或docker-compose.yaml中配置WEBUI_SECRET_KEY。

主要服务说明

• open-webui: 主WebUI服务
• ollama: 大模型服务
• mysql (可选): MySQL数据库服务，需取消注释并配置
• redis (可选): Redis服务，用于积分、***验证等高级功能，需取消注释并配置

环境变量说明

• WEBUI_SECRET_KEY: WebUI密钥，必须设置为强密码
• DATABASE_URL: 数据库连接字符串，默认使用SQLite (sqlite:///app/backend/data/webui.db)；使用MySQL时格式为mysql+pymysql://user:password@mysql:3306/dbname（同网络）或mysql+pymysql://user:password@your_mysql_host:3306/dbname（外部）
• REDIS_URL: Redis连接字符串，启用积分/***验证等功能时需配置；同网络Redis格式为redis://:password@redis:6379/0，外部Redis格式为redis://:password@your_redis_host:6379/0

数据持久化

• open-webui卷: 持久化WebUI数据（含SQLite数据库文件）
• ollama卷: 持久化大模型数据
• mysql_data卷: 持久化MySQL数据（如启用）
• redis_data卷: 持久化Redis数据（如启用）