HomeDocs

Documentation

From a 5-minute quickstart to pipeline architecture, configuration reference and the operations CLI — find the section that matches your task.

Quickstart

Complete the first deployment, log in to the console, and configure your first site and upstream in 5 minutes.

Architecture

How the 8-layer request pipeline, AC automaton matching, CC protection, UA / Bot detection and reverse proxy fit together.

Configuration

Sites, upstreams, certificates, rule sets, hot reload and mirror sources — semantics and limits of every option.

OpenAPI ReferencePro

PRO 自动化 API:Bearer Token 鉴权、细粒度作用域、ACL / CC / Sites / 攻击日志等完整接口目录.

Plugins & ExtensionsPro

Native Go plugin extensions inject custom security logic, request rewriting and audit context at millisecond latency.

CLI Cheat Sheet

Once installed, the foxwaf command supports the following subcommands:

CommandPurpose
foxwaf statusRunning status, version, CPU/memory, port listeners
foxwaf logsLive-tail logs
foxwaf restartGracefully restart the service so configuration changes take effect
foxwaf updateCheck and install a new release in GitCode / GitHub / official mirror priority order
foxwaf exportPack configuration / database / certificates / plugins for easy migration
foxwaf import <file>Restore from a backup file (latest file is used when path is omitted)
foxwaf reset-authReset Web console login credentials without a service restart

Need help?

  • On GitHub Issues — file bugs or feature requests
  • Visit Releases for the latest updates and changelog
  • For Business edition and enterprise support, see Pricing