NodeFlare/README.md

NodeFlare

English | 简体中文

NodeFlare 是一款轻量级、可自托管的服务器监控面板：通过 Web 界面查看服务器状态，由轻量 Agent 采集数据并主动上报。支持实时监控、TCP/ICMP 拨测、Telegram 告警、远程执行、TOTP 两步验证、主题定制，以及 SQLite / PostgreSQL 的备份恢复与在线迁移。

Warning

NodeFlare 是一款自托管的监控/控制程序，仅应部署在你拥有或已获得授权管理的系统上。在未获授权的系统上部署、访问或执行命令，由部署者自行承担责任。

在线文档 | 在线演示 | 常见问题 | 发布下载

界面预览

特性

• 实时监控：CPU、内存、网速每秒采样，默认每 3 秒压缩批量上传；磁盘、GPU、连接数等慢指标单独缓存
• 延迟拨测：TCP 与 ICMP 任务按节点分配，支持电信 / 移动 / 联通分线展示
• 告警通知：资源阈值、离线、到期、流量告警，Telegram 推送，消息模板可自定义
• 主题商店：内置主题、仓库主题一键安装、本地 ZIP 上传、主题参数自定义
• 安全可控：TOTP 两步验证、Cloudflare Turnstile 人机验证、登录限速与会话管理；服务端默认只监听 127.0.0.1，Agent 仅出站连接、无需开放入站端口
• 数据自持：SQLite 与 PostgreSQL 双支持、在线迁移、一键备份恢复、历史数据按保留天数自动清理

快速开始

安装服务端（自动下载最新 Release 并注册系统服务）。

Linux / macOS：

curl -fsSL https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.sh | sudo sh

FreeBSD：

fetch -qo - https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.sh | sudo sh

Windows PowerShell（管理员）：

Invoke-WebRequest -UseBasicParsing https://raw.githubusercontent.com/elysia62/NodeFlare/main/install.ps1 -OutFile "$env:TEMP\nodeflare-install.ps1"
Unblock-File "$env:TEMP\nodeflare-install.ps1"
& "$env:TEMP\nodeflare-install.ps1"

首次安装会询问管理员用户名、密码、监听端口（默认 2206）和数据库地址（默认 SQLite）。服务端默认监听 127.0.0.1:2206，本机访问 http://127.0.0.1:2206/admin/login；对外使用需经 HTTPS 反向代理。

在管理后台「服务器」页面创建节点，执行弹窗中的安装命令即可安装 Agent：

curl -fsSL https://raw.githubusercontent.com/elysia62/NodeFlare/main/agent/agent.sh \
  | sudo sh -s -- -e 'https://nodeflare.example.com' -t 'Agent Token'

更新：重新运行安装脚本即可，配置数据保留，失败自动回滚。

Tip

安装脚本参数、各平台 Agent 脚本与卸载方法见文档：安装服务端 · 安装 Agent · 卸载。

Docker 部署

镜像：gxmandppx/nodeflare，支持 amd64 / arm64。两种方式均需先按配置示例准备 ./data/config.toml，并确保 ./data 及配置文件可由容器用户 10001:10001 读写。

Docker：

docker run -d --name nodeflare \
  --restart unless-stopped \
  -p 127.0.0.1:2206:2206 \
  -v "$PWD/data:/etc/nodeflare" \
  gxmandppx/nodeflare:latest

Docker Compose（将以下内容保存为 compose.yaml）：

services:
  nodeflare:
    image: gxmandppx/nodeflare:latest
    container_name: nodeflare
    restart: unless-stopped
    ports:
      - "127.0.0.1:2206:2206"
    volumes:
      - ./data:/etc/nodeflare

docker compose up -d

文档

文档	说明
安装服务端	一键安装、首次初始化、脚本参数与更新
安装 Agent	各平台安装脚本与参数
卸载	服务端与 Agent 的卸载及数据清理
配置	配置项说明与完整示例
反向代理	nginx / Caddy 配置与 trusted_proxies
数据库与备份	备份恢复、SQLite ↔ PostgreSQL 在线迁移
监控口径与采样	采样频率与内存统计口径
告警与通知	阈值、离线、到期、流量告警
主题定制	主题商店与主题参数
常见问题	排障与 FAQ
开发指南	本地开发、测试与构建

开发

git clone https://github.com/elysia62/NodeFlare.git
cd NodeFlare
bun install --frozen-lockfile
cp backend/config.example.toml backend/config.toml
./dev.sh

dev.sh 会构建前端并以 cargo run 启动后端。测试、构建与仓库结构详见文档开发指南与仓库结构。

License

MIT