mirror of
https://github.com/yyhuni/xingrin.git
synced 2026-01-31 11:46:16 +08:00
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# XingRin - 星环 技术文档
|
|
|
|
## 文档目录
|
|
|
|
### 架构设计
|
|
- [版本管理架构](./version-management.md) - Git Tag 驱动的自动化版本管理系统
|
|
- [Nuclei 模板架构](./nuclei-template-architecture.md) - 模板仓库的存储、同步、分发机制
|
|
- [字典文件架构](./wordlist-architecture.md) - 字典文件的存储、同步、分发机制
|
|
|
|
### 开发指南
|
|
- [快速开始](./quick-start.md) - 一键安装和部署指南
|
|
- API 文档（🚧 待补充）
|
|
- 开发环境搭建（🚧 待补充）
|
|
|
|
### 运维手册
|
|
- 故障排查（待补充）
|
|
- 性能优化（待补充）
|
|
- 监控告警（待补充）
|
|
|
|
## 快速导航
|
|
|
|
### 常见问题
|
|
- **版本不一致**：参考 [版本管理 - 故障排查](./version-management.md#故障排查)
|
|
- **镜像拉取失败**：检查网络和 Docker Hub 连接
|
|
- **远程 Worker 部署**：参考版本管理文档中的部署流程
|
|
|
|
### 核心概念
|
|
- **IMAGE_TAG**：版本锁定机制，确保所有组件版本一致
|
|
- **--pull=missing**：镜像拉取策略，优先使用本地缓存
|
|
- **task_distributor**：负载感知任务分发器
|
|
|
|
## 贡献指南
|
|
|
|
### 文档更新
|
|
1. 新增功能时同步更新相关文档
|
|
2. 使用 Mermaid 图表描述复杂流程
|
|
3. 提供具体的命令示例和配置
|
|
|
|
### 文档规范
|
|
- 使用中文编写
|
|
- 代码块标注语言类型
|
|
- 重要概念使用**粗体**标注
|
|
- 提供完整的示例和说明 |