Guide Overview
OpenFlare is a distributed reverse proxy and edge security gateway based on Pingora edge architecture. It provides multi-node cluster orchestration, snapshot-based configuration hot-synchronization, edge WAF, proof-of-work (PoW) challenge defense, intranet tunnels, and Pages static hosting. It can operate as a standalone gateway or as an origin shield behind upstream CDNs.
Documentation in this section is organized into five operational areas, guiding users from initial deployment through daily traffic management, security hardening, and troubleshooting.
Guide Index
Getting Started
For users deploying OpenFlare or connecting edge nodes for the first time:
- Quick Start: deploy the Server controller with Docker Compose, complete first-time login, obtain credentials, and connect your first edge node.
- Create Your First Reverse Proxy Rule: create a baseline HTTP proxy site and verify edge node synchronization.
- Dashboard Geographic Distribution: explore the global dashboard, 2D/3D map switching, metric calculation methods, and country request rankings.
Traffic & Routing
Configure reverse proxy routing, TLS encryption, and edge caching:
- Create a Reverse Proxy Config: configure upstream origins, domain route bindings, wildcard routing, IP HTTPS upstreams, and access authentication.
- TLS Certificates & Auto-Renewal: import existing certificates or automate wildcard issuance and renewal using ACME and Cloudflare DNS API.
- Pingora Performance Policies: configure worker thread counts, upstream connection pools, HTTP/2 concurrency, TinyUFO memory cache, and disk cache limits.
- Zone Domain Migration: understand automatic migration to the Zone root domain model, backup procedures, and post-upgrade acceptance checks.
Edge Security
Configure edge firewalls and proof-of-work challenge defenses:
- WAF Security Protection: build visual DAG workflow rules, configure IP matching, geo-filtering, and OWASP CRS attack protection rule groups.
- Proof-of-Work (PoW) Protection: configure client-side proof-of-work challenges for routes, manage trigger path filters, and customize challenge pages.
- WAF Auto IP Group Expressions: write Expr-based dynamic metric aggregation and auto-blocking rules with custom HTTP status code filters.
Apps & Integrations
Extend gateway capabilities with static hosting, intranet tunnels, and monitoring:
- Pages Static Hosting Usage: deploy pre-built static site archives, configure SPA Fallback and API reverse proxy paths, and manage release rollbacks.
- Tunnel & Intranet Penetration: deploy Relay nodes and OpenFlared clients to securely expose intranet services without public IP addresses.
- Uptime Kuma Monitoring Sync: configure automated differential synchronization with Uptime Kuma to track site availability.
- SSO Login Configuration: configure standard OIDC identity providers for third-party single sign-on, user binding, and registration controls.
Operations
Maintenance, diagnostic procedures, and open-source references:
- Troubleshooting: resolve issues with controller startup, database connections, Agent registration, Pingora configuration application, and edge cache misses.
- Open Source Acknowledgments: review core open-source projects, derived code provenance, third-party components, and license notices.
Common Scenarios
| Goal | Recommended Guide |
|---|---|
| Start controller and connect first node | Quick Start |
| Test basic HTTP proxy routing | Create Your First Reverse Proxy Rule |
| Configure HTTPS certificates and origin routing | Create a Reverse Proxy Config and TLS Certificates & Auto-Renewal |
| Tune worker threads, connection pools, and cache sizes | Pingora Performance Policies |
| Enable WAF blocking and anti-CC challenge rules | WAF Security Protection and Proof-of-Work (PoW) Protection |
| Host single-page applications with API proxying | Pages Static Hosting Usage |
| Expose intranet services to the public internet | Tunnel & Intranet Penetration |
| Synchronize site uptime monitoring | Uptime Kuma Monitoring Sync |
| Configure enterprise OIDC / OAuth2 login | SSO Login Configuration |
| Diagnose failed configuration sync or cache misses | Troubleshooting |
Documentation Structure
- Deployment: choose a deployment method, install components, and upgrade nodes.
- Reference: look up configuration settings, commands, protocols, and benchmarks.
- Architecture: explore system architecture, data models, configuration synchronization, and security.
- Changelog: review release changes and upgrade notes.