Skip to Content
OpenFlare
GuidesDeploymentReferenceArchitectureChangelog

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 SectionPageTopics and Key Specifications
ConfigurationConfiguration Referenceconfig.yaml base settings, environment variable overrides, w_system_configs runtime dynamic options, edge security limits, and Relay / OpenFlared daemon configurations
CLI & ToolingCommands & Scriptsopenflare-server, openflare-edge, openflare-relay, and flared binary subcommands and flags, Makefile build/test targets, and frontend linters
API & ProtocolsAPI & ProtocolsOpenAPI 2.0 / Swagger definition files (docs/swagger.json, docs/swagger.yaml), Swagger UI interactive console, Access Token / Session authentication, response envelopes, and core endpoints
BenchmarksPingora Performance BenchmarksDirect cross-region benchmarking data, throughput/latency comparisons across full WAF, IP-filtering, and disabled WAF, and multi-threaded scaling results

For deeper insights into the underlying architecture and engineering design rationale, refer to the design documentation:

On this page