中文 | English

Gin One API

✨ 用于 Gin & React 项目的模板 ✨

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

功能

• 内置用户管理
• 内置文件管理
• GitHub 开放授权
• 微信公众号授权（需要 wechat-server）
• 邮箱验证以及通过邮件进行密码重置
• 请求频率限制
• 静态文件缓存
• 移动端适配
• 基于令牌的鉴权
• 使用 GitHub Actions 自动打包可执行文件与 Docker 镜像
• Cloudflare Turnstile 用户校验

部署

手动部署

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。

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

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

配置

系统本身开箱即用。

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

等到系统启动后，使用 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: 打印系统版本号并退出。