G2rain(谷雨)开源智能体平台项目文档,由 g2rain-bootstrap 的
docs/architecture/runtime-flows.md 自动同步生成;正文保留来源仓库的技术表述与历史名称。当前定位:Bootstrap 是基于已发布镜像的快速启动与部署方案入口;配对的 g2rain-deploy 主要用于开发阶段部署、源码构建与跨模块联调。中央目录截至 2026-11-10 记录 Bootstrap 已通过 Shell / Compose 静态配置检查;默认资源档只用于最低资源验证,真实全栈运行、业务冒烟及备份恢复仍需在目标环境完成验收。
文档范围:项目技术说明。项目是否发布、架构采用登记和具体环境验收分别维护;本页中的计划、偏差、测试数及未完成项仅适用于其明确记录的事项和版本,不应概括为整个平台尚未实现。当前组件版本见版本与依赖,业务发布范围见业务模块目录。未提供关闭证据的问题仍需按责任项目跟踪。
# 运行流程
# 首次准备(init-once)
- 若不存在
.env,从.env.example复制;未传入--host/--port时退出,要求先修改再重跑。 - 从
.env读取PLATFORM_HOST/PLATFORM_PORT,替换config/mysql/g2rain-basis.sql中的__PLATFORM_HOST__、__PLATFORM_PORT__(须在空 MySQL 数据卷首次初始化前完成)。 - 若缺少
ssl/server.crt或ssl/server.key,调用config/generate-ssl.sh,主机名取自PLATFORM_HOST(默认localhost)。 - 成功后写入
.g2rain-bootstrap-init.done。
可独立执行 ./init-once.sh;start.sh 在缺少完成标记、仍有 SQL 占位符或缺少证书时也会自动调用。
# 启动
- 切换到仓库根目录;若需要首次准备则调用
init-once.sh。 - 加载
.env。 - 按
BUSINESS_EXTENSIONS与--business解析业务片段,合并主 Compose。 - 调用
pull.sh:GHCR 镜像经加速地址拉取并重新标记为原标签,其他镜像直接拉取。 - 执行
docker compose up -d --build --wait。 - 打印访客入口:
${PLATFORM_BASE_URL}/chat/。
# 更新
- 使用与启动相同的 Compose 合并参数。
- 再次调用
pull.sh。 - 执行
up -d --build --remove-orphans --wait。
更新前应备份 data/、当前 .env 与镜像 digest;升级后检查健康状态与 /chat/ 冒烟流程。未列入当前扩展集合的可选服务会被 --remove-orphans 移除。
# 停止
stop.sh 对同一合并栈执行 docker compose down,保留命名卷与绑定挂载的数据目录。扩展选择须与启动时一致。不要执行 docker compose down -v,除非明确要删除持久化数据。
# 与 deploy 的差异
本仓库提供轻量 init-once.sh(仅 .env、SQL 占位符与 SSL,不克隆源码、不构建业务镜像),没有源码 codes/ 同步、没有按服务名选择性启停,也没有 --cleanup 一类扩展清理参数。--business 为追加语义,不是 deploy 的“仅加载列出片段”。