Files
OpenFlare/docs/design/index.md
T
ryan dbaa3bf140 feat(cordis): add OpenFlare Cordis 架构改造设计
docs(changelog): 修正表述笔误

refactor(cordis): 磁盘缓存改用上上游能力并清理本地副本

按上游/下游归属规约:类型断言守卫已回流 Wavelet(f3d85d5,附回归用例),
本仓库删除 OpenFlare/plugins/server/pkg/cache 整包并改 import 到
Wavelet/pkg/cache/disk,同步后与上游零漂移。

验证:go build 通过;go test ./... exit 0(137 包 ok);256 条路由对拍与
232 条 swagger 操作均零差异;make build-all 四进制;前端零改动。

docs(cordis): 记录 T1 清理结果与五个复用阻塞点

refactor(cordis): server 复用上游 pkg 能力并删除等价本地副本

按上游/下游归属规约清理重复实现,删除 7 个与上游等价的本地包并改 import:
shared/response→pkg/response、pkg/{logger,mail,trace,httppool,cache/ram}→
上游同名包、infra/persistence/batchwriter→pkg/batchwriter。逐项核过差异:
httppool 逐字节相同;logger 的 Config 字段完全一致;response 的 7 个 Abort*
一致;cache/ram 换过去顺带把裸 go 变回带 panic 恢复的 util.Go。

两处非等价差异按语义处理:
- batchwriter.Stats 与 status DTO 原为类型别名,改为消费侧逐字段转换,
  避免 model 反向依赖基础设施类型;
- 上游 pkg/idgen 要求显式 Init(本地副本为懒加载自动初始化),本次保留本地
  副本,待与 infra 初始化一并迁移(已登记在清理计划)。

验证:go build 通过;go test ./... exit 0(138 包 ok);256 条路由对拍零差异;
make swagger 232 条操作零增减,且归一化后与旧文档深度相等——差异仅为
response.Any / logger.LogEntry 两个定义名随包路径改名,接口形状未变。

chore(cordis): 回流内核与 pkg/util 通用能力并清理 vendoring 污染

按新增的上游/下游归属规约:HandleRaw/BasePath 与版本比较、网络、格式化助手
属通用能力,已提交到 Wavelet 分支 feat/cordis-router-raw-routes,本仓库改为
纯同步获取(pkg/util 已零漂移),补丁登记保留至上游合并。

