Skip to content

安装指南

Docker Compose 部署(推荐)

1. 准备工作

确保服务器已安装:

  • Docker 20.10+
  • Docker Compose 2.0+

2. 下载配置

bash
mkdir -p /opt/new-api
cd /opt/new-api

# 下载 docker-compose.yml
curl -O https://raw.githubusercontent.com/QuantumNous/new-api/main/docker-compose.yml

3. 配置环境变量

编辑 docker-compose.yml,修改以下关键配置:

yaml
environment:
  - SERVER_HOST=http://your-domain.com  # 你的公网地址
  - SESSION_SECRET=your-random-secret   # 随机字符串,用于加密
  - SQL_DSN=postgres://user:password@db:5432/newapi  # 数据库连接

4. 启动服务

bash
docker-compose up -d

5. 验证部署

bash
# 查看容器状态
docker-compose ps

# 查看日志
docker logs -f new-api

# 测试 API
curl http://localhost:3000/api/status

手动部署

如果你不想使用 Docker,也可以手动编译部署:

bash
# 克隆代码
git clone https://github.com/QuantumNous/new-api.git
cd new-api

# 编译前端(需要 Node.js 18+)
cd web/default && npm install && npm run build && cd ../..

# 编译后端(需要 Go 1.21+)
go build -o new-api

# 运行
./new-api

反向代理配置

Nginx

nginx
server {
    listen 80;
    server_name your-domain.com;
    
    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Caddy

your-domain.com {
    reverse_proxy localhost:3000
}

数据库迁移

首次启动会自动创建表结构。如需手动迁移:

bash
docker exec -it new-api ./new-api --migrate

常见问题

Q: 前端构建失败怎么办? A: 确保 Node.js 版本 >= 18,npm >= 9。如果网络受限,可配置 npm 镜像源。

Q: 数据库连接失败? A: 检查 SQL_DSN 格式是否正确,确保数据库容器已正常启动。

Q: 如何升级版本? A: 拉取最新代码,重新构建镜像,保留数据库数据即可。

基于 MIT 许可发布