Docker 部署

本文档提供了使用Docker部署New API的详细步骤。

强烈推荐

我们强烈推荐使用 Docker Compose 安装方式而不是手动启动Docker容器。Docker Compose方式提供了更好的配置管理、服务编排和部署体验。

基本要求

已安装Docker环境
端口: 默认使用3000端口

直接使用Docker镜像部署

使用 PostgreSQL 数据库（推荐）

生产环境优先推荐 PostgreSQL：

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e SQL_DSN="postgresql://用户名:密码@数据库地址:5432/数据库名" \
  -e TZ=Asia/Shanghai \
  -v /your/data/path:/data \
  calciumion/new-api:latest

数据库选择

PostgreSQL 是生产部署的优先推荐。New API 仍兼容 MySQL；SQLite 更适合本地体验和临时测试，不建议用于生产环境。

使用 MySQL 数据库（兼容）

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e SQL_DSN="用户名:密码@tcp(数据库地址:3306)/数据库名" \
  -e TZ=Asia/Shanghai \
  -v /your/data/path:/data \
  calciumion/new-api:latest

使用 SQLite 数据库（仅测试）

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e TZ=Asia/Shanghai \
  -v /your/data/path:/data \
  calciumion/new-api:latest

注意

请将 /your/data/path 替换为您想要存储数据的本地路径。

访问系统

部署完成后，访问 http://服务器IP:3000 将自动引导到初始化页面。按照页面指引手动设置管理员账号和密码（仅首次安装需要），完成后即可使用新设置的管理员账号登录系统。