VoAPI

环境要求

• 已安装 Docker 与 Docker Compose（Docker Compose 部署方式）
• 使用 Docker 单容器部署时，需提前准备好可用的 MySQL 和 Redis 数据库
• linux-arm64 架构用户需使用 voapi/voapi-linux-arm64 镜像
• 服务器需开放 6800 端口（或按实际修改后的端口放行）

安装与启动步骤

1. 1克隆项目仓库

   把 VoAPI 源码拉到本地或服务器上，后续 docker-compose 会用到仓库内的编排文件。

   git clone https://github.com/VoAPI/VoAPI.git

   复制

2. 2进入项目目录

   切换到刚克隆下来的 VoAPI 目录，确保在项目根目录执行后续命令。

   cd VoAPI

   复制

3. 3Docker Compose 启动

   后台启动全部服务容器，README 推荐用这种方式一键拉起；linux-arm64 用户需先把编排文件中的镜像换成 voapi/voapi-linux-arm64。

   docker-compose up -d

   复制

4. 4访问并注册管理员

   浏览器打开 http://localhost:6800（按实际情况改域名和端口），注册的第一个用户即为管理员账号。

5. 5后台同步模型供应商

   用管理员登录后点右上角紫色齿轮进入后台，在「模型供应商」下的「模型列表」「供应商列表」点击远程同步，拉取官方预置模型和供应商。

6. 6新建规则引擎与渠道

   在「模型供应商」-「规则引擎」新建空白规则引擎（内容留空即完全透传），再到「渠道分组」新建分组，最后在「渠道列表」新建渠道并选择该规则引擎与分组。

7. 7可选：Docker 单容器部署

   不使用 Compose 时，需先准备好 MySQL 和 Redis 并写好 config.yml，再运行单容器命令，把配置和 file、public 目录挂载进容器。

   docker run -d --name voapi --restart always -p 6800:6800 -e TZ=Asia/Shanghai -v ./config.yml:/config.yml -v ./file:/file -v ./public:/public voapi/voapi:latest

   复制

关键配置

如何确认成功

容器启动后用浏览器访问 http://localhost:6800，能正常打开页面并注册首个用户，即部署成功。

常见问题

注意事项

• config.yml 中数据库类型字段在 README 里写作 db.dirver，配置时请按官方文件原样填写。
• Docker Compose 部署最省事，单容器部署需要你自行准备 MySQL 与 Redis 并写好 config.yml。
• README 中的 http://localhost:6800 只是示例，实际部署请替换为真实域名和端口。
• 后台第一个渠道配置顺序：远程同步模型与供应商 → 新建规则引擎 → 新建渠道分组 → 新建渠道。