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 等 - 去除口语化表述与无意义括号，改写「不是…而是…」句式 - 同步修正文档站链接锚点，构建验证通过
160 lines
6.7 KiB
Markdown
160 lines
6.7 KiB
Markdown
# 接入 Agent
|
||
|
||
你会学到：Agent 的职责、两种接入 Token 的区别、安装脚本参数、`agent.json` 配置方式，以及如何确认节点已经上线。
|
||
|
||
OpenFlare Agent 运行在代理节点侧。它不会接收远程 shell 指令，而是通过 Agent API 拉取控制面发布的配置版本，在本地写入 OpenResty 文件、执行配置校验、reload，并在失败时尝试回滚到可运行配置。
|
||
|
||
## 接入方式
|
||
|
||
| 方式 | 适用场景 |
|
||
| --- | --- |
|
||
| `discovery_token` | 首次自动注册节点，由 Server 置换为节点专属凭证 |
|
||
| `agent_token` | 已在管理端创建或分配节点，直接使用节点专属凭证接入 |
|
||
|
||
`agent_token` 与 `discovery_token` 至少填写一个。
|
||
|
||
### 凭证获取路径
|
||
|
||
- **`discovery_token`（自动注册凭证）**：登录管理端后台，导航至「系统设置」->「自动注册」，在页面中可直接生成、查看和复制全局的自动注册凭证。
|
||
- **`agent_token`（节点专属凭证）**：登录管理端后台，导航至「节点管理」->「新增节点」，填写节点基本信息保存后，在节点详情页面即可直接复制该节点专属的接入 Token。
|
||
|
||
## 一键安装
|
||
|
||
### 交互式安装（推荐）
|
||
|
||
如果在不传递任何参数的情况下运行安装脚本，脚本将进入交互模式。您将可以通过向导选择安装方式（本地运行 / Docker 容器运行），并配置 Server 地址与认证 Token（若选择 Docker 方式且本地没有 Docker，脚本还会询问并智能安装 Docker）：
|
||
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/install-agent.sh | bash
|
||
```
|
||
|
||
### 自动化（非交互式）安装
|
||
|
||
如果在执行脚本时附加了任何参数，脚本将进入自动化安装模式，不需要任何交互。
|
||
|
||
使用 `discovery_token` 进行本地安装：
|
||
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/install-agent.sh | bash -s -- \
|
||
--server-url http://your-server:3000 \
|
||
--discovery-token YOUR_DISCOVERY_TOKEN
|
||
```
|
||
|
||
使用节点专属 `agent_token` 进行本地安装：
|
||
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/install-agent.sh | bash -s -- \
|
||
--server-url http://your-server:3000 \
|
||
--agent-token YOUR_AGENT_TOKEN
|
||
```
|
||
|
||
使用 Docker 容器自动化安装：
|
||
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/install-agent.sh | bash -s -- \
|
||
--server-url http://your-server:3000 \
|
||
--discovery-token YOUR_DISCOVERY_TOKEN \
|
||
--docker
|
||
```
|
||
|
||
安装脚本在本地安装模式下会下载最新 Agent，默认写入 `/opt/openflare-agent`，生成 `agent.json`，自动检测并创建低权限系统账号 `openflare`（将整个安装目录赋权给该用户），并在 Linux + systemd 环境创建 `openflare-agent.service` 服务。该服务将以 `openflare` 普通用户运行，并通过 Linux Capabilities（`CAP_NET_BIND_SERVICE`）保障其监听特权端口（如 80、443）的能力。
|
||
|
||
支持参数：
|
||
|
||
| 参数 | 说明 |
|
||
| --- | --- |
|
||
| `--server-url` | Server 地址 |
|
||
| `--discovery-token` | 首次自动注册 Token |
|
||
| `--agent-token` | 节点专属 Token |
|
||
| `--install-dir` | 安装目录，默认 `/opt/openflare-agent`（仅本地安装生效） |
|
||
| `--openresty-path` | OpenResty 二进制路径，未传时自动查找 `openresty`（仅本地安装生效） |
|
||
| `--repo` | 下载 Agent 的 GitHub 仓库，默认 `Rain-kl/OpenFlare` |
|
||
| `--no-service` | 不创建 systemd 服务（仅本地安装生效） |
|
||
| `--docker` | 使用 Docker 容器方式安装 |
|
||
| `--method` | 安装方式，可选 `local` 或 `docker`（默认 `local`） |
|
||
|
||
## 配置文件
|
||
|
||
默认配置文件路径：
|
||
|
||
```text
|
||
/opt/openflare-agent/agent.json
|
||
```
|
||
|
||
本地配置示例：
|
||
|
||
```json
|
||
{
|
||
"server_url": "http://127.0.0.1:3000",
|
||
"agent_token": "replace-with-node-auth-token",
|
||
"data_dir": "./data",
|
||
"openresty_path": "openresty",
|
||
"openresty_observability_port": 18081,
|
||
"observability_replay_minutes": 60,
|
||
"heartbeat_interval": 3000,
|
||
"request_timeout": 10000
|
||
}
|
||
```
|
||
|
||
自定义 OpenResty 路径示例：
|
||
|
||
```json
|
||
{
|
||
"server_url": "http://127.0.0.1:3000",
|
||
"agent_token": "replace-with-node-auth-token",
|
||
"data_dir": "/var/lib/openflare-agent",
|
||
"openresty_path": "/usr/local/openresty/nginx/sbin/openresty",
|
||
"main_config_path": "/var/lib/openflare-agent/etc/nginx/nginx.conf",
|
||
"route_config_path": "/var/lib/openflare-agent/etc/nginx/conf.d/openflare_routes.conf",
|
||
"access_log_path": "/var/lib/openflare-agent/var/log/openflare/access.log",
|
||
"cert_dir": "/var/lib/openflare-agent/etc/nginx/certs",
|
||
"lua_dir": "/var/lib/openflare-agent/etc/nginx/lua",
|
||
"runtime_config_dir": "/var/lib/openflare-agent/etc/openflare",
|
||
"heartbeat_interval": 3000,
|
||
"request_timeout": 10000
|
||
}
|
||
```
|
||
|
||
如果不配置 `openresty_path`，Agent 默认调用 `openresty`。完整字段见 [配置项参考](../reference/configuration.md#agent-命令行参数与配置字段)。
|
||
|
||
## Docker 运行
|
||
|
||
Docker 部署时直接运行内置 OpenResty 的 Agent 镜像：
|
||
|
||
```bash
|
||
docker pull ghcr.io/rain-kl/openflare-agent:latest
|
||
docker rm -f openflare-agent 2>/dev/null || true
|
||
docker run -d --name openflare-agent --restart unless-stopped \
|
||
-p 80:80 -p 443:443/tcp -p 443:443/udp \
|
||
-v openflare-agent-pages:/data/var/lib/openflare/pages \
|
||
-e OPENFLARE_SERVER_URL=http://your-server:3000 \
|
||
-e OPENFLARE_AGENT_TOKEN=YOUR_AGENT_TOKEN \
|
||
ghcr.io/rain-kl/openflare-agent:latest
|
||
```
|
||
|
||
> [!NOTE]
|
||
> **Pages 持久化**
|
||
> 默认将 Pages 部署目录挂载到 Docker 命名卷 `openflare-agent-pages`（容器内路径 `/data/var/lib/openflare/pages`）。重建或升级 Agent 容器时无需重新拉取静态站点包。
|
||
|
||
## 卸载
|
||
|
||
### 交互式卸载（推荐）
|
||
|
||
如果在不传递任何参数的情况下运行卸载脚本，脚本将进入交互模式。您可以通过提示菜单选择卸载方式（本地卸载 / Docker 容器卸载）：
|
||
|
||
```bash
|
||
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/uninstall-agent.sh | bash
|
||
```
|
||
|
||
### Docker 容器卸载
|
||
|
||
停止并删除 `openflare-agent` 容器即可
|
||
|
||
## 常见问题
|
||
|
||
| 现象 | 处理步骤 |
|
||
| --- |---------------------------------------------------------------------------------------------------------|
|
||
| `agent_token 和 discovery_token 不能同时为空` | 检查 `agent.json` 至少配置了一个 Token |
|
||
| 节点一直离线 | 在 Agent 节点执行 `curl -I http://your-server:3000`，确认 Server 地址可达 |
|
||
| 发布后重复失败 | Agent 会阻断同一 `version + checksum` 的重复应用；在节点详情页点击「强制同步」，或重新发布新版本 |
|