.github/workflows | ||
common | ||
controller | ||
middleware | ||
model | ||
router | ||
web | ||
.gitignore | ||
Dockerfile | ||
go.mod | ||
go.sum | ||
LICENSE | ||
main.go | ||
README.md |
One API
✨ All in one 的 OpenAI 接口,整合各种 API 访问方式,开箱即用✨
功能
- 多种 API 访问方式:
- One API 服务端中继
- API2D
- 聚合多种 API 访问方式,通过负载均衡的方式进行访问。
- 单个访问渠道支持设置多个 API Key,利用起来你的多个 API Key。
- 多种用户登录注册方式:
- 邮箱登录注册以及通过邮箱进行密码重置。
- GitHub 开放授权。
- 微信公众号授权(需要额外部署 WeChat Server)。
- 支持用户管理。
部署
基于 Docker 进行部署
执行:docker run -d --restart always -p 3000:3000 -v /home/ubuntu/data/one-api:/data -v /etc/ssl/certs:/etc/ssl/certs:ro justsong/one-api
数据将会保存在宿主机的 /home/ubuntu/data/one-api
目录。
手动部署
- 从 GitHub Releases 下载可执行文件或者从源码编译:
git clone https://github.com/songquanpeng/one-api.git go mod download go build -ldflags "-s -w" -o one-api
- 运行:
chmod u+x one-api ./one-api --port 3000 --log-dir ./logs
- 访问 http://localhost:3000/ 并登录。初始账号用户名为
root
,密码为123456
。
更加详细的部署教程参见此处。
配置
系统本身开箱即用。
你可以通过设置环境变量或者命令行参数进行配置。
等到系统启动后,使用 root
用户登录系统并做进一步的配置。
环境变量
REDIS_CONN_STRING
:设置之后将使用 Redis 作为请求频率限制的存储,而非使用内存存储。- 例子:
REDIS_CONN_STRING=redis://default:redispw@localhost:49153
- 例子:
SESSION_SECRET
:设置之后将使用固定的会话密钥,这样系统重新启动后已登录用户的 cookie 将依旧有效。- 例子:
SESSION_SECRET=random_string
- 例子:
SQL_DSN
:设置之后将使用指定数据库而非 SQLite。- 例子:
SQL_DSN=root:123456@tcp(localhost:3306)/one-api
- 例子:
命令行参数
--port <port_number>
: 指定服务器监听的端口号,默认为3000
。- 例子:
--port 3000
- 例子:
--log-dir <log_dir>
: 指定日志文件夹,如果没有设置,日志将不会被保存。- 例子:
--log-dir ./logs
- 例子:
--version
: 打印系统版本号并退出。