771 字

4 分钟

【开源项目部署教程】NewAPI项目教程

2025-10-22

Github Project

API

/

Docker

/

Github

NewAPI项目部署#

NewAPI 是一个由 One API 深度二次开发而来的 统一大模型 API 管理与分发系统 ，它在功能上更完善、在渠道兼容性上也更灵活。通过它，你可以在同一套界面中管理不同来源的模型接口，实现统一鉴权、流量分发、负载均衡以及多渠道容灾，使调用大模型变得更加简单可靠。本文将带你了解如何通过 Docker Compose 来快速部署一个环境隔离、配置独立、且易于维护的 NewAPI 实例，适合个人使用，也适合团队在服务器上搭建生产环境。

获取项目代码#

项目开源地址如下：

QuantumNous

/

new-api

Waiting for api.github.com...

00K

0K

Waiting...

首先使用 Git 将项目克隆到本地：

1
git clone https://github.com/QuantumNous/new-api.git
2
cd new-api

配置Docker#

为了实现数据与宿主机的解耦，我们将使用 Docker 命名卷（Named Volumes）来替代传统的文件路径映射。请编辑项目根目录下的 docker-compose.yml 文件，将其内容替换为以下配置：

1
# New-API Docker Compose Configuration (独立部署版)
2
#
3
# Quick Start:
4
#   1. docker compose up -d
5
#   2. Access at http://localhost:3000
6
#
7
# Notes:
8
#   - 不会在宿主机创建任何文件夹（完全独立运行）
9
#   - 数据与日志都存储在 Docker 的内部卷中
10
#   - 若需查看日志: docker logs new-api
11
#   - 若需备份数据或日志: docker cp new-api:/app/logs ./logs_backup
12

13
version: '3.4'
14

15
services:
16
  new-api:
17
    image: calciumion/new-api:latest
18
    container_name: new-api
19
    restart: always
20
    command: --log-dir /app/logs
21
    ports:
22
      - "3000:3000"
23
    environment:
24
      - SQL_DSN=postgresql://root:123456@postgres:5432/new-api
25
#      - SQL_DSN=root:123456@tcp(mysql:3306)/new-api  # Uncomment if using MySQL
26
      - REDIS_CONN_STRING=redis://redis
27
      - TZ=Asia/Shanghai
28
      - ERROR_LOG_ENABLED=true
29
      - BATCH_UPDATE_ENABLED=true
30
#      - STREAMING_TIMEOUT=300
31
#      - SESSION_SECRET=random_string
32
#      - SYNC_FREQUENCY=60
33
#      - GOOGLE_ANALYTICS_ID=G-XXXXXXXXXX
34
#      - UMAMI_WEBSITE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
35
#      - UMAMI_SCRIPT_URL=https://analytics.umami.is/script.js
36
    depends_on:
37
      - redis
38
      - postgres
39
#      - mysql
40
    healthcheck:
41
      test: ["CMD-SHELL", "wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' || exit 1"]
42
      interval: 30s
43
      timeout: 10s
44
      retries: 3
45
    volumes:
46
      - app_data:/data
47
      - app_logs:/app/logs
48

49
  redis:
50
    image: redis:latest
51
    container_name: redis
52
    restart: always
53

54
  postgres:
55
    image: postgres:15
56
    container_name: postgres
57
    restart: always
58
    environment:
59
      POSTGRES_USER: root
60
      POSTGRES_PASSWORD: 123456
61
      POSTGRES_DB: new-api
62
    volumes:
63
      - pg_data:/var/lib/postgresql/data
64
#    ports:
65
#      - "5432:5432"
66

67
#  mysql:
68
#    image: mysql:8.2
69
#    container_name: mysql
70
#    restart: always
71
#    environment:
72
#      MYSQL_ROOT_PASSWORD: 123456
73
#      MYSQL_DATABASE: new-api
74
#    volumes:
75
#      - mysql_data:/var/lib/mysql
76
#    ports:
77
#      - "3306:3306"
78

79
volumes:
80
  pg_data:
81
  app_data:
82
  app_logs:
83
#  mysql_data:

TIP
配置说明：上述配置使用了 volumes 模块定义了 pg_data、app_data 等命名卷。这意味着数据库文件和日志只会托管在 Docker 内部，不会污染你的本地项目目录 。即使删除了当前的文件夹，只要不手动删除 Docker Volume，数据依然保留在 Docker 中。

启动远程服务#

确保你的服务器已安装 Docker 和 Docker Compose。如果尚未安装，可以参考官方文档进行安装。

在 docker-compose.yml 所在目录下，执行以下命令启动服务：

1
docker compose up -d

启动成功后，你可以通过浏览器访问：

默认地址：http://localhost:3000
默认账号：root 默认密码：123456

常用维护指令#

由于我们采用了全容器化部署，以下是一些常用的维护指令：

查看运行日志
Terminal window
```
1
docker logs -f new-api
```

备份日志文件到本地

1
docker cp new-api:/app/logs ./logs_backup

停止服务
Terminal window
```
1
docker compose down
```

现在，你已经拥有了一个完全独立的 API 管理中心，无需再为繁杂的 API Key 管理而发愁了。

【开源项目部署教程】NewAPI项目教程

https://xingguang641.com/posts/github/github-project/new-api/

作者

星光

发布于

2025-10-22

许可协议

CC BY-NC-SA 4.0

【博客指南】从零开始发布一篇文章

【开源项目部署教程】JupyTrans项目教程