文档中心¶
首次使用从项目首页的快速开始进入;部署与日常操作按主题查阅,开发时参考协议或维护指南。
入门与开发¶
| 文档 | 内容 |
|---|---|
| 扫描器配置与使用指南 | 引擎配置、重连、日志与双栈探测 |
| Scanner-RS 维护文档 | 模块职责、CLI、配置字段与开发约定 |
| 模块化与热更新详细设计 | 基于现有代码的设计提案:Worker 协议、版本绑定、更新事务、回滚与改造步骤 |
| 模块执行与热更新操作指南 | 当前实现:构建、签名制品、在线激活、回滚、HTTPS feed 与兼容边界 |
部署与恢复¶
| 文档 | 内容 |
|---|---|
| 扫描端部署指南 | 部署选型、原生安装、注册、systemd、升级恢复与验收 |
| Docker 构建与部署 | Compose、注册、状态卷、升级排障及镜像构建发布 |
| Nuclei 漏洞扫描部署与运维 | 模板治理、参数语义与上线检查 |
| masscan 标准输出适配与迁移 | 官方 list 输出、兼容模式、切换验证与回滚 |
| 扫描与上传恢复 | 扫描状态持久化与重启恢复 |
| 扫描缓存管理 | 缓存清理、独占锁与状态保护 |
诊断与排障¶
| 文档 | 内容 |
|---|---|
| 扫描端远程诊断 | 诊断队列、日志快照与故障排查 |
文档维护约定¶
- README 提供项目定位、快速开始和主要入口;详细参数、协议及排障保留在专题文档。
- 接口、配置或行为变更时,同步更新使用说明及配套组件文档。
- 示例使用脱敏值,命令注明运行位置,代码块标明语言。
-
区分当前实现与后续计划,保持相对链接和文档索引有效。
-
目标执行反馈:连接采样、失败分类和兼容升级。