接入 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": 15,
  "heartbeat_interval": 10000,
  "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": 10000,
  "request_timeout": 10000
}

如果不配置 openresty_path，Agent 默认调用 openresty。完整字段见配置项参考。

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 \
  -e OPENFLARE_SERVER_URL=http://your-server:3000 \
  -e OPENFLARE_AGENT_TOKEN=YOUR_AGENT_TOKEN \
  ghcr.io/rain-kl/openflare-agent:latest

NOTE

非 Root 安全加固运行 Agent 容器内部已完成安全加固，在启动后会统一以低权限非 root 用户 openflare 运行。容器已内置了 cap_net_bind_service 内核能力，使得低权限进程依然能够正常监听宿主机的 80 和 443 特权端口。同时，OpenResty 运行时所需的各种临时路径（包括 PID 路径、各类临时缓存目录如 client_body_temp_path、proxy_temp_path 等）都由 Agent 控制器动态渲染并自动重定向至容器内的 /data 目录，彻底避免在非 root 权限运行时写入默认系统路径而导致的权限拒绝错误（Permission Denied）。具体物理缓存写入路径为：

临时缓存目录：/data/var/cache/nginx
代理缓存目录：/data/var/cache/openflare_proxy

启动与验证

systemd 环境：

bash

systemctl status openflare-agent
journalctl -u openflare-agent -f

手动启动：

bash

/opt/openflare-agent/openflare-agent -config /opt/openflare-agent/agent.json

源码运行：

bash


export LOG_LEVEL='info'
go run ./cmd/agent -config /path/to/agent.json

编译后二进制运行：

bash


go build -o openflare-agent ./cmd/agent
export LOG_LEVEL='info'
./openflare-agent -config /path/to/agent.json

在管理端确认：

位置	期望结果
节点列表	节点在线
节点详情	能看到心跳时间、当前版本和基础资源信息
应用记录	发布配置后出现应用结果

卸载

交互式卸载 (推荐)

如果在不传递任何参数的情况下运行卸载脚本，脚本将进入交互模式。您可以通过提示菜单选择卸载方式（本地卸载 / Docker 容器卸载）：

bash

curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/uninstall-agent.sh | bash

自动化 (非交互式) 卸载

使用命令行传参进行无人值守卸载。

本地卸载（默认）：

bash

curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/uninstall-agent.sh | bash -s -- --install-dir /opt/openflare-agent

Docker 容器卸载：

bash

curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/uninstall-agent.sh | bash -s -- --docker

支持参数：

参数	说明
`--install-dir`	安装目录，默认 `/opt/openflare-agent`（仅本地卸载生效）
`--service-name`	systemd 服务名，默认 `openflare-agent`（仅本地卸载生效）
`--docker`	使用 Docker 容器方式卸载
`--method`	卸载方式，可选 `local` 或 `docker`（默认 `local`）

本地卸载只会移除 Agent 服务、进程和安装目录，不会删除本机 OpenResty。Docker 卸载会停止并删除 openflare-agent 容器，交互模式下还可以选择是否清理对应的 Docker 镜像。

常见问题

现象	处理步骤
`agent_token 和 discovery_token 不能同时为空`	检查 `agent.json` 至少配置了一个 Token
节点一直离线	在 Agent 节点执行 `curl -I http://your-server:3000`，确认 Server 地址可达
OpenResty 没有启动	查看 `journalctl -u openflare-agent`，确认 `openresty_path` 可执行，80/443 端口未被占用，且运行用户（如 `openflare`）对数据目录具有读写权限
发布后重复失败	Agent 会阻断同一 `version + checksum` 的重复应用；需要修正配置后重新发布，或激活旧版本回滚

接入 Agent ​

接入方式 ​

凭证获取路径 ​

一键安装 ​

交互式安装 (推荐) ​

自动化 (非交互式) 安装 ​

配置文件 ​

Docker 运行 ​

启动与验证 ​

卸载 ​

交互式卸载 (推荐) ​

自动化 (非交互式) 卸载 ​

常见问题 ​

接入 Agent

接入方式

凭证获取路径

一键安装

交互式安装 (推荐)

自动化 (非交互式) 安装

配置文件

Docker 运行

启动与验证

卸载

交互式卸载 (推荐)

自动化 (非交互式) 卸载

常见问题