OpenFlare/docs/guide/index.md

指南

你会学到：OpenFlare 文档如何组织、首次运行应该读哪些页面，以及部署、使用、排查和开发分别从哪里开始。

OpenFlare 是一套自托管的 OpenResty 控制面。它把反向代理网站配置、配置版本发布、Agent 节点同步、TLS 证书和基础观测放到一个管理端中，适合单团队或单组织管理多台代理节点。

推荐阅读路径

如果你第一次接触 OpenFlare，按下面顺序阅读：

1. 快速开始：用 Docker Compose 启动 Server，登录管理端，并接入第一个 Agent。
2. 基础使用：了解网站配置、源站、证书、发布、回滚和观测的常见操作。
3. 内网穿透与隧道使用：学习部署 Relay 与 Client，实现安全、无公网 IP 反向穿透。
4. WAF 安全防护使用：掌握 IP 黑白名单、自动 IP 组 Expr 自动聚合、地域限制与 PoW CC 防护。
5. WAF 自动 IP 组语法：编写自动 IP 组 Expr 规则，了解关键字含义和预设规则。
6. 部署说明：把 Server 和 Agent 放到更接近生产的环境中运行。
7. 配置项参考：查 Server 环境变量、运行时 Option 和 Agent 配置字段。
8. 故障排查：按症状排查登录、数据库、节点同步、OpenResty 应用和前端构建问题。

按角色查找

你想做什么	推荐入口
5 分钟内跑起管理端	快速开始
发布第一条反向代理配置	发布第一份配置
配置内网穿透映射	内网穿透与隧道使用
配置防 CC 与 IP 组拦截	WAF 安全防护使用
编写自动 IP 组规则	WAF 自动 IP 组语法
接入或重装节点 Agent	接入 Agent
从源码启动 Server	启动 Server
配置 GitHub 或 OIDC 登录	SSO 登录配置
升级 Server 或 Agent	升级与维护
参与开发或修复问题	本地开发 与 开发约束
理解架构和发布模型	系统架构 与 Agent 与发布模型
查看开源引用与致谢	引用与致谢

文档分区

guide/ 面向使用者和部署者，提供从安装到日常操作的可执行步骤。

reference/ 收敛稳定事实，例如配置字段、命令、API 响应约定和仓库结构。

design/ 面向维护者和贡献者，描述产品边界、系统架构、Agent 与发布模型和工程约束。新增能力或改变边界前，应先更新对应设计文档。