ai-gateway/README.md

<p align="right">
   <strong>中文</strong> | <a href="./README.en.md">English</a>
</p>

<p align="center">
  <a href="https://github.com/songquanpeng/gin-template"><img src="https://raw.githubusercontent.com/songquanpeng/gin-template/main/web/public/logo.png" width="150" height="150" alt="gin-template logo"></a>
</p>

<div align="center">

# Gin 项目模板

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

</div>

<p align="center">
  <a href="https://raw.githubusercontent.com/songquanpeng/gin-template/main/LICENSE">
    <img src="https://img.shields.io/github/license/songquanpeng/gin-template?color=brightgreen" alt="license">
  </a>
  <a href="https://github.com/songquanpeng/gin-template/releases/latest">
    <img src="https://img.shields.io/github/v/release/songquanpeng/gin-template?color=brightgreen&include_prereleases" alt="release">
  </a>
  <a href="https://github.com/songquanpeng/gin-template/releases/latest">
    <img src="https://img.shields.io/github/downloads/songquanpeng/gin-template/total?color=brightgreen&include_prereleases" alt="release">
  </a>
  <a href="https://goreportcard.com/report/github.com/songquanpeng/gin-template">
    <img src="https://goreportcard.com/badge/github.com/songquanpeng/gin-template" alt="GoReportCard">
  </a>
</p>

<p align="center">
  <a href="https://github.com/songquanpeng/gin-template/releases">程序下载</a>
  ·
  <a href="https://github.com/songquanpeng/gin-template#部署">部署教程</a>
  ·
  <a href="https://github.com/songquanpeng/gin-template/issues">意见反馈</a>
  ·
  <a href="https://gin-template.vercel.app/">在线演示</a>
</p>

## 功能
+ [x] 内置用户管理
+ [x] 内置文件管理
+ [x] [GitHub 开放授权](https://github.com/settings/applications/new)
+ [x] 微信公众号授权（需要 [wechat-server](https://github.com/songquanpeng/wechat-server)）
+ [x] 邮箱验证以及通过邮件进行密码重置
+ [x] 请求频率限制
+ [x] 静态文件缓存
+ [x] 移动端适配
+ [x] 基于令牌的鉴权
+ [x] 使用 GitHub Actions 自动打包可执行文件与 Docker 镜像
+ [x] Cloudflare Turnstile 用户校验

## 部署
### 手动部署
1. 从 [GitHub Releases](https://github.com/songquanpeng/gin-template/releases/latest) 下载可执行文件或者从源码编译：
   ```shell
   git clone https://github.com/songquanpeng/gin-template.git
   go mod download
   go build -ldflags "-s -w" -o gin-template
   ````
2. 运行：
   ```shell
   chmod u+x gin-template
   ./gin-template --port 3000 --log-dir ./logs
   ```
3. 访问 [http://localhost:3000/](http://localhost:3000/) 并登录。初始账号用户名为 `root`，密码为 `123456`。

更加详细的部署教程[参见此处](https://iamazing.cn/page/how-to-deploy-a-website)。

### 基于 Docker 进行部署
执行：`docker run -d --restart always -p 3000:3000 -v /home/ubuntu/data/gin-template:/data -v /etc/ssl/certs:/etc/ssl/certs:ro justsong/gin-template`

数据将会保存在宿主机的 `/home/ubuntu/data/gin-template` 目录。

## 配置
系统本身开箱即用。

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

等到系统启动后，使用 `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)/gin-template`

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