CliRelay

环境要求

• Go 1.26 运行时（使用官方镜像时无需本地安装）
• Docker 与 Docker Compose（推荐安装方式，Compose 栈含 PostgreSQL 15、Redis 7、updater sidecar）
• PostgreSQL 15+ 与 Redis 7+（运行时依赖，Compose 已内置）
• 可选：S3 兼容对象存储 / Git 仓库（用于非本地配置与鉴权持久化）

安装与启动步骤

1. 1克隆仓库

   从 GitHub 拉取 CliRelay 源码到本地任意目录。

   git clone https://github.com/kittors/CliRelay.git

   复制

2. 2进入项目目录

   后续所有命令都在该目录内执行。

   cd CliRelay

   复制

3. 3按需预置 .env

   .env 可选：首次启动时 clirelay-init 会自动生成缺失密钥并保留已有非空值。生产环境想固定自己的密钥或绑定路径时再手动创建。

4. 4启动 Compose 栈

   首次执行会拉起 clirelay-init、PostgreSQL、Redis、应用容器和 updater sidecar，并自动从 config.example.yaml 生成 config.yaml。

   docker compose up -d

   复制

5. 5检查启动状态

   确认各容器处于运行状态且应用通过健康检查，再进入管理面板使用。

   docker compose ps

   复制

关键配置

如何确认成功

执行 docker compose ps 确认 clirelay-init、PostgreSQL、Redis、应用与 updater 容器均已运行，且应用容器通过健康检查，即可打开 /manage 管理面板。

常见问题

注意事项

• 首次启动会自动生成密钥与 config.yaml，请勿把生成的 .env 提交到版本库。
• PostgreSQL 是唯一业务数据源，Redis 只承载缓存、锁、限流、队列等可重建状态。
• 关闭正文存储会清除历史输入输出正文，但保留请求详情与请求记录。
• 大流量部署建议调整 config.yaml 中 request-log-storage 相关参数，完整正文默认保留30天且上限约1GB。