同时修掉我此前 git add -A 造成的污染:首次 vendoring 把上游工作区里被
gitignore 的运行期产物一起提交进来(upload 的 diskcache 缓存块 650 个与
driver_http/dist 前端构建物 380 个,共 12872 行/1030 文件)。sync-upstream.sh
现显式排除 uploads/dist/data/*.db,.gitignore 补上对应兜底规则。

AGENTS.md 增加上游/下游改动归属规约,并把仍指向前 Cordis 布局的硬性约束
(internal/router + Serve、internal/repository/logstore、internal/platform/bootstrap、
internal/cmd)改到当前插件路径。

验证:go build 通过;go test ./... exit 0(144 包 ok);make swagger 232 条
操作与基线逐条一致;make build-all 四进制;gofmt 干净。

feat(cordis): server 插件化并改由内核挂载控制面路由

新增 plugins/server/plugin.go:Apply 以 ctx.Router().Group(app.api_prefix)
声明根级与 /v1 全部路由;33 个注册函数由 *gin.RouterGroup 改为
core.RouterExtension,RegisterCollection 改用内核新增的 HandleRaw 保留
尾部斜杠变体,AdminMiddlewares 返回 []any(Go 不允许把 []T 展开为 ...any)。
删除 router.Serve 与 registerRoutes,装配根改为 core.App +
driver_http.New(WithEngine(router.BuildEngine())),监听、信号与优雅退出归内核;
前端 SPA 的 NoRoute 兜底因内核暂无贡献点而保留在引擎层。

路由保真证据:plugin_parity_test 对拍 baseline/routes-engine.txt 的 256 条
(方法 路径) 零差异;go test ./... exit 0(144 包 ok,含真实 handler 的
openflare/integration 用例走同一条挂载路径);make swagger 232 条操作与基线
逐条一致;golangci-lint 0 issues;make build-all 四进制;embed_frontend
标签编译通过;前端零改动。

已知待补:带 Redis 的实机 HTTP 冒烟(本机 6379 未启动,session store 与
改造前一样在建店阶段即 fatal),以及 bootstrap 的任务/设置/迁移注册迁入 Apply。

feat(core): RouterExtension 增加 HandleRaw 与 BasePath 以保真尾部斜杠路由

server 插件化的前置:Handle 经 cleanPath 会剥掉尾部斜杠,无法表达
/resource 与 /resource/ 两条不同路由,而 OpenFlare 有 20 个历史 list
端点两者都注册且部署关闭了 RedirectTrailingSlash,缺失即 404。新增
HandleRaw 与 BasePath(作用域包装器同样登记反注册),补 extpoints 用例;
并把 router.Serve 拆出 BuildEngine 以便交给 driver_http.WithEngine 复用,
新增路由表导出 harness,固化 256 条 (方法 路径) 基线供插件化对拍。
上游补丁登记于 backend/OpenFlare/upstream-patches.md,同步脚本改为按目录
前缀输出差异并在同步后提醒确认补丁是否仍在。

验证:go build 通过;go test ./... exit 0(143 包 ok);gofmt 干净。

docs(cordis): 记录 server 插件接入内核的可行路径与内核能力缺口

feat(cordis): agent/relay/flared 落地为内核驱动插件

三个边缘守护进程各新增 plugin.go,实现 core.Plugin + core.Driver
(自定义 DriverType 与同名 profile),装配与生命周期从 main 迁入
Apply/Start/Stop:Apply 负责 JSON 配置加载、运行环境与用户确保、
openresty/frps/frpc 管理器与各服务装配;Start 以 util.Go 拉起阻塞式
runner 与 GeoIP 周期更新;Stop 收敛主循环结果并在超时时报错而非静默。

入口改为 core.NewApp(core.WithProfile(...)) + Prepare/Run,保持
-config 旗标、默认路径、退出码与启动/停止日志不变。

验证:go build 通过;go test ./... exit 0(143 包 ok,含 3 个插件身份
与配置失败路径测试);make build-all 四进制产出;三进制实跑缺失配置
均 exit 1 且错误链保留 load {agent,relay,flared} config 原因;gofmt 干净。

refactor(cordis): 按功能职责拆分为 4 个插件与 share 共享层

backend/OpenFlare 不再平铺遗留分层,改为 plugins/{server,agent,relay,flared}
加 share/:控制面业务(openflare/admin/oauth/user/upload/cap/config/health 与
repository/model/infra/router 等支撑层)归 server;三个边缘守护进程各自成插件;
被两个以上插件消费的 protocol/geoip/wsclient/render/pagesarchive/edge 归 share。
同时把 pkg/util 与 buildinfo 合并回上游 pkg(上游已覆盖全部符号,仅 8 个函数与
2 个类型为 OpenFlare 独有,已一并迁入),装配根统一到 backend/cmd(含三个 daemon
入口),Dockerfile 与 release 工作流的构建路径和 -X 注入路径同步更新。

验证:go build 通过;go test ./... exit 0(141 包 ok);make swagger exit 0 且
232 条 API 操作与基线逐条一致;make build-all 产出 4 进制;-X 注入经二进制
strings 实测生效;日志后端直连门禁改写为按 server 插件业务域扫描并在扫描数为 0
时报错(防门禁静默失效);前端零改动。

feat(cordis): 落地 backend/share 共享层与上游同步脚本

跨插件共享资源(控制消息协议、GeoIP+iputil、边缘守护进程日志)从下游包
移入 backend/share,并声明其只能依赖 core/pkg 与标准/第三方库,禁止反向
引用下游业务与具体插件实现;新增 scripts/sync-upstream.sh 只覆盖
backend/{core,pkg,plugins},同步后 --check 报告零差异,证明与上游逐字一致。

go build 通过,go test ./... exit 0(142 包 ok),前端零改动。

refactor(cordis): 采用与 Wavelet 同构的单模块布局并引入上游内核

按上游结构落位:backend/{core,pkg,plugins} 为 Wavelet 上游拷贝,OpenFlare
全部业务收拢到上游 downstream 所对应的位置 backend/OpenFlare/,模块名保持
Wavelet 以保证上游 import 路径逐字一致、同步零改写;三个 daemon 入口移至
backend/OpenFlare/cmd,backend/cmd 与 main.go 作为控制面装配根。

行为不变:go build 通过,142 个测试包全绿(含上游插件测试),232 条 API
操作与改造前逐条一致,四进制产物正常,前端零改动。swagger 暂只扫描下游代码,
待 P4 挂载上游路由后再纳入 plugins/。

style: 修正模块路径改写导致的 import 分组排序漂移

refactor(layout): Go 代码迁入 backend/ 并将模块名简化为 OpenFlare

对齐上游 Wavelet 的仓库布局,为以第二 module 形态 vendoring Cordis 内核与
平台插件做准备:模块路径整体改写为 OpenFlare,Go 目标加 cd backend,
swaggo 产物移至 backend/docs 并把 json/yaml 复制回 docs/ 供站点消费,
Dockerfile 与 release 工作流的构建目录、ldflags 模块路径同步更新。

行为保持不变:232 条路由与改造前逐条一致,95 个测试包全绿,
四进制产物正常,前端零改动。

chore(cordis): 落地改造计划与 schema/路由基线

新增 legacy_dump_test 迁移快照 harness:在临时 sqlite 库上按生产顺序
(goose.UpTo → zone 导入 → goose.Up)跑完 76 个历史迁移并导出 schema 与
版本序列,作为改造前后一致性门禁的唯一事实来源。同时记录 232 条路由清单
与 foundation 实施计划。

docs(cordis): add OpenFlare Cordis 架构改造设计

明确上游以第二 module 形态 vendoring 进 backend/Wavelet、4 个插件
(server/agent/relay/flared) 全部装载内核,并规定保留 76 个历史 goose
迁移 + 一次性版本 stamp 桥接的迁移方案,配套三方 schema 一致性门禁,
确保已部署库不重跑历史、不丢数据。
2026-08-30 10:12:52 +08:00

16 KiB
Raw Blame History

产品边界

你会学到:OpenFlare 是什么、当前稳定能力,以及开发时应遵守的核心产品边界与仓库结构目录分工。

OpenFlare 是一套自托管的 OpenResty 控制面,面向单团队或单组织内部运维场景。


项目定位

OpenFlare 适合需要统一管理多台 OpenResty 代理节点的团队,具备以下定位:

  • 控制与落地分离:Server 控制面不直接 SSH 到代理节点,而是通过 Agent 主动拉取版本并应用。
  • 不可变配置发布:采用完整的配置版本进行预览、发布、激活和一键回滚。
  • 一体化网关托管:在同一个控制面内集成网站反代、TLS 证书自动续期申请、WAF 防护拦截、内网穿透(Tunnel)以及 Pages 静态网站托管。

非本产品定位:多租户云平台、Kubernetes Ingress Controller、服务网格或通用日志平台。


当前能力

能力 说明 详细设计/使用指南
反代配置管理 以网站规则(Proxy Route)为聚合边界,支持多域名与多上游负载均衡 新建反代配置
源站错误页 全局可配置:源站/网关匹配状态码时返回 OpenFlare 默认或自定义 HTML,HTTP 状态码保持原值 源站错误页设计
边缘缓存 单节点 OpenResty proxy_cache;默认 static 扩展名 + 源站头/Set-Cookie 闸门 + 默认 Edge TTL(对标 CF 默认模型) 边缘缓存策略设计
Zone 与域名管理 以可注册根域为管理入口,聚合明确域名、域名证书与反代路由 Zone 与域名资源设计
Cloudflare DNS 指向 以 ZoneDomain 为粒度,将单条 Cloudflare A 记录幂等指向边缘节点 IPv4;支持连接配置、分组、成员橙云与异步同步,一期不含自动故障切换 Cloudflare DNS 指向设计
配置版本控制 支持全局单一激活版本的预览、发布、不可变快照历史与秒级一键回滚 Agent 与发布模型
WAF 安全防护 支持可视化 DAG 编排规则、手动/自动/订阅型 IP 组、GeoIP 匹配与 PoW CC 防护 WAF 设计 / WAF 可编排规则设计 / WAF 使用指南
内网穿透 通过中继节点(Relay)与内网客户端(OpenFlared),反向穿透暴露内网 Web 服务 内网穿透设计 / 穿透使用指南
Pages 静态托管 支持上传或从 Remote URL、公开 GitHub Release 同步预构建产物;GitHub latest 可定时检查并可选自动发布。不可变部署由边缘节点拉取并由 OpenResty 本地服务,支持回滚、API 反代与 SPA Fallback Pages 静态托管设计 / Pages 使用指南
TLS 证书自动续期 将证书显式绑定到 Zone 域名,并通过 ACME 协议向 Let's Encrypt 申请/续期证书 Zone 与域名资源设计
多节点监控与观测 访问日志为业务流量唯一真相;Agent 只上报明细与主机读数,Server 统一聚合;与 Zone/看板对账 观测数据传输模型 / 边缘可观测与业务流量统计 / 上报协议与表结构 / 系统架构
日志存储 访问日志与可观测时序走可切换日志主库(随业务主库或 ClickHouse);关闭 ClickHouse 后仍可写可查 日志存储解耦
控制台双语 无 URL 前缀的 zh-CN / en,cookie NEXT_LOCALE 优先,兼容静态导出 前端 i18n 设计

核心产品边界与约束

在开发与贡献代码时,必须严格遵守以下业务边界与技术约束,禁止为了临时需求而绕过限制:

1. 网站配置与上游约束

  • 单站点域名共享策略:一条路由规则对应一个网站,该站点下的多域名共享限流、缓存与反代上游等配置,不支持在同一规则内为不同域名做差异化服务配置。
  • 上游类型互斥:上游必须是直连地址(direct)、内网穿透(tunnel)或 Pages 静态托管(pages)三者之一,不允许在同一规则中混用。
  • 直连类型限制:直连上游可以是纯 http:// 或 https:// 的单个或多个地址(多地址仅支持纯 scheme://host[:port]),不支持非 HTTP 协议(如 TCP/UDP)上游。

2. WAF 安全边界

  • 白名单优先原则:白名单拥有绝对匹配权。若未命中白名单规则,才依次触发全局和自定义黑名单过滤。
  • GeoIP 弱依赖性:地域准入解析完全依赖节点本地 MaxMind 库。当 GeoIP 异常或解析失败时,系统必须自动忽略地域规则,绝对不能破坏 IP 组过滤和反代主链路的可用性。
  • 运行时数据解耦:OpenResty 拦截时仅读取 Agent 同步至本地的 JSON,不与 Server 数据库通信。IP 组成员同步与版本发布解耦,通过 Checksum 差分拉取以实现零重载平滑生效。

3. 内网穿透边界

  • 仅限 HTTP 流量:穿透组件仅支持 HTTP/HTTPS 协议(底层依靠 frp 虚拟主机 Vhost 机制实现单端口域名路由复用),暂不支持单独的 TCP/UDP 端口分配。
  • 中继配置动态化控制:中继节点(Relay)在连接至 Server 后,可通过心跳周期性动态拉取并同步全局系统配置(例如是否开启内嵌 FRPS Web UI 及其监听端口),但不直接纳入控制面的不可变配置版本发布体系。
  • Tunnel 与 Node 体系隔离:Tunnel 客户端在内网发起出向建连,与控制面托管的边缘 Node(公网节点)是独立的实体,使用专属的 tunnel_token 进行鉴权。

4. Pages 静态托管边界

  • 预构建产物来源:项目可保持手动上传,或配置一个 Remote URL / 公开 GitHub Release asset 来源。Remote 与固定 tag 只支持手动操作;只有 GitHub latest 进入定时检查并可选择自动更新。来源可切换,但不可变 deployment 与当前生产版本不会随 source 编辑或删除而丢失。
  • 归档与资源上限:支持 zip、tar.gz / tgz、tar.xz / txz、tar.bz2 / tbz2、tar、7z。压缩包上限由 pages_max_package_size_mb 控制(默认 100 MiB,范围 1~2048);展开后的单文件和总量上限为包上限的 4 倍且最低 100 MiB,最多 1,000 个常规文件。Server 与 Agent 都校验实际字节,并拒绝路径逃逸、软/硬链接与特殊文件。
  • 构建与运行时边界:当前不从外部 Git 仓库拉取源码或执行构建,也不提供边缘 Serverless、动态 SSR 或二级预览域名。未来仓库集成必须使用独立 git_repository Provider 与 Server 侧隔离 build executor,只向统一 artifact 管线输出受限产物;Agent 不接收仓库凭据、外部 URL 或 clone/install/build 命令。

5. 系统与版本边界

  • 全局单一激活版本:所有节点拉取并消费同一份全局激活配置。不进行按节点分组的差异化配置发布。
  • 单租户架构:OpenFlare 仅供单团队在受信任的内部网络部署使用。采用单租户设计,不支持细粒度的多用户角色或多租户资源隔离。
  • 外部基础设施依赖性:Server 必须依赖外部 Redis(或 Valkey),用于分布式协调、Asynq 队列与系统缓存。关系库为 PostgreSQL,或关闭 database.enabled 时使用 SQLite。ClickHouse 可选:不启用时,访问日志与可观测时序由当前日志主库(随业务主库)承接;启用后可通过「切换日志数据库」任务迁到 ClickHouse。系统不支持脱离 Redis 运行。详情见 日志存储解耦。

仓库结构

OpenFlare 已收敛为单 monorepo(Go 模块 OpenFlare)。控制面 Server 与边缘组件(Agent、Relay、OpenFlared)共享同一仓库,业务代码按 Wavelet internal/apps/ 领域模块组织。

在贡献代码时,请严格遵守以下物理分层与目录分工:

路径 职责
main.go Server 唯一入口,委派给 internal/cmd/
cmd/agent、cmd/relay、cmd/flared 边缘组件 CLI 入口(不含 Server)
internal/ 控制面与边缘运行时实现
frontend/ Next.js 管理端,构建产物嵌入 Go Server
pkg/ 跨组件共享库(协议、渲染、GeoIP 等)
scripts/ Swagger 生成、安装脚本等
docs/ VitePress 文档站与设计基线
docker/ 各组件 Dockerfile
uploads/、data/ 运行时上传目录与静态数据(.gitignore 忽略)

1. Server 分层(main.go + internal/)

目录 职责
main.go Server 启动入口
internal/cmd/ Cobra 子命令:api、worker、scheduler、all(默认融合模式)
internal/platform/bootstrap/ 跨模块装配:任务 Handler、推送域事件、进程级初始化
internal/router/ HTTP 路由注册与全局中间件
internal/router/v1/openflare/ OpenFlare 路由注册器(register_*.go)
internal/apps/openflare/ OpenFlare 控制面业务域(routers.go + logics.go)
internal/apps/{admin,user,oauth,upload,cap,...}/ Wavelet 平台能力(用户、认证、任务、推送等)
internal/apps/openflare/{agent,relay,flared}/ Server 侧边缘协议处理器(鉴权、心跳、WS)
internal/model/ GORM 实体 / DTO / 无 IO 领域规则(openflare_*.go + 平台模型);不含 DB 访问
internal/infra/persistence/migrator/goose/ goose SQL 迁移(PostgreSQL / SQLite / ClickHouse)
internal/repository/ 数据访问层(平台 + OpenFlare 业务 CRUD、缓存、logstore 日志读写);唯一持久化入口
internal/infra/task/ Asynq 异步任务(Worker + Scheduler)
internal/infra/config/ Viper 配置加载
internal/shared/ 统一 API 响应封装(response/)
pkg/protocol/ Relay / Tunnel 共享 HTTP/WS 协议结构
pkg/render/、pkg/geoip/、pkg/wsclient/ OpenResty 配置渲染、GeoIP、WebSocket 客户端

API 路由前缀:

前缀 用途 鉴权
/api/v1/d/* OpenFlare 管理控制台 API Session Cookie + 可选 X-Access-Token
/api/v1/agent/* Agent 节点协议 X-Agent-Token
/api/v1/relay/* Relay 中继协议 X-Agent-Token
/api/v1/tunnel/* Tunnel 客户端协议 X-Tunnel-Token
/api/v1/admin/* Wavelet 平台管理 API 管理员 Session

2. Agent 模块 (internal/apps/agent/ / cmd/agent/)

目录/模块 职责
cmd/agent/ Agent 命令行启动入口及主函数
internal/apps/agent/config/ 配置读取与默认值
internal/apps/agent/heartbeat/ 心跳与版本摘要判断
internal/apps/agent/sync/ 配置拉取与应用编排
internal/apps/agent/nginx/ OpenResty 文件写入、校验、reload、启动与回滚
internal/apps/agent/state/ 本地状态与观测补报缓冲
internal/apps/agent/httpclient/ Server 通信
internal/apps/agent/wsclient/ WebSocket 客户端通信
internal/apps/agent/protocol/ Agent API 协议类型
internal/apps/agent/updater/ Agent 自更新逻辑
internal/apps/agent/logging/ 日志处理
internal/apps/agent/observability/ 可观测性(指标、链路等)
internal/apps/agent/geoipdata/ GeoIP 数据处理
internal/apps/agent/geoipupdate/ GeoIP 数据更新
internal/apps/agent/agent/ 核心 Agent 逻辑与生命周期

3. Frontend 分层 (frontend/)

基于 Wavelet Next.js 脚手架,OpenFlare 业务 UI 以路由共置方式组织在 app/(main)/ 下。

目录 职责
app/ Next.js App Router;(main) 控制台、(auth) 认证、(docs) 文档页
app/(main)/<domain>/ 业务页面与域内组件(路由共置)
components/ 跨域复用 UI(ui/、layout/、common/ 等)
lib/services/ API 服务层:core/ 基类 + openflare/ 业务 API
lib/navigation/ OpenFlare 侧栏导航配置(openflare-nav.ts)
lib/theme/ 主题解析与切换
contexts/ 跨页面 UI 状态(用户、通知等)
hooks/、lib/hooks/ 可复用 React Hooks
public/ 静态资源与主题 CSS
scripts/ 构建辅助脚本
proxy.ts 开发/生产代理:API 限流与页面鉴权

API 约定:OpenFlare 业务接口统一前缀 /api/v1/d/*,通过 OpenFlareBaseService 封装;页面数据获取使用 @tanstack/react-query。

4. Relay 模块 (internal/apps/relay/ / cmd/relay/)

模块 职责
cmd/relay/ Relay 命令行启动入口及初始化主函数
internal/apps/relay/config/ 本地配置文件解析与默认参数初始化
internal/apps/relay/frps/ 管理 frps 进程生命周期、端口与 Token 并监控运行
internal/apps/relay/heartbeat/ 周期性 HTTP 心跳通信、上报状态并获取更新请求
internal/apps/relay/httpclient/ Server 的通用 API 客户端调用工具类
internal/apps/relay/observability/ 采集本地宿主机、frps 的基础运行指标并进行预聚合
internal/apps/relay/relay/ 协调中继的核心生命周期、初始化与清理
internal/apps/relay/state/ 本地运行时状态、错误记录与持久化缓存
internal/apps/relay/updater/ Relay 升级检查、下载安装与重启机制
internal/apps/relay/wsclient/ 与 Server 保持的长连接 WebSocket 双向通信管道

5. OpenFlared (Client) 模块 (internal/apps/flared/ / cmd/flared/)

模块 职责
cmd/flared/ Client 命令行启动入口及初始化主函数
internal/apps/flared/config/ 本地客户端配置加载与解析
internal/apps/flared/flared/ 内网穿透客户端的核心调度与状态管理机制
internal/apps/flared/frpc/ 热重载/动态生成多 Relay 的 frpc_{relayNodeID}.toml 并监控 frpc
internal/apps/flared/heartbeat/ 与控制面进行的心跳通信,包含 Token 校验机制
internal/apps/flared/httpclient/ 客户端通用 API 通信(/api/v1/tunnel/*)
internal/apps/flared/sync/ 增量拉取最新 Tunnel 路由绑定关系、生成快照并应用
internal/apps/flared/updater/ 客户端自更新、新版检查与更新落地逻辑
internal/apps/flared/wsclient/ 用于实时监听 Server 端隧道配置变更推送的 WS 信道

说明:OpenFlared 无独立 state/ 包;版本与 checksum 由 frpc/manager.go 持久化到 flared-state.json。


文档维护原则