zly
|
d6f40cc488
|
docs: 全面更新根目录 README.md 文档
完整重写根目录 README.md，提供系统级文档说明：
📝 新增内容:
1. 系统架构说明
- 添加完整的架构图（Traefik → Supabase/Web Apps/Derper）
- 详细的目录结构说明
- 清晰的服务组织关系
2. 🚀 Supabase 启动说明
- 完整的 docker compose override 启动命令
- docker compose -f docker-compose.yml -f docker-compose.s3.yml up -d
- 详细的启动流程和验证步骤
3. 🌐 URL 路由规划
- 所有服务的访问地址和状态
- Supabase API 端点树状结构
- 路径前缀方案说明
4. Web 应用架构
- web/ws (ABM 数据库项目) 详细说明
- web/gzy, web/zz 待部署项目说明
- 每个项目的启动和配置方法
5. 📊 完整的运维指南
- 服务状态检查命令
- 日志查看方法
- 重启/停止/更新服务流程
- 故障排查步骤
6. 📚 文档导航
- Traefik 部署策略文档链接
- Supabase 完整文档链接
- 示例代码路径
7. ⚙️ 配置说明
- Traefik 核心配置
- Supabase 环境变量
- Web 应用 Traefik 标签配置
8. 🔒 安全配置
- SSL/TLS 证书管理
- API 密钥说明
- 访问控制建议
9. 📝 开发指南
- 添加新 Web 应用的方法
- Vue 项目集成 Supabase 示例
- Storage API 使用示例 (Python/JavaScript)
10. 🎯 最佳实践
- 部署流程
- 备份策略
- 监控和日志
- 性能优化建议
变更统计:
- 新增 529 行
- 删除 26 行
- 从简单说明扩展为完整的系统文档
目标受众:
- 新加入的运维工程师
- 需要部署新服务的开发者
- 系统维护人员
相关文档:
- supabase-stack/README_CN.md (Supabase 详细指南)
- supabase-stack/README_STORAGE.md (Storage 使用)
- docs/strategy-*.md (部署策略文档)
|
2025-11-22 21:54:33 +08:00 |
|