mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-10-06 15:46:37 +08:00
docs: update
This commit is contained in:
+18
-22
@@ -12,12 +12,10 @@ OpenFlare 提供了**基于反向中继穿透隧道**的整体解决方案。你
|
||||
|
||||
在使用内网穿透功能前,你需要熟悉以下组件与核心概念:
|
||||
|
||||
| 概念 | 说明 | 对应组件/操作 |
|
||||
| --- | --- | --- |
|
||||
| **中继节点 (Relay)** | 部署在公网边缘的流量中继服务,负责监听内网客户端的长连接,并作为网关 Agent (OpenResty) 与内网流量的中转桥梁。 | 运行 `openflare-relay` 守护的 `tunnel_relay` 节点 |
|
||||
| **穿透隧道 (Tunnel)** | 逻辑上的穿透客户端实例,拥有全局唯一 ID 与安全认证令牌,用以标识一个具体的内网环境。 | 由 Server 随机生成 `tunnel_id` (tun-<32hex>) |
|
||||
| **穿透隧道 (Tunnel)** | 逻辑上的穿透客户端实例,拥有全局唯一 ID 与安全认证令牌,用以标识一个具体的内网环境。 | 在「节点管理」中创建的 `tunnel_client` 节点,分配专属 Tunnel Token |
|
||||
| **隧道客户端 (Client)** | 运行在内网环境下的轻量控制器,根据 Server 下发的配置自动管理底层的 frpc 隧道子进程。 | 内网部署的 `openflared` 容器或独立二进制进程 |
|
||||
| **隧道上游 (Tunnel Upstream)** | 网站配置中的特殊上游类型。选择此类型后,网关会将公网流量转发至本地中继端的 Vhost 端口,最终送达内网源站。 | 网站详情中配置的 `tunnel` 类型上游 |
|
||||
| **隧道上游 (Tunnel Upstream)** | 路由规则中的特殊反代类型。选择此类型后,网关会将公网流量转发至本地中继端的 Vhost 端口,最终送达内网源站。 | 在「规则管理」详情页中配置的反向代理类型,选择源站类型为「内网穿透」并绑定对应 Tunnel 节点 |
|
||||
|
||||
---
|
||||
|
||||
@@ -26,10 +24,10 @@ OpenFlare 提供了**基于反向中继穿透隧道**的整体解决方案。你
|
||||
将一个内网服务发布到公网,推荐按这个顺序进行:
|
||||
|
||||
1. 注册并部署至少一个公网 **中继节点 (Relay)** 并保持在线。
|
||||
2. 在管理端创建 **穿透隧道 (Tunnel)** 并复制对应的专属 Token。
|
||||
2. 进入 **「节点管理」**,新建一个类型为 **Tunnel 节点 (tunnel_client)** 的节点,获取专属 Token。
|
||||
3. 在内网服务器中部署并启动 **隧道客户端 (OpenFlared)**。
|
||||
4. 确认管理端中该隧道的在线状态显示为「在线」。
|
||||
5. 新增网站配置,上游类型选择 **内网穿透**,绑定对应隧道并填写内网端口(如 `127.0.0.1:8080`)。
|
||||
4. 确认管理端中该 Tunnel 节点的状态显示为「在线」。
|
||||
5. 在 **「规则管理」** 页面新增或编辑规则,在「反向代理」选项卡中选择源站类型为 **「内网穿透」**,绑定对应 Tunnel 节点并填写内网服务端口(如 `127.0.0.1:8080`)。
|
||||
6. 发布并激活新版本。
|
||||
7. 通过公网域名访问,验证内网穿透链路是否打通。
|
||||
|
||||
@@ -58,14 +56,12 @@ OpenFlare 提供了**基于反向中继穿透隧道**的整体解决方案。你
|
||||
> [!IMPORTANT]
|
||||
> 请务必在云服务器安全组中放行 `7000` 端口(frpc 客户端连接控制端口)。如果你的 Server 与中继节点部署在同一台机器,这里的 `OPENFLARE_SERVER_URL` 应指向 Server 的公网或内网通信 IP。
|
||||
|
||||
### 第二步:在管理端创建穿透隧道
|
||||
### 第二步:在管理端创建 Tunnel 节点
|
||||
|
||||
1. 导航至管理侧边栏的 **「内网穿透」** 页面。
|
||||
2. 点击 **「创建隧道」** 按钮,在弹窗中填写:
|
||||
* **隧道名称**:描述此内网环境,例如 `home-lab` 或 `office-dev`。
|
||||
* **描述**:可选填,描述此隧道的具体用途。
|
||||
3. 点击保存后,系统将自动生成该隧道的全局唯一 ID 与一串专属的 `tunnel_token`(形如 `tun-xxxx...`)。
|
||||
4. 复制弹窗中为你生成的 **客户端部署命令**,用于下一步内网环境的部署。
|
||||
1. 导航至管理侧边栏的 **「节点管理」** 页面。
|
||||
2. 点击 **「新增节点」** 按钮,在弹窗中选择节点类型为 **「Tunnel 节点 (tunnel_client)」**。
|
||||
3. 填入节点名称与描述,点击保存。
|
||||
4. 在节点列表中点击进入刚才创建的 Tunnel 节点详情页,你可以找到专属的 **Tunnel Token** 及相应的客户端一键部署命令。
|
||||
|
||||
### 第三步:部署内网客户端 (OpenFlared)
|
||||
|
||||
@@ -104,19 +100,19 @@ docker run -d --name openflared --restart unless-stopped \
|
||||
#### 状态确认
|
||||
|
||||
启动成功后,内网客户端会通过出向网络向控制面发送心跳同步配置。此时:
|
||||
1. 刷新管理端的 **「内网穿透」** 列表,刚才创建的隧道状态指示灯应当变为绿色的 **「在线」**。
|
||||
2. 点击隧道详情,你可以直观地查看到当前内网客户端连接了公网的哪些中继 Relay 节点。
|
||||
1. 刷新管理端的 **「节点管理」** 列表,刚才创建的 Tunnel 节点状态指示灯应当变为绿色的 **「在线」**。
|
||||
2. 点击节点进入详情页,你可以直观地查看到当前内网客户端连接了公网的哪些中继 Relay 节点。
|
||||
|
||||
### 第四步:创建网站并绑定隧道上游
|
||||
### 第四步:配置请求路由并绑定隧道上游
|
||||
|
||||
现在你可以为你的内网服务配置公网反向代理和域名访问了。
|
||||
|
||||
1. 进入 **「网站配置」** 页面,点击 **「新建网站」**。
|
||||
2. 填写公网访问该网站所需的 **域名**,例如 `nas.example.com`。
|
||||
3. 关键配置:在 **「上游配置」** 区域,将 **上游类型** 从默认的「直连」切换为 **「内网穿透」**。
|
||||
4. 在下拉列表中选择你刚刚部署上线的 **内网隧道**(如 `home-lab`)。
|
||||
1. 首先进入 **「网站管理」->「域名列表」** 录入你想要公开访问的域名。
|
||||
2. 进入 **「规则管理」** 页面,点击 **「新增规则」** 或编辑已有规则。
|
||||
3. 在下方 **「反向代理」** 选项卡下,将 **源站类型** 切换为 **「内网穿透」**。
|
||||
4. 从下拉列表中选择刚才部署在线的 **Tunnel 节点**。
|
||||
5. 填写 **内网目标地址**(对于内网客户端来说可访问的本地地址与端口,例如 `127.0.0.1:8080`)与 **内网协议**(通常为 `http`)。
|
||||
6. 配置其他站点常规项(如 TLS 证书等),并点击保存。
|
||||
6. 配置其他站点常规项,并点击保存。
|
||||
|
||||
### 第五步:发布与生效
|
||||
|
||||
|
||||
Reference in New Issue
Block a user