new-api

# One API _✨ All in one 的 OpenAI 接口，整合各种 API 访问方式，开箱即用✨_

程序下载 · 部署教程 · 意见反馈 · 截图展示 · 在线演示 · 常见问题 · 赞赏支持

Warning：使用 Docker 拉取的最新镜像可能是 alpha 版本，如果追求稳定性请手动指定版本。

Warning：从 v0.3 版本升级到 v0.4 版本需要手动迁移数据库，请手动执行数据库迁移脚本。

功能

1. 支持多种 API 访问渠道，欢迎 PR 或提 issue 添加更多渠道：
   • OpenAI 官方通道
   • Azure OpenAI API
   • API2D
   • OhMyGPT
   • AI Proxy （邀请码：OneAPI）
   • AI.LS
   • OpenAI Max
   • OpenAI-SB
   • CloseAI
   • 自定义渠道：例如使用自行搭建的 OpenAI 代理
2. 支持通过负载均衡的方式访问多个渠道。
3. 支持 stream 模式，可以通过流式传输实现打字机效果。
4. 支持多机部署，详见此处。
5. 支持令牌管理，设置令牌的过期时间和使用次数。
6. 支持兑换码管理，支持批量生成和导出兑换码，可使用兑换码为账户进行充值。
7. 支持通道管理，批量创建通道。
8. 支持用户分组以及渠道分组。
9. 支持渠道设置模型列表。
10. 支持发布公告，设置充值链接，设置新用户初始额度。
11. 支持丰富的自定义设置，
    1. 支持自定义系统名称，logo 以及页脚。
    2. 支持自定义首页和关于页面，可以选择使用 HTML & Markdown 代码进行自定义，或者使用一个单独的网页通过 iframe 嵌入。
12. 支持通过系统访问令牌访问管理 API。
13. 支持用户管理，支持多种用户登录注册方式：
    • 邮箱登录注册以及通过邮箱进行密码重置。
    • GitHub 开放授权。
    • 微信公众号授权（需要额外部署 WeChat Server）。
14. 未来其他大模型开放 API 后，将第一时间支持，并将其封装成同样的 API 访问方式。

部署

基于 Docker 进行部署

执行：docker run -d --restart always -p 3000:3000 -v /home/ubuntu/data/one-api:/data justsong/one-api

-p 3000:3000 中的第一个 3000 是宿主机的端口，可以根据需要进行修改。

数据将会保存在宿主机的 /home/ubuntu/data/one-api 目录，请确保该目录存在且具有写入权限，或者更改为合适的目录。

Nginx 的参考配置：

server{
   server_name openai.justsong.cn;  # 请根据实际情况修改你的域名
   
   location / {
          client_max_body_size  64m;
          proxy_http_version 1.1;
          proxy_pass http://localhost:3000;  # 请根据实际情况修改你的端口
          proxy_set_header Host $host;
          proxy_set_header X-Forwarded-For $remote_addr;
          proxy_cache_bypass $http_upgrade;
          proxy_set_header Accept-Encoding gzip;
   }
}

之后使用 Let's Encrypt 的 certbot 配置 HTTPS：

# Ubuntu 安装 certbot：
sudo snap install --classic certbot
sudo ln -s /snap/bin/certbot /usr/bin/certbot
# 生成证书 & 修改 Nginx 配置
sudo certbot --nginx
# 根据指示进行操作
# 重启 Nginx
sudo service nginx restart

手动部署

1. 从 GitHub Releases 下载可执行文件或者从源码编译： ```shell git clone https://github.com/songquanpeng/one-api.git
   

# 构建前端 cd one-api/web npm install npm run build

# 构建后端 cd .. go mod download go build -ldflags "-s -w" -o one-api ````

1. 运行： shell chmod u+x one-api ./one-api --port 3000 --log-dir ./logs 3. 访问 http://localhost:3000/ 并登录。初始账号用户名为 root，密码为 123456。 更加详细的部署教程参见此处。 ### 多机部署 1. 所有服务器 SESSION_SECRET 设置一样的值。 2. 必须设置 SQL_DSN，使用 MySQL 数据库而非 SQLite，请自行配置主备数据库同步。 3. 所有从服务器必须设置 SYNC_FREQUENCY，以定期从数据库同步配置。 4. 从服务器可以选择设置 FRONTEND_BASE_URL，以重定向页面请求到主服务器。 环境变量的具体使用方法详见此处。 ## 配置 系统本身开箱即用。 你可以通过设置环境变量或者命令行参数进行配置。 等到系统启动后，使用 root 用户登录系统并做进一步的配置。 ## 使用方式 在渠道页面中添加你的 API Key，之后在令牌页面中新增一个访问令牌。 之后就可以使用你的令牌访问 One API 了，使用方式与 OpenAI API 一致。 可以通过在令牌后面添加渠道 ID 的方式指定使用哪一个渠道处理本次请求，例如：Authorization: Bearer ONE_API_KEY-CHANNEL_ID。 注意，需要是管理员用户创建的令牌才能指定渠道 ID。 不加的话将会使用负载均衡的方式使用多个渠道。 ### 环境变量 1. REDIS_CONN_STRING：设置之后将使用 Redis 作为请求频率限制的存储，而非使用内存存储。 + 例子：REDIS_CONN_STRING=redis://default:redispw@localhost:49153 2. SESSION_SECRET：设置之后将使用固定的会话密钥，这样系统重新启动后已登录用户的 cookie 将依旧有效。 + 例子：SESSION_SECRET=random_string 3. SQL_DSN：设置之后将使用指定数据库而非 SQLite。 + 例子：SQL_DSN=root:123456@tcp(localhost:3306)/one-api 4. FRONTEND_BASE_URL：设置之后将使用指定的前端地址，而非后端地址。 + 例子：FRONTEND_BASE_URL=https://openai.justsong.cn 5. SYNC_FREQUENCY：设置之后将定期与数据库同步配置，单位为秒，未设置则不进行同步。 + 例子：SYNC_FREQUENCY=60 ### 命令行参数 1. --port <port_number>: 指定服务器监听的端口号，默认为 3000。 + 例子：--port 3000 2. --log-dir <log_dir>: 指定日志文件夹，如果没有设置，日志将不会被保存。 + 例子：--log-dir ./logs 3. --version: 打印系统版本号并退出。 4. --help: 查看命令的使用帮助和参数说明。 ## 演示 ### 在线演示 注意，该演示站不提供对外服务： https://openai.justsong.cn ### 截图展示 ## 常见问题 1. 账户额度足够为什么提示额度不足？ + 请检查你的令牌额度是否足够，这个和账户额度是分开的。 + 令牌额度仅供用户设置最大使用量，用户可自由设置。 2. 宝塔部署后访问出现空白页面？ + 自动配置的问题，详见#97。