https://github.com/songquanpeng/one-api/tree/main
基于 Docker 进行部署
初始账号用户名为 root，密码为 123456。
# 使用 SQLite 的部署命令：
docker run --name one-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api
# 使用 MySQL 的部署命令，在上面的基础上添加 `-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi"`，请自行修改数据库连接参数，不清楚如何修改请参见下面环境变量一节。
# 例如：
docker run --name one-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api其中，-p 3000:3000 中的第一个 3000 是宿主机的端口，可以根据需要进行修改。
数据和日志将会保存在宿主机的 /home/ubuntu/data/one-api 目录，请确保该目录存在且具有写入权限，或者更改为合适的目录。
如果启动失败，请添加 --privileged=true，具体参考 https://github.com/songquanpeng/one-api/issues/482 。
如果上面的镜像无法拉取，可以尝试使用 GitHub 的 Docker 镜像，将上面的 justsong/one-api 替换为 ghcr.io/songquanpeng/one-api 即可。
如果你的并发量较大，务必设置 SQL_DSN，详见下面环境变量一节。
更新命令：docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR
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;
proxy_read_timeout 300s; # GPT-4 需要较长的超时时间，请自行调整
}
}之后使用 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基于 Docker Compose 进行部署
仅启动方式不同，参数设置不变，请参考基于 Docker 部署部分
# 目前支持 MySQL 启动，数据存储在 ./data/mysql 文件夹内
docker-compose up -d
# 查看部署状态
docker-compose ps使用方法
在渠道页面中添加你的 API Key，之后在令牌页面中新增访问令牌。
之后就可以使用你的令牌访问 One API 了，使用方式与 OpenAI API 一致。
你需要在各种用到 OpenAI API 的地方设置 API Base 为你的 One API 的部署地址，例如：https://openai.justsong.cn，API Key 则为你在 One API 中生成的令牌。
注意，具体的 API Base 的格式取决于你所使用的客户端。
例如对于 OpenAI 的官方库：
OPENAI_API_KEY="sk-xxxxxx"
OPENAI_API_BASE="https://<HOST>:<PORT>/v1"graph LR
A(用户)
A --->|使用 One API 分发的 key 进行请求| B(One API)
B -->|中继请求| C(OpenAI)
B -->|中继请求| D(Azure)
B -->|中继请求| E(其他 OpenAI API 格式下游渠道)
B -->|中继并修改请求体和返回体| F(非 OpenAI API 格式下游渠道)可以通过在令牌后面添加渠道 ID 的方式指定使用哪一个渠道处理本次请求，例如：Authorization: Bearer ONE_API_KEY-CHANNEL_ID。
注意，需要是管理员用户创建的令牌才能指定渠道 ID。
不加的话将会使用负载均衡的方式使用多个渠道。
环境变量
One API 支持从.env文件中读取环境变量，请参照.env.example文件，使用时请将其重命名为.env。
REDIS_CONN_STRING：设置之后将使用 Redis 作为缓存使用。- 例子：
REDIS_CONN_STRING=redis://default:redispw@localhost:49153 - 如果数据库访问延迟很低，没有必要启用 Redis，启用后反而会出现数据滞后的问题。
如果需要使用哨兵或者集群模式：
- 则需要把该环境变量设置为节点列表，例如：
localhost:49153,localhost:49154,localhost:49155。 除此之外还需要设置以下环境变量：
REDIS_PASSWORD：Redis 集群或者哨兵模式下的密码设置。REDIS_MASTER_NAME：Redis 哨兵模式下主节点的名称。
- 则需要把该环境变量设置为节点列表，例如：
- 例子：
SESSION_SECRET：设置之后将使用固定的会话密钥，这样系统重新启动后已登录用户的 cookie 将依旧有效。- 例子：
SESSION_SECRET=random_string
- 例子：
SQL_DSN：设置之后将使用指定数据库而非 SQLite，请使用 MySQL 或 PostgreSQL。例子：
- MySQL：
SQL_DSN=root:123456@tcp(localhost:3306)/oneapi - PostgreSQL：
SQL_DSN=postgres://postgres:123456@localhost:5432/oneapi（适配中，欢迎反馈）
- MySQL：
- 注意需要提前建立数据库
oneapi，无需手动建表，程序将自动建表。 - 如果使用本地数据库：部署命令可添加
--network="host"以使得容器内的程序可以访问到宿主机上的 MySQL。 - 如果使用云数据库：如果云服务器需要验证身份，需要在连接参数中添加
?tls=skip-verify。 请根据你的数据库配置修改下列参数（或者保持默认值）：
SQL_MAX_IDLE_CONNS：最大空闲连接数，默认为100。SQL_MAX_OPEN_CONNS：最大打开连接数，默认为1000。- 如果报错
Error 1040: Too many connections，请适当减小该值。
- 如果报错
SQL_CONN_MAX_LIFETIME：连接的最大生命周期，默认为60，单位分钟。
LOG_SQL_DSN：设置之后将为logs表使用独立的数据库，请使用 MySQL 或 PostgreSQL。FRONTEND_BASE_URL：设置之后将重定向页面请求到指定的地址，仅限从服务器设置。- 例子：
FRONTEND_BASE_URL=https://openai.justsong.cn
- 例子：
MEMORY_CACHE_ENABLED：启用内存缓存，会导致用户额度的更新存在一定的延迟，可选值为true和false，未设置则默认为false。- 例子：
MEMORY_CACHE_ENABLED=true
- 例子：
SYNC_FREQUENCY：在启用缓存的情况下与数据库同步配置的频率，单位为秒，默认为600秒。- 例子：
SYNC_FREQUENCY=60
- 例子：
NODE_TYPE：设置之后将指定节点类型，可选值为master和slave，未设置则默认为master。- 例子：
NODE_TYPE=slave
- 例子：
CHANNEL_UPDATE_FREQUENCY：设置之后将定期更新渠道余额，单位为分钟，未设置则不进行更新。- 例子：
CHANNEL_UPDATE_FREQUENCY=1440
- 例子：
CHANNEL_TEST_FREQUENCY：设置之后将定期检查渠道，单位为分钟，未设置则不进行检查。
+例子：CHANNEL_TEST_FREQUENCY=1440POLLING_INTERVAL：批量更新渠道余额以及测试可用性时的请求间隔，单位为秒，默认无间隔。- 例子：
POLLING_INTERVAL=5
- 例子：
BATCH_UPDATE_ENABLED：启用数据库批量更新聚合，会导致用户额度的更新存在一定的延迟可选值为true和false，未设置则默认为false。- 例子：
BATCH_UPDATE_ENABLED=true - 如果你遇到了数据库连接数过多的问题，可以尝试启用该选项。
- 例子：
BATCH_UPDATE_INTERVAL=5：批量更新聚合的时间间隔，单位为秒，默认为5。- 例子：
BATCH_UPDATE_INTERVAL=5
- 例子：
请求频率限制：
GLOBAL_API_RATE_LIMIT：全局 API 速率限制（除中继请求外），单 ip 三分钟内的最大请求数，默认为180。GLOBAL_WEB_RATE_LIMIT：全局 Web 速率限制，单 ip 三分钟内的最大请求数，默认为60。
编码器缓存设置：
TIKTOKEN_CACHE_DIR：默认程序启动时会联网下载一些通用的词元的编码，如：gpt-3.5-turbo，在一些网络环境不稳定，或者离线情况，可能会导致启动有问题，可以配置此目录缓存数据，可迁移到离线环境。DATA_GYM_CACHE_DIR：目前该配置作用与TIKTOKEN_CACHE_DIR一致，但是优先级没有它高。
RELAY_TIMEOUT：中继超时设置，单位为秒，默认不设置超时时间。RELAY_PROXY：设置后使用该代理来请求 API。USER_CONTENT_REQUEST_TIMEOUT：用户上传内容下载超时时间，单位为秒。USER_CONTENT_REQUEST_PROXY：设置后使用该代理来请求用户上传的内容，例如图片。SQLITE_BUSY_TIMEOUT：SQLite 锁等待超时设置，单位为毫秒，默认3000。GEMINI_SAFETY_SETTING：Gemini 的安全设置，默认BLOCK_NONE。GEMINI_VERSION：One API 所使用的 Gemini 版本，默认为v1。THEME：系统的主题设置，默认为default，具体可选值参考此处。ENABLE_METRIC：是否根据请求成功率禁用渠道，默认不开启，可选值为true和false。METRIC_QUEUE_SIZE：请求成功率统计队列大小，默认为10。METRIC_SUCCESS_RATE_THRESHOLD：请求成功率阈值，默认为0.8。INITIAL_ROOT_TOKEN：如果设置了该值，则在系统首次启动时会自动创建一个值为该环境变量值的 root 用户令牌。INITIAL_ROOT_ACCESS_TOKEN：如果设置了该值，则在系统首次启动时会自动创建一个值为该环境变量的 root 用户创建系统管理令牌。ENFORCE_INCLUDE_USAGE：是否强制在 stream 模型下返回 usage，默认不开启，可选值为true和false。TEST_PROMPT：测试模型时的用户 prompt，默认为Print your model name exactly and do not output without any other text.。
命令行参数
--port <port_number>: 指定服务器监听的端口号，默认为3000。- 例子：
--port 3000
- 例子：
--log-dir <log_dir>: 指定日志文件夹，如果没有设置，默认保存至工作目录的logs文件夹下。- 例子：
--log-dir ./logs
- 例子：
--version: 打印系统版本号并退出。--help: 查看命令的使用帮助和参数说明。
