# MarkBase配置系统文档索引

## 文档列表

### 1. CONFIG_SYSTEM.md
**完整配置系统文档**

- 配置文件结构（markbase.toml、s3.toml、sftp.toml）
- 所有参数说明（86个参数）
- 验证规则（61个检查）
- CLI命令使用
- REST API endpoint
- 环境变量覆盖
- 生产部署建议

**适合读者：** 系统管理员、运维人员、开发人员

---

### 2. API_USAGE.md
**配置API使用指南**

- 9个API endpoint详细说明
- curl命令示例（完整）
- Python脚本示例
- 错误处理示例
- 批量操作脚本
- 高级用法技巧

**适合读者：** 开发人员、自动化运维

---

### 3. AUDIT_LOG_GUIDE.md
**审计日志使用指南**

- 审计日志结构说明
- 日志查询与分析
- 日志管理（轮转、清理）
- 安全审计应用
- 故障诊断案例
- 最佳实践建议

**适合读者：** 安全审计人员、运维人员

---

## 文档关系

```
CONFIG_SYSTEM.md (完整参数说明)
    ↓
API_USAGE.md (如何通过API修改配置)
    ↓
AUDIT_LOG_GUIDE.md (如何查看配置变更历史)
```

---

## 快速开始

### 1. 初始化配置
```bash
cargo run -- config init
```

### 2. 查看配置
```bash
cargo run -- config show
curl http://localhost:11438/api/v2/config | jq
```

### 3. 编辑配置
```bash
# CLI方式
cargo run -- config edit --key server.port --value 8080

# API方式
curl -X POST "http://localhost:11438/api/v2/config/edit?key=server.port&value=8080"
```

### 4. 查看审计日志
```bash
tail -f logs/config_audit.log | jq
```

---

## 文档版本

**版本：** 2.0
**更新日期：** 2026-06-09
**MarkBase版本：** Phase 2 Complete

---

**相关文档：**
- AGENTS.md - MarkBase开发指南（主文档）
- README.md - MarkBase项目概述