Unraid Config Guardian

Unraid Config Guardian is a Python-based tool that automates documentation of an Unraid server's configuration to enable rapid recovery after a flash drive or configuration loss. It inspects running containers and system config to produce Docker Compose files, native Unraid templates, restoration scripts, and a step-by-step rebuild guide.

Key Features

• Generates docker-compose.yml and native Unraid container templates from running containers
• Exports Unraid system settings, user shares, plugin configurations, and a consolidated unraid-config.json
• Produces an automated restore.sh script and human-readable README with step-by-step recovery instructions
• Tracks changes between backups and emits a changes.log for auditability
• Scheduling support for automated backups (cron-style SCHEDULE environment variable)
• Option to mask sensitive values (MASK_PASSWORDS) and run as a Docker container that reads /boot and the Docker socket

Use Cases

• Recover quickly from a failed Unraid flash drive by rebuilding containers and restoring system settings
• Regularly document configuration drift across a homelab to track changes and simplify audits
• Provide operators with emergency restore artifacts (compose files, templates, scripts) to onboard replacement hardware

Limitations and Considerations

• This tool only captures configuration and templates; it does not back up container data, appdata, or media files
• Requires read access to the Unraid /boot config and the Docker socket, which may require elevated permissions
• Some Unraid-specific template or plugin behavior may need manual post-restore steps; template dropdown population can require Template Authoring Mode

Unraid Config Guardian is intended to complement data backup solutions by preserving the server configuration and automation needed for fast recovery. It is useful for homelabs and small Unraid deployments where configuration rebuild time must be minimized.