Reference Manual & Specifications
You will learn: what information serves as stable technical reference material, and how to quickly navigate configuration, command-line tooling, RESTful API specifications, performance benchmarks, and architecture models.
This section consolidates stable reference material across OpenFlare runtime environments, interface definitions, engineering structure, and performance specifications for deployment operations, development, and system integration.
Core Reference Index
| Reference Section | Page | Topics and Key Specifications |
|---|---|---|
| Configuration | Configuration Reference | config.yaml base settings, environment variable overrides, w_system_configs runtime dynamic options, edge security limits, and Relay / OpenFlared daemon configurations |
| CLI & Tooling | Commands & Scripts | openflare-server, openflare-edge, openflare-relay, and flared binary subcommands and flags, Makefile build/test targets, and frontend linters |
| API & Protocols | API & Protocols | OpenAPI 2.0 / Swagger definition files (docs/swagger.json, docs/swagger.yaml), Swagger UI interactive console, Access Token / Session authentication, response envelopes, and core endpoints |
| Benchmarks | Pingora Performance Benchmarks | Direct cross-region benchmarking data, throughput/latency comparisons across full WAF, IP-filtering, and disabled WAF, and multi-threaded scaling results |
Related Design & Architecture Standards
For deeper insights into the underlying architecture and engineering design rationale, refer to the design documentation:
- System Topology: System Architecture (control-plane and data-plane decoupling)
- Pingora Edge Engine: Pingora Edge Architecture and Local Edge Development
- Tunnel & Relay: Tunnel and Relay Design
- WAF Engine: WAF Architecture and Rule Orchestration
- Repository Structure: Repository Structure and Monorepo Layering