Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

文档地图

English version: Documentation Map

本手册采用分批收编的方式构建。下表先列出手册自身的章节,再列出仍位于仓库中的 文档位置,使所有文档都能从同一入口访问。

手册章节

章节内容
概述项目简介、核心能力与服务模型
核心术语与概念AAA 术语、认证请求流转与密码协议
快速开始安装、初始化、首个用户与调试
厂商对接指南MikroTik、华为、Cisco、H3C、中兴、爱快等对接案例
Portal / Hotspot 对接边界铁律:ToughRADIUS 是 RADIUS AAA 后端,不托管 Captive Portal 登录页
场景实战手册端到端运维场景(五段式):MikroTik PPPoE / Hotspot / CoA;华为 BRAS 分级套餐 / 线路绑定 / CoA;H3C / 中兴 / 爱快 / Cisco 差异速查
管理系统用户手册管理控制台逐页说明
运维指南配置参考、证书、监控、备份与命令行工具
LDAP / AD 认证后端针对 LDAP/AD 目录校验口令(仅 PAP 族):bind 模式、TLS、安全、指标
常见问题解答按主题分组的常见问题
协议与 RFC 索引协议标准与代码的对应关系
安全策略安全公告与升级指引
Agent 开发指南面向贡献者的 AI-agent 工作流、质量门禁与自动委托循环摘要

仓库内文档

文档说明当前位置
README项目介绍、特性与快速上手README.md
Agent 指南AI Agent 开发指南与协作规则Agent 开发指南(手册摘要) · AGENT.md(权威)
安全策略安全公告与升级指引安全策略(权威) · SECURITY.md(指针)
功能清单功能范围基线(TR-F 编号)docs/feature-checklist.md · English
路线图长期路线图与里程碑docs/roadmap.zh.md
RFC 索引项目使用的协议标准索引协议与 RFC 索引(权威) · docs/rfcs/README.md(原始目录)

迁移计划。 手册现已覆盖 README 中面向用户的内容(概述、快速开始、厂商 对接、管理手册、运维、FAQ);README 继续作为 GitHub 首页并链接到这里。 Agent 指南现已新增手册摘要章节,指向权威的 AGENT.md; 由于 agent 工具链直接引用,AGENT.md 仍保留在仓库根目录。功能清单与路线图是 由专门流程维护的活文档,保持在 docs/ 中并以链接方式纳入。