Skip to content

README.md

Latest commit

 

History

History
183 lines (139 loc) · 5.33 KB

README.md

File metadata and controls

183 lines (139 loc) · 5.33 KB

Silent-NAS 文档

欢迎使用 Silent-NAS 文档！本目录包含所有用户文档、使用指南和开发者文档。

📖 文档导航

新手入门

  1. 安装指南

    • 系统要求
    • 多种安装方式（二进制/源码/Docker）
    • 依赖服务安装（NATS）
    • 验证安装

  2. 快速开始

    • 5分钟快速体验
    • 基本操作示例

配置和部署

  1. 配置指南

    • 完整配置参数说明
    • 配置模板（开发/生产/集群）
    • 环境变量配置
    • 配置最佳实践

  2. 部署指南

    • 单节点部署
    • 集群部署
    • Docker 部署
    • Systemd 服务配置
    • 反向代理配置（Nginx/Caddy/Traefik）
    • 高可用配置
    • 监控和日志
    • 备份策略
    • 安全加固

  3. 多节点部署指南

    • 多节点部署架构
    • 节点间通信配置
    • 分布式同步设置
    • 故障转移与高可用

API 使用

  1. API 使用指南

    • HTTP REST API
    • WebDAV 协议
    • S3 兼容 API
    • gRPC API
    • 节点同步（管理员 API）
    • 性能监控
    • 错误处理
    • 最佳实践

  2. WebDAV 使用指南

    • WebDAV 功能概览
    • 客户端配置（Finder/Cyberduck/Nextcloud）
    • 版本控制使用
    • 锁管理
    • 常见问题

运维指南

  1. 运行指南

    • 启动和停止服务
    • 日志查看
    • 故障排查
    • 性能测试

  2. 测试脚本总览

    • 压测脚本（Docker）
    • 本地冒烟测试
    • WebDAV 互通测试

  3. 同步排障与故障注入

    • 指标与日志
    • 超时与退避
    • 队列持久化与清理
    • 故障注入开关

开发者文档

  1. 开发者文档索引 📚

    • 技术文档导航
    • 技术栈概览
    • 代码风格指南
    • 开发工作流

  2. WebDAV 技术文档

    • 模块架构与实现
    • 核心能力与扩展
    • 客户端互通测试
    • 报告扩展示例

  3. 搜索功能技术文档

    • 搜索引擎架构
    • 核心模块与 API
    • 性能优化与测试
    • 集成与使用指南

  4. 需求文档

    • WebDAV 需求整理
    • Finder 兼容性要求

  5. 同步需求文档

    • 分布式同步需求
    • 同步协议设计

  6. 指标增强说明

    • v0.6.0 指标增强
    • Prometheus 指标定义

🎯 根据使用场景选择文档

我想快速测试 Silent-NAS

→ README 快速开始 → 运行指南 → 测试脚本总览

我想在生产环境部署

→ 安装指南 → 配置指南 → 部署指南

我想使用 Docker 部署

→ Docker 部署 → Docker README

我想开发应用对接 Silent-NAS

→ API 使用指南 → WebDAV 使用指南

我想部署集群

→ 多节点部署指南 → 部署指南 - 集群部署

我想了解技术实现细节

→ 开发者文档索引 → WebDAV 技术文档 → 搜索功能技术文档

🔗 外部文档

📋 文档版本

当前文档版本: v0.7.0

最后更新: 2025-11-26

🤝 贡献文档

发现文档问题或想要改进？欢迎提交 Pull Request！

文档源文件位置: docs/

💡 获取帮助

📚 文档结构

docs/
├── README.md                    # 本文档索引
├── installation.md              # 安装指南
├── configuration.md             # 配置指南
├── deployment.md                # 部署指南
├── deployment-multi-node.md     # 多节点部署指南
├── api-guide.md                 # API 使用指南
├── webdav-guide.md             # WebDAV 使用指南
├── testing-scripts.md           # 测试脚本总览
├── troubleshooting-sync.md      # 同步故障排查
└── developer/                   # 开发者文档
    ├── README.md                # 开发者文档索引
    ├── webdav-technical.md      # WebDAV 技术文档
    ├── search-technical.md      # 搜索功能技术文档
    ├── requirements.md          # WebDAV 需求文档
    ├── requirements-sync.md     # 同步需求文档
    └── metrics-enhancements.md  # 指标增强说明

提示: 所有文档均使用 Markdown 格式编写，可以在 GitHub 或任何 Markdown 查看器中阅读。