ai-gateway/README.md
2023-04-22 22:29:00 +08:00

3.9 KiB
Raw Blame History

one-api logo

One API

All in one 的 OpenAI 接口,整合各种 API 访问方式,开箱即用

license release release GoReportCard

程序下载 · 部署教程 · 意见反馈 · 在线演示

功能

  1. 多种 API 访问方式:
    • One API 服务端中继
    • API2D
  2. 聚合多种 API 访问方式,通过负载均衡的方式进行访问。
  3. 单个访问渠道支持设置多个 API Key利用起来你的多个 API Key。
  4. 多种用户登录注册方式:
  5. 支持用户管理。

部署

基于 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 目录。

手动部署

  1. GitHub Releases 下载可执行文件或者从源码编译:
    git clone https://github.com/songquanpeng/one-api.git
    go mod download
    go build -ldflags "-s -w" -o one-api
    
  2. 运行:
    chmod u+x one-api
    ./one-api --port 3000 --log-dir ./logs
    
  3. 访问 http://localhost:3000/ 并登录。初始账号用户名为 root,密码为 123456

更加详细的部署教程参见此处

配置

系统本身开箱即用。

你可以通过设置环境变量或者命令行参数进行配置。

等到系统启动后,使用 root 用户登录系统并做进一步的配置。

环境变量

  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

命令行参数

  1. --port <port_number>: 指定服务器监听的端口号,默认为 3000
    • 例子:--port 3000
  2. --log-dir <log_dir>: 指定日志文件夹,如果没有设置,日志将不会被保存。
    • 例子:--log-dir ./logs
  3. --version: 打印系统版本号并退出。