tcjlj/OpenFlare
1
0
Fork 0
mirror of https://github.com/Rain-kl/OpenFlare.git synced 2026-09-29 14:06:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

[优化] go 引用调整

Browse Source
This commit is contained in:
ryan
2026-06-06 10:26:20 +08:00
parent ee1110b752
commit 3cfefb4367
552 changed files with 1642 additions and 2185 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/design/architecture.md
+3 -3
View File
@@ -77,7 +77,7 @@ OpenResty (Agent, TLS/WAF)
## 组件架构与分工
### 1. Server (控制面)
`openflare_server` 是 Go 编写的单体控制面：
`openflare-server` 是 Go 编写的单体控制面：
* 提供管理端 REST API，通过 `OPENFLARE_TOKEN` 请求头鉴权。
* 包含配置编译器（Compiler），将数据库中的规则、证书与全局参数统一编译为不可变的配置快照及 OpenResty 物理配置文件文本。
* 存储 Pages 部署 ZIP 包于本地 Artifacts 目录，并向 Agent 提供受控的下载接口。
@@ -85,7 +85,7 @@ OpenResty (Agent, TLS/WAF)
* *详细设计请参阅：[Agent 与发布模型设计](./agent-design.md) 以及 [Uptime Kuma 监控同步设计](./kuma-design.md)*
### 2. Agent (配置落地端)
`openflare_agent` 是运行在节点本地的守护进程：
`openflare-agent` 是运行在节点本地的守护进程：
* 启动后维持与控制面的周期性心跳，并通过可选的 WebSocket 接收实时的配置发布广播。
* 负责拉取最新激活版本的配置文件及证书，写入本地目录，并通过 `openresty -t` 执行安全校验后平滑重载 (`reload`)。
* 在本地处理 Pages 部署包的下载、SHA-256 校验与解压缩切换。
@@ -99,7 +99,7 @@ OpenResty (Agent, TLS/WAF)
### 4. Relay 与 OpenFlared (穿透组件)
扩展数据面反穿透能力：
* `openflare_relay` 守护本地 `frps`，接受 Server 的配置派发，自动更新中继端口。
* `openflare-relay` 守护本地 `frps`，接受 Server 的配置派发，自动更新中继端口。
* `openflared` 在内网守护一组 `frpc` 客户端进程，实现多中继就近建连与高可用容灾。
* *详细设计请参阅：[内网穿透隧道设计文档](./tunnel-design.md)*
docs/design/index.md
+8 -8
View File
@@ -66,16 +66,16 @@ OpenFlare 适合需要统一管理多台 OpenResty 代理节点的团队，具
| 路径 | 职责 |
| ---------------------- | ---------------------------------------------------- |
| `openflare_server` | Gin + GORM + SQLite/PostgreSQL 单体控制面 |
| `openflare_server/web` | Next.js 15 App Router 管理端前端，由 Go Server 托管 |
| `openflare_agent` | Go 单体 Agent，运行在节点侧 |
| `openflare_relay` | Tunnel 中继代理，运行在公网边缘管理 frps 进程 |
| `openflare-server` | Gin + GORM + SQLite/PostgreSQL 单体控制面 |
| `openflare-server/web` | Next.js 15 App Router 管理端前端，由 Go Server 托管 |
| `openflare-agent` | Go 单体 Agent，运行在节点侧 |
| `openflare-relay` | Tunnel 中继代理，运行在公网边缘管理 frps 进程 |
| `openflared` | Tunnel 客户端，运行在内网服务器侧管理 frpc 进程 |
| `scripts` | 安装、自更新等系统辅助脚本 |
| `docs` | VitePress 文档站、设计基线、开发规范、部署与配置文档 |
| `docs/en` | 英文版文档 |
### 1. Server 分层 (`openflare_server/`)
### 1. Server 分层 (`openflare-server/`)
| 目录 | 职责 |
| ------------- | ------------------------------------------------ |
@@ -93,7 +93,7 @@ OpenFlare 适合需要统一管理多台 OpenResty 代理节点的团队，具
| `docs/` | API 文档（Swagger） |
| `data/` | 静态数据（如 GeoIP 数据库） |
### 2. Agent 模块 (`openflare_agent/`)
### 2. Agent 模块 (`openflare-agent/`)
| 目录/模块 | 职责 |
| ----------------------------- | -------------------------------------------- |
@@ -113,7 +113,7 @@ OpenFlare 适合需要统一管理多台 OpenResty 代理节点的团队，具
| `internal/geoipupdate/` | GeoIP 数据更新 |
| `internal/agent/` | 核心 Agent 逻辑与生命周期 |
### 3. Frontend 分层 (`openflare_server/web/`)
### 3. Frontend 分层 (`openflare-server/web/`)
| 目录 | 职责 |
| ------------- | -------------------------------------------- |
@@ -128,7 +128,7 @@ OpenFlare 适合需要统一管理多台 OpenResty 代理节点的团队，具
| `scripts/` | 构建和部署相关脚本 |
| `public/` | 静态资源 |
### 4. Relay 模块 (`openflare_relay/`)
### 4. Relay 模块 (`openflare-relay/`)
| 模块 | 职责 |
| ---------------- | ------------------------------------------------ |
docs/design/pages-design.md
+1 -1
View File
@@ -39,7 +39,7 @@ graph TD
OpenResty -->|2. 转发 API 代理| BackEnd[4. 后端 API 服务]
%% 控制流与心跳
Server[OpenFlare Server 控制面] <-->|Agent API / Heartbeat| Agent[openflare_agent 进程]
Server[OpenFlare Server 控制面] <-->|Agent API / Heartbeat| Agent[openflare-agent 进程]
Server -.->|5. 存储 ZIP 部署包| LocalStore[(Server 本地存储)]
Agent -->|1. 发现新版本| Server
docs/design/tunnel-design.md
+5 -5
View File
@@ -40,7 +40,7 @@ graph TD
FlaredFrpc -->|转发本地请求| LocalOrigin[5. 内网源站 192.168.x.x]
%% 控制流与心跳
Server[OpenFlare Server 控制面] <-->|Relay API / Heartbeat| RelayManager[openflare_relay 进程]
Server[OpenFlare Server 控制面] <-->|Relay API / Heartbeat| RelayManager[openflare-relay 进程]
Server <-->|Client API / Heartbeat| ClientManager[openflared 进程]
RelayManager -.->|管控进程及配置| RelayFrps
@@ -51,14 +51,14 @@ graph TD
style Server fill:#f96,stroke:#333,stroke-width:2px
```
* **控制面（Control Plane）**：Server 维护数据库状态；中继节点上的 `openflare_relay` 进程与内网服务器上的 `openflared` 进程通过 HTTP 心跳与 WebSocket 长通道同步隧道配置。
* **数据面（Data Plane）**：公网流量首先进入公网边缘的 Agent (OpenResty)，在此完成 HTTPS 握手、TLS 终止和 WAF 过滤，接着通过 `proxy_pass` 转发到同机部署的 `openflare_relay (frps)`。`frps` 再将请求封包通过与内网 `openflared (frpc)` 建立的持久隧道传输过去，最后由 `frpc` 拆包并分发给内网实际的源站服务。
* **控制面（Control Plane）**：Server 维护数据库状态；中继节点上的 `openflare-relay` 进程与内网服务器上的 `openflared` 进程通过 HTTP 心跳与 WebSocket 长通道同步隧道配置。
* **数据面（Data Plane）**：公网流量首先进入公网边缘的 Agent (OpenResty)，在此完成 HTTPS 握手、TLS 终止和 WAF 过滤，接着通过 `proxy_pass` 转发到同机部署的 `openflare-relay (frps)`。`frps` 再将请求封包通过与内网 `openflared (frpc)` 建立的持久隧道传输过去，最后由 `frpc` 拆包并分发给内网实际的源站服务。
---
## Relay (中继端) 设计
`openflare_relay` 是部署在公网边缘的中继管理器，运行在 `tunnel_relay` 类型的节点上。
`openflare-relay` 是部署在公网边缘的中继管理器，运行在 `tunnel_relay` 类型的节点上。
### 1. 核心架构与逻辑
* **进程守护**：Relay 进程内部持有 `frps` 二进制，通过 `exec.Command` 拉起 `frps -c frps.toml` 子进程，并启动 goroutine 异步监听其退出状态。如果发现 `frps` 异常退出，会结合退避机制自动拉起。
@@ -98,7 +98,7 @@ graph TD
+-------------------------------------------+-------------------------------------------+
| |
v (中继端) v (内网客户端)
openflare_relay 心跳检测到 frps 端口/Token 变化 openflared 心跳检测到 tunnel_version 发生变更
openflare-relay 心跳检测到 frps 端口/Token 变化 openflared 心跳检测到 tunnel_version 发生变更
重新渲染本地 frps.toml 请求拉取最新代理映射包
Kill 并重新拉起 frps 进程 重新渲染 frpc_<relay_id>.toml
上报健康状态为 healthy 对有变更的 Relay 进程执行重启与配置热重载