自部署
按应用整理可复用的部署与维护方法,引用 wiki 的工具知识和 compare 的选型分析;具体现场与操作日志在私有仓库维护。
记录内容
- 部署配置:
compose.yaml、环境变量、目录挂载、网络与端口说明。 - 启动与验证:部署前准备、启动和停止步骤、访问入口与运行状态检查。
- 备份与恢复:需要备份的数据、备份方式、恢复步骤及验证记录。
- 日常运维:版本升级、日志查看、资源监控、数据迁移与回滚。
- 踩坑记录:问题现象、排查过程、原因、解决方法和适用版本。
按应用整理
每个应用使用一个目录,将说明文档与配置放在一起。例如:
docs/solution/self-hosted/
├── index.md
└── 应用名/
├── index.md # 应用说明、部署与启动步骤
├── compose.yaml # Compose 配置
├── backup.md # 备份与恢复
├── operations.md # 日常运维
└── troubleshooting.md # 踩坑记录
内容较少时,先集中写在应用的 index.md 中,再按需要拆分。新增 Markdown 文档会自动出现在本栏目的侧边栏中;compose.yaml 可在文档中通过 YAML 代码块展示。
配置中的密码、令牌等敏感值使用环境变量占位,实际值保留在部署环境中。