微溪API(wxiapi) 是基于 NewAPI 二次开发的 AI API 管理系统,合并的最新代码(v0.8.7.5)遵循 MIT/Apache-2.0 协议闭源发布。
- 🔥 高性能 API 代理
- 🎯 多模型支持
- 📊 详细统计分析
- 🔒 安全认证机制
- 🐳 Docker 一键部署
- 📱 响应式界面
- Docker 20.10+
- Docker Compose 2.0+
# Docker 官方一键安装脚本
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
# 启动 Docker 服务
sudo systemctl start docker
sudo systemctl enable docker
# 将当前用户添加到 docker 组(可选,避免每次使用 sudo)
sudo usermod -aG docker $USER
newgrp docker# 使用 Homebrew 安装
brew install --cask docker
# 或直接下载:https://www.docker.com/products/docker-desktop下载安装 Docker Desktop
现代 Docker 已内置 Compose 插件,但如需单独安装:
# 方法一:官方插件安装(推荐)
sudo apt update
sudo apt install docker-compose-plugin
# 方法二:手动安装(v2.39.2)
sudo curl -L "https://github.com/docker/compose/releases/download/v2.39.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
# 验证安装
docker compose version💡 注意:新版本使用
docker compose(空格)而不是docker-compose(连字符)
旧版本 v2.39.2 暂时还是docker-compose
git clone https://github.com/wxiai/wxiapi.git
cd wxiapi# 复制示例配置文件
cp .env.example .env
# 编辑配置文件
vim .env编辑 docker-compose.yml 文件,必须修改以下配置:
environment:
# ⚠️ 必须设置强密码
- SQL_DSN=root:your_strong_password@tcp(mysql:3306)/wxi-api?charset=utf8mb4&parseTime=True&loc=Local
# ⚠️ 必须设置授权密钥
- WXI_SECRET=your_secret_key_here
# 以下是可选配置
- TZ=Asia/Shanghai
#建议设置Redis
- REDIS_CONN_STRING=redis://redis
- SESSION_SECRET=random_string123123 #随机!同时修改 MySQL 配置:
mysql:
environment:
MYSQL_ROOT_PASSWORD: your_strong_password # 与上面密码保持一致# 后台启动所有服务
docker compose up -d
# 查看服务状态
docker compose ps
# 查看服务日志
docker compose logs -f wxi-api打开浏览器访问:http://localhost:3000
# 停止服务
docker compose down
# 重启服务
docker compose restart
# 更新镜像
docker compose pull
docker compose up -d
# 查看日志
docker compose logs -f [service_name]
# 进入容器
docker compose exec wxi-api sh
# 清理数据(⚠️ 危险操作)
docker compose down -v| 服务 | 端口 | 说明 |
|---|---|---|
| wxi-api | 3000 | 主应用服务 |
| mysql | 3306 | 数据库(内部访问) |
| redis | 6379 | 缓存服务(内部访问) |
| 变量名 | 说明 | 默认值 | 必填 |
|---|---|---|---|
PORT |
服务端口 | 3000 | ❌ |
SQL_DSN |
数据库连接字符串 | - | ✅ |
REDIS_CONN_STRING |
Redis 连接字符串 | redis://redis | ❌ |
WXI_SECRET |
系统授权密钥 | - | ✅ |
GIN_MODE |
运行模式 | release | ❌ |
TZ |
时区 | Asia/Shanghai | ❌ |
- 数据库数据:
mysql_data卷 - 应用数据:
./data目录 - 日志文件:
./logs目录
- 更改默认密码:MySQL 和应用的默认密码
- 设置防火墙:仅开放必要端口
- 定期备份:数据库和配置文件
- 监控日志:定期检查应用日志
- 更新镜像:定期更新到最新版本
# 检查服务健康状态
curl http://localhost:3000/api/status# 备份数据库
docker compose exec mysql mysqldump -uroot -p wxi-api > backup.sql
# 备份应用数据
tar -czf backup-data.tar.gz ./data ./logsQ: 服务启动失败怎么办?
- 检查端口是否被占用:
netstat -tulpn | grep :3000 - 查看服务日志:
docker compose logs wxi-api - 确认配置文件格式正确
Q: 如何修改默认端口?
修改 docker-compose.yml 中的端口映射:
ports:
- "8080:3000" # 将外部端口改为 8080Q: 数据库连接失败?
- 确认 MySQL 容器正常运行
- 检查
SQL_DSN配置是否正确 - 确认密码与 MySQL 配置一致
欢迎提交 Issue 和 Pull Request!
本项目遵循OneAPI/NewAPI的最新代码(v0.8.7.5) MIT / Apache-2.0 双许可证。
Made with ❤️ by WXIAPI Team