mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 22:06:38 +08:00
ryan
600a7acdfb
- 删除未经验证的环境要求（Docker 版本号、浏览器条目）与括号废话 - 故障排查改为真实处理路径（升级→重新发布→强制同步→重建 Agent→提交 issue），删除仅开发时用的排障章节 - 删除设计文档中的测试与验收、实现检查清单、贡献者阅读建议等开发内容 - 修正与代码不符的事实：reset-passwd 命令名、证书续签窗口 7 天、Pages 检查间隔 1440 分钟、Relay vhost 端口 8080、SSO 仅支持 OIDC 等 - 去除口语化表述与无意义括号，改写「不是…而是…」句式 - 同步修正文档站链接锚点，构建验证通过
73 lines
3.5 KiB
Markdown
73 lines
3.5 KiB
Markdown
# 发布第一份配置
|
||
|
||
你会学到：如何以最简单的方式创建第一条反向代理规则、发布配置版本，并确认 Agent 已经拉取并应用配置。
|
||
|
||
OpenFlare 的发布链路以“不可变配置版本”为核心。你在管理端修改规则后，需要发布并激活新版本，在线的 Agent 才会自动同步并应用。
|
||
|
||
---
|
||
|
||
## 发布前检查
|
||
|
||
在开始发布前，请确保以下条件已满足：
|
||
|
||
| 检查项 | 状态要求 |
|
||
| --- | --- |
|
||
| **Server** | 控制面板已正常启动，且能顺利登录管理端 |
|
||
| **Agent** | 至少有一个 Agent 节点处于在线状态（可在「节点管理」中确认） |
|
||
| **源站** | 确认你的后端源站服务可从 Agent 宿主机正常访问 |
|
||
| **域名/测试** | 域名已完成 DNS 解析，或者准备好在客户端使用本地 hosts / curl 命令行 Host 头进行测试 |
|
||
|
||
---
|
||
|
||
## 步骤一：创建首个网站配置
|
||
|
||
为了快速验证，我们首先部署一个最基础的 HTTP 反代站点：
|
||
|
||
1. 登录控制面板，进入左侧导航 **「网站管理」->「域名列表」**，点击 **「新增 Zone」**。
|
||
2. 填写域名配置：
|
||
* **域名**：输入用于测试的域名（如 `first.example.com`）。
|
||
* **绑定证书**：选择不绑定证书（作为 HTTP 快速验证）。
|
||
* 点击保存，完成域名登记。
|
||
3. 进入左侧导航 **「规则管理」**，点击 **「新建规则」**：
|
||
* **规则名称**：输入简易标识（如 `first-app-route`）。
|
||
* **域名匹配**：填入你的测试域名（如 `first.example.com`）。
|
||
* 在下方 **「反向代理」** 选项卡中，配置 **回源方式** 为「直连上游」。
|
||
* **上游地址**：填写后端服务地址（如测试专用的 `http://httpbin.org`）。
|
||
* 点击保存创建规则。
|
||
|
||
> [!TIP]
|
||
> **关于 HTTPS 与证书准备**
|
||
> 本节仅引导快速部署基础 HTTP 规则。若你需要导入已有的 SSL 证书或通过 ACME 协议向 Let's Encrypt 自动申请证书并开启 443 端口 HTTPS 代理，请前往 [新建反代配置](./proxy-config.md) 查阅详细步骤。
|
||
|
||
---
|
||
|
||
## 步骤二：预览并发布配置版本
|
||
|
||
新增的网站配置仍保存在 Server 的数据库中，处于草稿状态，需要通过发布版本分发到数据面：
|
||
|
||
1. 点击控制面板右上角的 **「预览并发布」** 按钮，系统会展示本次新增路由的物理配置文件 Diff 差异。
|
||
2. 确认渲染出的配置内容正确无误后，点击 **「确认发布」**。
|
||
3. 控制面将生成一个唯一的配置版本号（格式为 `YYYYMMDD-NNN`）。
|
||
|
||
---
|
||
|
||
## 步骤三：验证 Agent 生效状态
|
||
|
||
发布成功后，控制面会立即通过 WebSocket 通知在线 Agent（若 WebSocket 离线，则会在 Agent 的心跳中作为差分感知）：
|
||
|
||
1. **管理端验证**：进入「节点管理」-> 点击节点进入详情，检查**当前版本号**是否已成功变为刚刚发布的最新激活版本，且「应用记录」显示为成功。
|
||
2. **边缘节点验证**：你可以在 Agent 节点宿主机上通过日志检查应用情况：
|
||
```bash
|
||
# 如果是 Docker 部署的 Agent
|
||
docker logs openflare-agent
|
||
|
||
# 如果是本地 systemd 部署的 Agent
|
||
journalctl -u openflare-agent -n 50 --no-pager
|
||
```
|
||
3. **连通性测试**：
|
||
在客户端电脑上，使用 `curl` 携带测试 Host 请求 Agent 节点的 IP 地址进行最终验证：
|
||
```bash
|
||
curl -I -H "Host: first.example.com" http://AGENT_NODE_IP
|
||
```
|
||
若返回的状态码与后端源站响应一致，即代表你的第一条反代规则已成功在边缘节点落地生效！
|