Guide
You will learn: how the OpenFlare docs are organized, which pages to read on first run, and where to start for deployment, usage, and troubleshooting.
OpenFlare is a self-hosted OpenResty control plane. It brings reverse proxy website configs, config version release, Agent node sync, TLS certificates, and basic observability into one admin panel — suitable for a single team or organization managing multiple proxy nodes.
Recommended Reading Path
If you're new to OpenFlare, read in this order:
- Quick Start: start the Server with Docker Compose, log in to the admin panel, and connect your first Agent.
- Publish First Configuration: quickly create a basic HTTP reverse proxy site rule and verify the node applied it.
- Create a Reverse Proxy Config: step by step, from certificate import and application to HTTPS, upstream origins, and edge cache.
- Zone Domain Migration: upgrade from legacy managed domains / inline route domains to the Zone model (automatic goose import), with backup, acceptance, and rollback notes.
- Pages Static Hosting Usage: static project ZIP upload limits, SPA Fallback, and built-in API reverse proxy config.
- Tunnel & Intranet Penetration: deploy Relay and Client for secure reverse penetration without a public IP.
- WAF Security Protection: configure WAF rule groups; master IP allow/block lists, auto/subscription IP groups, geo restrictions, and PoW CC protection.
- WAF Auto IP Group Expressions: write auto IP group Expr rules; understand keyword meanings and preset rules.
- Uptime Kuma Monitoring Sync: configure Uptime Kuma auto differential sync and monitor scope control.
- SSO Login Configuration: configure OIDC for third-party single sign-on (SSO).
- Troubleshooting: troubleshoot login, database, node sync, OpenResty, and edge cache hit issues by symptom.
- Credits: the excellent open-source projects and community acknowledgments this system depends on.
Find by Role
| What you want to do | Recommended Entry |
|---|---|
| Get the admin panel running in 5 minutes | Quick Start |
| Publish your first reverse proxy config | Publish First Configuration |
| Configure domain certs, reverse proxy, and edge cache | Create a Reverse Proxy Config (incl. cache notes) |
| Static assets not hitting cache | Troubleshooting · Edge Cache |
| Host an SPA or static website | Pages Static Hosting Usage |
| Configure intranet penetration mapping | Tunnel & Intranet Penetration |
| Configure anti-CC and IP group blocking | WAF Security Protection |
| Write auto IP group rules | WAF Auto IP Group Expressions |
| Auto-sync monitored site status | Uptime Kuma Monitoring Sync |
| Connect or reinstall a node Agent | Access Agent |
| Start the Server from source | Start the Server |
| Configure OIDC login | SSO Login Configuration |
| Upgrade Server or Agent | Upgrade & Maintenance |
| Understand the architecture and release model | System Architecture and Agent & Publish Model |
| See open-source references and acknowledgments | Credits |
Doc Sections
guide/ targets users and deployers with executable steps from install to daily operations.
reference/ consolidates stable facts: config fields, commands, API response conventions, and repository structure.
design/ targets maintainers and contributors, describing product boundaries, system architecture, the Agent & publish model, and engineering constraints. Before adding capabilities or changing boundaries, update the corresponding design doc first.