Deployment overview
OpenFlare separates control plane responsibilities from data plane execution. The system consists of four primary components:
Core components and roles
| Component | Role | Responsibilities | Ports / Network requirements | Deployment guide |
|---|---|---|---|---|
| OpenFlare Server | Control plane | Admin console UI, Admin APIs, Agent APIs, configuration generation and distribution, metrics aggregation | Listens on :3000 by default; requires Redis; supports SQLite or PostgreSQL; optional ClickHouse | Server deployment |
| OpenFlare Edge | Data plane | Pingora-based edge gateway handling TLS/HTTPS termination, WAF rule enforcement, caching, Pages hosting, and reverse proxy forwarding | Listens on :80 and :443 by default; outbound access to Server HTTPS port | Edge deployment |
| Relay (TunnelRelay) | Tunnel relay | Supervises the frps daemon, providing a public entry point for intranet penetration and forwarding traffic received from Edge | Listens on :7000 (frpc connections) and :8080 (HTTP Vhost) | Relay deployment |
| OpenFlared | Tunnel client | Supervises frpc daemons on private intranet servers, maintaining an encrypted tunnel with the public Relay | Outbound access only to Server port and Relay :7000 | OpenFlared deployment |
Deployment decision paths
Select your deployment topology based on your traffic profile and network topology:
Recommended deployment flow
- Deploy OpenFlare Server: Start the control plane with Server deployment. Use SQLite for local testing or PostgreSQL with Redis for production.
- Deploy edge gateways: Set up OpenFlare Edge on gateway servers, or follow Edge node quick access.
- Deploy tunnel infrastructure (optional): For private services without public IPs, run a Relay node and install OpenFlared.
- Maintain and upgrade: Follow the Upgrade & maintenance guide.
Section directory
Architecture and overview
- Architecture & deployment notes: Network flow diagrams, hardware baseline requirements, source builds, and Docker Compose configurations.
Components
- Server deployment: SQLite single-container, PostgreSQL production, ClickHouse/Jaeger observability, and source compilation.
- Edge node quick access: Node tokens, installation parameters, and health checks.
- OpenFlare Edge deployment: Packaging specifications, systemd low-privilege profiles, Docker deployments, and atomic updates.
Tunnel infrastructure
- Relay deployment: TunnelRelay node configuration, frps daemon management, and port mapping rules.
- OpenFlared client deployment: Intranet client configuration, frpc child process management, and automated version synchronization.
Maintenance
- Upgrade & maintenance: Migrating from OpenResty to Pingora Edge, container and source upgrades, automatic edge updates, and recovery steps.