About this project

OpenFlare is an open-source CDN orchestration and edge security platform. It provides a comprehensive suite of features for managing and securing web services at the edge, including: * **Reverse Proxy Configuration Management**: Centrally manage reverse proxy configurations for all OpenResty nodes using website rules, supporting multi-domain binding and multi-upstream load balancing. * **Secure In-Network Tunneling (Tunnels)**: An open-source alternative to Cloudflare Tunnels, allowing secure reverse proxying of internal web services to the public internet without exposing inbound ports, using Relay nodes and OpenFlared clients. * **Edge WAF Security Protection**: Offers global and custom rule groups, manual/auto/subscription-type IP groups, GeoIP-based country-level access control, and differential synchronization for IP group changes without requiring Nginx reloads. * **CC Defense and Human-Computer Challenge (PoW)**: Includes a built-in Proof of Work challenge to block zombie networks and crawlers at the gateway edge. * **Pages Static Hosting**: Supports uploading or syncing pre-built artifacts from remote URLs or GitHub releases, with immutable deployments, rollbacks, SPA fallback, and API reverse proxy. * **TLS Certificate Automation**: Supports dynamic certificate uploads, automatic multi-domain matching, and ACME-based issuance/renewal from Let's Encrypt. * **Uptime Kuma Monitoring Synchronization**: Integrates with Uptime Kuma for automatic differential synchronization of monitoring site lists. * **SSO Single Sign-On**: Supports GitHub OAuth and standard OIDC protocol for unified login. * **Unified Observability**: Aggregates node request metrics, access logs, host/Nginx resource snapshots, health events, and network fluctuation data. ## Quick Start ### Hardware Requirements | Component | Minimum | Recommended | |---|---|---| | Server Control Plane | 1 CPU / 2 GB RAM / 20 GB disk | 2 CPU / 4 GB RAM / 50 GB+ disk | | Agent Data Plane | 1 CPU / 512 MB RAM / 2 GB disk | 2 CPU / 2 GB RAM / 10 GB+ disk | | Relay Node | 1 CPU / 1 GB RAM / 5 GB disk | 2 CPU / 2 GB RAM / 20 GB disk | | OpenFlared Client | 1 CPU / 256 MB RAM / 1 GB disk | 1 CPU / 512 MB RAM / 5 GB disk | ### 1. Start the Server Use `docker-compose` with the provided example. After starting, access `http://localhost:3000` and log in with the default credentials (`admin` / `12345678`). **Change the default password immediately.** ### 2. Install Agent Install OpenResty on the node or use the provided Agent Docker image. Copy the installation command from the control panel or use the Docker run command with your server URL and agent token. ## License Apache License 2.0