OpenFlare/README.zh-CN.md

OpenFlare

English | 📖 中文

OpenFlare 是开源 CDN 编排与边缘安全平台。它支持反向代理、集中式配置同步、内网穿透（Tunnels）、动态 WAF 防护以及防 CC 挑战。

Warning

使用 root 用户初次登录系统后，务必修改默认密码 123456。

BETA 版本为开发测试阶段的临时产物，可能存在未知问题，请勿在生产环境使用。

文档

https://open-flare.pages.dev

常用入口：

• 快速开始
• 部署说明
• 配置项参考
• 系统设计

核心能力

• 中心化实时配置同步：通过 WebSocket 与心跳实现全网节点配置秒级同步下发与热生效，告警与状态即时回收，无须手动 SSH 登录或在线打补丁。
• 分布式 CDN 编排集群：将分散独立的 OpenResty 节点编排为高度协同的分布式内容分发网络（CDN）舰队，支持网站级多域名聚合、上游 Keepalive 与多源站负载均衡。
• 安全内网穿透（Tunnels）：开源版的 Cloudflare Tunnels。无须公网 IP 或暴露入向端口，安全反向穿透本地内网服务至公网。
• 边缘 WAF 安全防护：提供全局及自定义规则组，支持 IP/CIDR 过滤、MaxMind GeoIP 国家级地域准入、IP 组成员异步差分同步免 Nginx 重载以及自定义拦截响应。
• 防 CC 与人机挑战（PoW）：内置高性能客户端密码学 Proof of Work 挑战（类似 Turnstile），在网关边缘秒级拦截并阻断僵尸网络与爬虫。
• 发布与同步模型：基于不可变配置版本（YYYYMMDD-NNN）、发布前预览对比差异、全局单激活版本与一键秒级回滚。
• 三阶段容灾回滚：支持节点备份自动回滚、内置安全兜底页面（Port 80/503 保持状态监控与安全拦截）及异常配置阻断名单。
• 证书托管自动化：支持证书动态上传、多域名证书自动匹配绑定、ACME 自动续期与全生命周期状态追踪。
• 统一观测与可观测性：聚合节点请求数、实时访问分析、宿主机与 Nginx 资源快照、健康日志及网络波动补传缓冲。

快速开始

1. 启动 Server

services:
  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: openflare
      POSTGRES_USER: openflare
      POSTGRES_PASSWORD: replace-with-strong-password
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"]
      interval: 10s
      timeout: 5s
      retries: 5

  openflare:
    image: ghcr.io/rain-kl/openflare:latest
    restart: unless-stopped
    depends_on:
      postgres:
        condition: service_healthy
    ports:
      - "3000:3000"
    environment:
      SESSION_SECRET: replace-with-random-string
      DSN: postgres://openflare:replace-with-strong-password@postgres:5432/openflare?sslmode=disable
      GIN_MODE: release
      LOG_LEVEL: info

volumes:
  postgres-data:

docker compose up -d

访问地址：http://localhost:3000

默认账号：

• 用户名：root
• 密码：123456

2. 安装 Agent

安装 Agent 前请先在节点上安装 OpenResty，或改用内置 OpenResty 的 Agent Docker 镜像。

你可以在控制面板的节点管理->详情->节点信息->节点标识与部署复制安装命令，或直接使用下面的脚本：

Docker 部署

Docker 部署可直接运行 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/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

本地部署

使用 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

安装脚本默认写入 /opt/openflare-agent，创建 openflare-agent.service，自动查找 openresty，并可重复执行以重装或升级 Agent。

3. 卸载 Agent

如需彻底卸载 Agent 并清空本地数据，可执行：

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

卸载脚本会先停止并移除 openflare-agent.service、删除整个 /opt/openflare-agent 目录，不会删除本机 OpenResty。

4. 发布第一份配置

1. 登录管理端并新增反代规则
2. 在发布前查看预览或变更摘要
3. 激活新版本
4. Agent 通过 WebSocket 通知或后续 heartbeat 拉取并应用配置

版本号格式固定为 YYYYMMDD-NNN，历史版本不可变，回滚通过重新激活旧版本完成。

界面预览

仪表盘总览

节点详情

配置新增

管理端与接口

管理端当前覆盖：

• 反代规则
• 配置版本
• 节点管理
• 应用记录
• TLS 证书
• 域名管理
• WAF 规则组
• 用户管理
• 设置
• 版本更新
• POW 规则

登录管理端后，可访问 Swagger UI：/swagger/index.html

开源协议

本项目采用 Apache License 2.0 开源。

Star History