167fad20eb
- 新增 Nezha Agent client_secret 更新 playbook（两种实现方案） - 建立三层文档架构：docs/（用户文档）、examples/（配置示例）、llmdoc/（技术文档） - 添加项目主 README.md 和配置示例文件 - 初始化 .gitignore 保护敏感信息
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
# 如何使用项目文档和示例
|
|
|
|
## 1. 文档目录 (docs/)
|
|
|
|
`docs/` 目录提供了详细的用户文档，包括：
|
|
|
|
- `nezha_update_secret_README.md`: Nezha Agent 配置更新指南
|
|
- `QUICKSTART_nezha.md`: Nezha Agent 快速入门指南
|
|
- `README.md`: 项目文档入口
|
|
|
|
### 使用建议
|
|
|
|
1. 首先阅读 `README.md`，了解项目整体情况
|
|
2. 根据需求查看相应的专项文档
|
|
3. 遵循文档中的操作步骤和最佳实践
|
|
|
|
## 2. 示例目录 (examples/)
|
|
|
|
`examples/` 目录包含各种配置文件示例：
|
|
|
|
- `inventory.example.ini`: Ansible Inventory 配置示例
|
|
- `nezha_vars.example.yml`: Nezha Agent 变量配置示例
|
|
- `xxxigcc_vars.example.yml`: XXXigCC 部署变量示例
|
|
- `journald_vars.example.yml`: Journald 配置变量示例
|
|
|
|
### 使用步骤
|
|
|
|
1. 复制相应的 `.example` 文件
|
|
2. 根据自己的环境修改配置
|
|
3. 在 Playbook 执行时使用修改后的配置文件
|
|
|
|
## 3. 快速复制配置示例
|
|
|
|
```bash
|
|
# 复制 Nezha Agent 变量示例
|
|
cp examples/nezha_vars.example.yml nezha_vars.yml
|
|
|
|
# 编辑配置文件
|
|
vim nezha_vars.yml
|
|
|
|
# 使用配置文件执行 Playbook
|
|
ansible-playbook nezha_update_secret.yml -e @nezha_vars.yml
|
|
```
|
|
|
|
## 4. 推荐实践
|
|
|
|
- 始终保留 `.example` 文件作为参考
|
|
- 将个性化配置文件添加到 `.gitignore`
|
|
- 不要直接修改示例文件
|
|
- 为不同的环境创建不同的配置文件副本 |