更新日期：2026年1月5日

New API 部署指南

本文介绍 New API 的部署方法，包括 Docker 单容器部署和 Docker Compose 部署两种方式。

一、系统要求

1.1 硬件要求

• CPU：2 核心及以上
• 内存：2GB 及以上
• 硬盘：20GB 及以上可用空间

1.2 软件要求

• 操作系统：Linux（推荐 Ubuntu、CentOS、Debian）
• Docker：20.10 及以上版本
• Docker Compose：1.29 及以上版本（可选）

二、Docker 单容器部署

2.1 快速部署

使用以下命令快速部署 New API：

1
2
3
4
5

docker run --name new-api -itd --restart always \
  -p 32410:3000 \
  -e TZ=Asia/Shanghai \
  -v ./data:/data \
  calciumion/new-api:latest

2.2 参数说明

• --name new-api：容器名称
• -itd：交互式、伪 TTY、后台运行
• --restart always：容器自动重启
• -p 32410:3000：端口映射（宿主机端口:容器端口）
• -e TZ=Asia/Shanghai：设置时区
• -v ./data:/data：数据卷挂载
• calciumion/new-api:latest：镜像名称和标签

2.3 访问服务

部署完成后，通过以下地址访问：

• 本地访问：http://localhost:32410
• 远程访问：http://服务器IP:32410

三、Docker Compose 部署

3.1 创建配置文件

创建 docker-compose.yml 文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

version: '3.8'
name: new-api
services:
  new-api:
    image: calciumion/new-api:latest
    container_name: new-api
    restart: unless-stopped
    ports:
      - '32410:3000'
    environment:
      - TZ=Asia/Shanghai
    volumes:
      - ./data:/data
    networks:
      - appnet

networks:
  appnet:
    external: true

3.2 参数说明

• version：Docker Compose 文件版本
• services：定义服务
• image：使用的镜像
• container_name：容器名称
• restart：重启策略（unless-stopped：除非手动停止，否则自动重启）
• ports：端口映射
• environment：环境变量
• volumes：数据卷挂载
• networks：网络配置

3.3 启动服务

在 docker-compose.yml 所在目录执行：

1
2
3
4
5
6
7
8

# 启动服务
docker compose up -d

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

# 停止服务
docker compose down

3.4 端口修改

如果 3000 端口已经被占用，可以修改 docker-compose.yml 的 3000 端口映射，例如：

1
2

ports:
  - '53000:3000'

3.5 启动验证

日志显示顺利启动成功即表示部署成功。

四、配置说明

4.1 数据目录

• 默认数据目录：./data
• 建议使用绝对路径，例如：/data/new-api

4.2 端口配置

• 默认端口：3000
• 可根据需要修改映射端口
• 确保防火墙已开放对应端口

4.3 时区设置

• 默认时区：Asia/Shanghai
• 可根据需要修改为其他时区

五、常用操作

5.1 查看容器状态

1

docker ps | grep new-api

5.2 查看容器日志

1

docker logs -f new-api

5.3 重启容器

1

docker restart new-api

5.4 停止容器

1

docker stop new-api

5.5 删除容器

1

docker rm new-api

5.6 更新镜像

1
2
3
4
5
6
7
8
9

# 拉取最新镜像
docker pull calciumion/new-api:latest

# 重新创建容器
docker run --name new-api -itd --restart always \
  -p 32410:3000 \
  -e TZ=Asia/Shanghai \
  -v ./data:/data \
  calciumion/new-api:latest

六、常见问题

6.1 容器无法启动

问题：容器启动失败

解决方案：

1. 检查端口是否被占用
2. 检查数据目录权限
3. 查看容器日志排查错误

6.2 无法访问服务

问题：无法通过浏览器访问服务

解决方案：

1. 检查防火墙设置
2. 确认端口映射正确
3. 检查容器是否正常运行

6.3 数据丢失

问题：重启容器后数据丢失

解决方案：

1. 确认数据卷挂载正确
2. 使用绝对路径挂载数据目录
3. 定期备份数据目录

6.4 性能问题

问题：服务响应缓慢

解决方案：

1. 检查服务器资源使用情况
2. 优化数据库配置
3. 增加服务器资源

七、版本历史