Skip to Content
OpenFlare
GuidesDeploymentReferenceArchitectureChangelog

Deployment overview

OpenFlare separates control plane responsibilities from data plane execution. The system consists of four primary components:

Core components and roles

ComponentRoleResponsibilitiesPorts / Network requirementsDeployment guide
OpenFlare ServerControl planeAdmin console UI, Admin APIs, Agent APIs, configuration generation and distribution, metrics aggregationListens on :3000 by default; requires Redis; supports SQLite or PostgreSQL; optional ClickHouseServer deployment
OpenFlare EdgeData planePingora-based edge gateway handling TLS/HTTPS termination, WAF rule enforcement, caching, Pages hosting, and reverse proxy forwardingListens on :80 and :443 by default; outbound access to Server HTTPS portEdge deployment
Relay (TunnelRelay)Tunnel relaySupervises the frps daemon, providing a public entry point for intranet penetration and forwarding traffic received from EdgeListens on :7000 (frpc connections) and :8080 (HTTP Vhost)Relay deployment
OpenFlaredTunnel clientSupervises frpc daemons on private intranet servers, maintaining an encrypted tunnel with the public RelayOutbound access only to Server port and Relay :7000OpenFlared deployment

Deployment decision paths

Select your deployment topology based on your traffic profile and network topology:

  1. Deploy OpenFlare Server: Start the control plane with Server deployment. Use SQLite for local testing or PostgreSQL with Redis for production.
  2. Deploy edge gateways: Set up OpenFlare Edge on gateway servers, or follow Edge node quick access.
  3. Deploy tunnel infrastructure (optional): For private services without public IPs, run a Relay node and install OpenFlared.
  4. Maintain and upgrade: Follow the Upgrade & maintenance guide.

Section directory

Architecture and overview

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.

On this page