超详细从源码到部署：零基础玩转new-api一站式教程-优快云博客

超详细从源码到部署：零基础玩转new-api一站式教程

【免费下载链接】new-api 基于One API的二次开发版本，仅供学习使用！项目地址: https://gitcode.com/gh_mirrors/ne/new-api

你是否在寻找一款功能强大且易于部署的API管理系统？还在为复杂的部署流程而头疼吗？本文将带你从零开始，一步步完成new-api的源码获取、环境配置、编译到最终部署的全过程，让你轻松上手这款基于One API二次开发的新一代大模型网关与AI资产管理系统。读完本文，你将掌握new-api的部署技巧，能够快速搭建属于自己的API服务。

项目简介

new-api是基于One API的二次开发版本，是一款新一代大模型网关与AI资产管理系统。它提供了全新的UI界面、多语言支持、在线充值功能等丰富特性，兼容原版One API的数据库，支持多种模型按次数收费，以及渠道加权随机等功能。

项目名称：GitHub 加速计划 / ne / new-api 项目路径：gh_mirrors/ne/new-api 项目描述：基于One API的二次开发版本，仅供学习使用！

官方文档：docs/official.md 项目教程：README.md

环境准备

在开始部署new-api之前，我们需要准备好相应的环境。以下是部署new-api所需的环境要求：

本地数据库（默认）：SQLite（Docker部署必须挂载/data目录）
远程数据库：MySQL版本 >= 5.7.8，PgSQL版本 >= 9.6

如果你计划使用Docker Compose部署，还需要安装Docker和Docker Compose。如果你使用宝塔面板部署，则需要安装宝塔面板9.2.0版本及以上。

源码获取

要获取new-api的源码，你可以通过以下命令克隆仓库：

git clone https://gitcode.com/gh_mirrors/ne/new-api.git
cd new-api

配置与编译

环境变量配置

new-api的配置主要通过环境变量来实现，详细的环境变量配置说明可以参考安装指南-环境变量配置。以下是一些常用的环境变量：

GENERATE_DEFAULT_TOKEN：是否为新注册用户生成初始令牌，默认为 false
STREAMING_TIMEOUT：流式回复超时时间，默认300秒
SESSION_SECRET：多机部署时必须设置，确保登录状态一致
CRYPTO_SECRET：公用Redis时必须设置，确保Redis内容可获取

你可以根据自己的需求修改这些环境变量。

编译项目

如果你需要手动编译项目，可以参考以下步骤。首先，确保你已经安装了Go环境。然后，进入项目目录，执行以下命令：

go mod download
go build -o new-api main.go

编译完成后，会生成一个名为new-api的可执行文件。

部署方式

new-api提供了多种部署方式，你可以根据自己的实际情况选择合适的方式。

使用宝塔面板Docker功能部署

安装宝塔面板（9.2.0版本及以上），在应用商店中找到New-API安装即可。详细的图文教程可以参考docs/installation/BT.md。

使用Docker Compose部署（推荐）

首先，编辑docker-compose.yml文件，根据需要进行配置。你可以使用nano或vim编辑器：

nano docker-compose.yml
# 或
vim docker-compose.yml

然后，执行以下命令启动服务：

docker-compose up -d

直接使用Docker镜像

使用SQLite的部署命令：

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

使用MySQL的部署命令：

docker run --name new-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest

验证与测试

部署完成后，你可以通过访问http://localhost:3000来验证服务是否正常启动。如果一切正常，你将看到new-api的登录界面。

你还可以通过调用API来测试服务是否正常工作。例如，使用curl命令调用聊天接口：

curl -X POST http://localhost:3000/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "Hello, world!"}]}'

如果返回正常的响应，则说明服务部署成功。