Files
markbase/docs/README.md
Warren 1300a4e223
Some checks failed
Test / test (push) Has been cancelled
Test / build (push) Has been cancelled
MarkBase架构升级:Multi-Volume Virtual Tree + Dual-View Management + Git Remote修正
核心功能:
-  Categories/Series双视图管理(category_view.rs + import_markdown.rs)
-  FUSE Multi-Volume支持(tree_type参数)
-  SSH/SFTP/SCP/rsync协议完整实现(4042行)
-  NFS/SMB Module Phase 1-3完成
-  Archive Module Phase 1-4完成(2916行)
-  Download Center API完整实现
-  S3兼容API实现(560行)

Git配置修正:
-  删除错误origin(gitea.momentry.ddns.net)
-  删除m5max128(指向机器名)
-  设置origin = m5max128gitea.momentry.ddns.net/admin/markbase
-  设置m4minigitea = m4minigitea.momentry.ddns.net/warren/markbase

数据清理:
-  删除38个临时SQLite(保留accusys.sqlite、demo.sqlite)
-  删除.bak、test_*.bin、调试脚本等临时文件
-  删除临时目录(build/、download files/、raid_test/等)
-  更新.gitignore排除临时文件

架构优化:
- 52个文件修改,2434行新增,4739行删除
- Workspace成员整合(16个crate)
- 数据库状态:accusys.sqlite保留(主demo测试)

远程同步:
-  准备推送到m5max128gitea(远程Gitea)
-  准备推送到m4minigitea(本地Gitea)
2026-06-12 12:59:54 +08:00

101 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 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项目概述