one-API部署手册
官网地址:https://github.com/songquanpeng/one-api/
互联网服务器部署
服务器基础环境概况:docker环境、服务器可以访问外
部署步骤
下载镜像
docker pull justsong/one-api
创建空数据库
创建空数据库用于one-api数据存储,不用建表,one-api启动时会自动建表
数据库 mysql 8
数据库名:oneapi
启动容器
环境变量(-e):DEBUG=true,如果需要详细的日志信息时,设置为true,如果不需要,可以不进行配置
磁盘挂载(-v):日志文件可以在宿主机上保留,有问题时可以进行查看
docker run --name one-api -d --restart always \
-p 13000:3000\
-e SQL_DSN='用户名:密码@tcp(ip:端口)/oneapi'\
-e TZ=Asia/Shanghai\
-e DEBUG=true\
-v /root/one-api:/data\
justsong/one-api:v0.6.10
访问地址信息
访问地址:http://ip:13000/
账号密码:root/123456
登录成功后,需要修改密码
内网/局域网部署
服务器基础环境概况:docker环境
由于服务器为无法访问外网,无法下载镜像,所以需要准备下载好的镜像和词元编码文件
部署步骤
导出镜像
docker save -o one-api-v0.6.10.tar justsong/one-api:v0.6.10
导出镜像成功,上传镜像文件至云内服务目录:/data/soft/one-api
加载镜像
docker load -i one-api-v0.6.10.tar
离线词元编码下载上传
默认程序启动时会联网下载一些通用的词元的编码,如:gpt-3.5-turbo,在一些网络环境不稳定,或者离线情况,可能会导致启动有问题,可以配置此目录缓存数据,可迁移到离线环境。
下载:https://openaipublic.blob.core.windows.net/encodings/cl100k_base.tiktoken
下载成功后将cl100k_base.tiktoken改名为9b5ad71b2ce5302211f9c61530b329a4922fc6a4
下载:https://openaipublic.blob.core.windows.net/encodings/o200k_base.tiktoken
下载成功后将o200k_base.tiktoken改名为fb374d419588a4632f3f557e76b4b70aebbca790
上传改名的词元文件至服务器目录:/data/soft/one-api/tiktokens
创建空数据库
创建空数据库用于one-api数据存储,不用建表,one-api启动时会自动建表
数据库名:oneapi
启动容器
环境变量(-e):TIKTOKEN_CACHE_DIR=/tmp/data-gym-cache 配置此目录缓存词元编码数据,启动时不进行下载
磁盘挂载(-v):词元编码文件挂载:/data/soft/one-api/tiktokens:/tmp/data-gym-cache ;宿主机目录可自行修改
docker run --name one-api -d --restart always -p 13000:3000 \
-e SQL_DSN='账号:密码@tcp(ip:端口)/oneapi' \
-e TZ=Asia/Shanghai \
-e TIKTOKEN_CACHE_DIR=/tmp/data-gym-cache \
-v /root/one-api:/data \
-v /data/soft/one-api/tiktokens:/tmp/data-gym-cache \
justsong/one-api:v0.6.10
访问地址信息
访问地址:http://ip:13000/
账号密码:root/123456
登录成功后,需要修改密码
其他管理docker命令
# 停止容器
docker stop one-api
# 启动容器
docker start one-api
# 进入容器
docker exec -it one-api /bin/sh
应用如何调用one-api
one-API 以标准的OpenAI API提供服务,调用之前需要获得对应令牌,通过令牌进行调用,应用注意管理好自己的令牌,避免泄露
one-API使用手册
首先需要登录系统
渠道管理
- 点击渠道进入渠道管理功能页面
- 可以进行添加渠道、测试、删除、禁用、编辑操作
- 注意私有化部署的大模型服务,无秘钥,任意填写,不能为空
- 代理地址只需填写基本的ip端口即可
令牌管理
- 点击令牌进入令牌管理功能页面
- 可以进行添加渠道、复制、删除、禁用、编辑操作
- 提交好令牌,可发放给对应的应用,注意保密,避免泄露
日志管理
- 点击日志进入日志管理功能页面
- 可以查询对应的调用日志情况
其他功能
- 用户、充值功能:可先创建用户,用户进行充值或进行兑换获取调用额度,用户创建令牌才可有权限进行调用,不然会提示失败。
- 设置中可设置界面显示信息。
- 具体详细功能参见官网