stephondoestech/unraid-config-guardian

Unraid灾难恢复文档自动生成工具

镜像概述

本Docker镜像专为Unraid系统设计，核心功能是自动收集系统配置信息并生成结构化的灾难恢复文档，帮助用户在系统故障时快速定位问题并执行恢复操作，简化Unraid系统的灾难恢复流程。

核心功能与特性

• 自动信息收集：无需人工干预，自动采集Unraid系统关键配置，包括存储布局（阵列、缓存、共享目录）、网络设置、Docker容器配置、虚拟机信息及插件详情
• 结构化文档生成：输出格式支持HTML、Markdown等，内容包含系统架构图、配置参数清单、恢复步骤指南及故障排查流程图
• 定期更新机制：可配置定时任务，实时同步系统配置变更，确保文档与当前系统状态一致
• 多格式导出：支持将生成文档导出为PDF、TXT等格式，便于离线存储或打印归档

适用场景

• 个人Unraid服务器用户：缺乏专业IT支持时，通过文档快速自助恢复系统
• 家庭媒体中心管理员：确保家庭成员可依据文档执行基础故障恢复
• 小型企业Unraid部署：满足合规要求，留存系统配置变更记录，简化多设备管理

使用方法

基础部署（Docker Run）

bash
docker run -d \
  --name=unraid-dr-docs \
  --restart=unless-stopped \
  -v /mnt/user/system:/unraid/system:ro \  # 只读挂载Unraid系统配置目录
  -v /path/to/output:/docs/output \         # 挂载文档输出目录（本地路径）
  -e UPDATE_INTERVAL=24h \                  # 文档更新间隔（支持s/m/h，默认24h）
  -e OUTPUT_FORMAT=html,markdown \          # 输出格式（支持html/markdown/pdf，默认html）
  -e INCLUDE_VMS=true \                     # 是否包含虚拟机信息（true/false，默认true）
  your-image-name:latest

Docker Compose配置

yaml
version: '3'
services:
  unraid-dr-docs:
    image: docker.xuanyuan.run/your-image-name:latest
    container_name: unraid-dr-docs
    restart: unless-stopped
    volumes:
      - /mnt/user/system:/unraid/system:ro
      - /path/to/local/docs:/docs/output
    environment:
      - UPDATE_INTERVAL=12h
      - OUTPUT_FORMAT=pdf
      - INCLUDE_DOCKER=true
      - INCLUDE_PLUGINS=true

环境变量说明

文档访问

生成的文档默认存储在/docs/output目录下（对应宿主机挂载路径/path/to/output），可通过文件管理器直接访问，或配置Web服务器（如Nginx）提供HTTP访问。

注意事项

• 确保挂载的Unraid系统目录（/mnt/user/system）具备只读权限，避免容器修改系统配置
• 首次启动容器后，需等待约5-10分钟（取决于系统复杂度）完成首次文档生成
• 输出目录需确保宿主机用户有读写权限，避免文档生成失败