tcjlj/OpenFlare

Fork 0

mirror of https://github.com/Rain-kl/OpenFlare.git synced 2026-09-29 05:56:38 +08:00

Files

T

ryan 449d0a5c5b [优化] 更新文档

2026-05-31 14:52:37 +08:00

5.3 KiB

Raw Blame History

接入 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 的准确菜单路径]

一键安装

使用 discovery_token：

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：

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

安装脚本会下载最新 Agent，默认写入 /opt/openflare-agent，生成 agent.json，并在 Linux + systemd 环境创建 openflare-agent.service。

支持参数：

参数	说明
`--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 服务

配置文件

默认配置文件路径：

/opt/openflare-agent/agent.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 路径示例：

{
  "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 镜像：

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

启动与验证

systemd 环境：

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

手动启动：

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

源码运行：

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

编译后二进制运行：

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

在管理端确认：

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

卸载

如需彻底卸载 Agent 并清空本地数据：

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