unsubbed.co

Unraid Guardian

For backup & recovery, Unraid Guardian is a self-hosted solution that provides disaster recovery generator for Unraid.

Disaster recovery for Unraid homelab servers, honestly reviewed. No marketing fluff, just what you get when your flash drive dies at 2 AM.

TL;DR

  • What it is: A Python-based disaster recovery documentation generator for Unraid servers — it automatically exports your entire container configuration, system settings, and recovery scripts so you can rebuild from scratch after a flash drive failure [README].
  • Who it’s for: Unraid homelab operators who have spent months tuning their container stack and never want to recreate it from memory. Not for new users — you need a running Unraid setup first.
  • Cost: Free. Ships as a Docker container, installable via Unraid Community Apps [README].
  • Key strength: One tool that captures everything Unraid forgets to back up by default — container templates, docker-compose fallbacks, system settings, plugin configs — in a format designed for actual recovery, not just archiving.
  • Key weakness: 158 GitHub stars, 3 forks, one maintainer. This is a one-person project in a niche of a niche. It backs up configuration only — your appdata and media need a completely separate solution [README].
  • License: Listed as “NOASSERTION” in the repository metadata, which means the license file exists but wasn’t cleanly parsed. The README shows a license badge but doesn’t clarify the terms explicitly — worth checking before building workflows around it.

What is Unraid Guardian

Unraid Guardian — the full project name is Unraid Config Guardian — is a Docker container you run inside Unraid that reads your live configuration via the Docker API and Unraid’s own /boot/config/ directory, then produces a structured backup package: native XML templates, a docker-compose fallback, system settings JSON, a restore script, and a human-readable step-by-step recovery guide [README].

The pitch is blunt: “Your Unraid flash drive crashed and you don’t have a backup?” [README]. That’s the exact scenario it solves. Unraid runs entirely from a USB flash drive — when that drive dies, which they eventually do, your Docker container configurations, system settings, user shares, plugin configs, and years of careful homelab setup go with it. Unraid doesn’t ship with an automatic configuration backup mechanism out of the box.

What Config Guardian does is sit as a scheduled job (default: weekly, Sunday 2 AM) and export everything you’d need to rebuild — not the data, but the scaffolding. Container templates drop back in via Unraid’s Docker tab. The docker-compose file gives you a fallback path that doesn’t require a functional Unraid template system to work [README].

The project lives at 158 GitHub stars and 3 forks — small by any measure, but that’s consistent with its nature: a utility solving a specific, painful homelab problem rather than a general-purpose platform [merged profile]. It has a CI/CD pipeline, Docker Hub image (stephondoestech/unraid-config-guardian), and an Unraid Community Apps template, which is the primary install path for most users [README].


Why people choose it

There are no published third-party reviews of Config Guardian specifically. The relevant context comes from the Unraid community itself.

The core draw is that Unraid’s architecture creates a specific backup blindspot. Because the OS runs from a flash drive and keeps its configuration there, losing that drive means losing everything that isn’t stored in your appdata volumes. Users writing about their Unraid setups frequently mention the learning curve as the steepest part of the initial setup [2][3] — and anyone who has spent a weekend configuring 20 containers wants insurance against redoing that work.

The noted.lol write-up about Unraid self-hosting captures the mental model well: users come to Unraid because it abstracts away server administration friction, letting them focus on the apps and integrations they actually care about [2]. The Community Apps store does the same thing for container installation. Config Guardian extends that philosophy to disaster recovery — instead of manually documenting your setup or writing your own export scripts, you install one container and the problem is handled.

The r/unRAID discussion on what excites long-term users [1] doesn’t mention Config Guardian by name, but the pattern is consistent: Unraid users get attached to their setups, accumulate complexity over time, and want that complexity to survive hardware failure.

Brandon Brown’s write-up on self-hosting everything with Unraid [3] illustrates the broader problem: stacks grow. His post documents adding Gitea, a Discord bot, Mealie, Scrypted, and Homebox to an existing Plex/Home Assistant setup. A stack that size, rebuilt from scratch after a flash drive failure, is a multi-hour reconstruction job at minimum. Config Guardian is the alternative.


Features

From the README and project structure:

What gets backed up:

  • Running Docker containers via Docker API → exported as native Unraid XML templates and docker-compose fallback [README]
  • Unraid system configuration from /boot/config/ [README]
  • User shares and disk settings [README]
  • Plugin configurations and templates [README]
  • Change log between backups — you can see what changed since the last run [README]

Output package structure:

unraid-backup/
├── container-templates.zip  # Native Unraid XML → drop into Docker tab
├── docker-compose.yml        # Emergency fallback
├── unraid-config.json        # System settings, shares, plugins
├── restore.sh                # Automated restoration script
├── changes.log               # Delta since last backup
└── README.md                 # Step-by-step recovery guide

Web interface: Dashboard at port 7842 with container management and backup generation views [README]. Screenshots in the repo show a clean, functional UI — not polished SaaS, but usable.

Schedule configuration: Cron-style SCHEDULE env var, defaults to weekly [README].

Password masking: MASK_PASSWORDS=true strips sensitive values from the output before saving [README].

REST API: Listed as a canonical feature in the merged profile, though the README doesn’t elaborate on endpoints.

What it does NOT back up: The README is explicit and appropriately emphatic: “Config Guardian only backs up your CONFIGURATION, not your data.” [README]. Your /mnt/user/appdata/ (container data), media files, and any custom scripts are outside scope. The README recommends Kopia, Duplicacy, Rustic, or the CA Backup/Restore plugin as complements [README].


Pricing: SaaS vs self-hosted math

Config Guardian itself is free. The relevant pricing question is Unraid OS, which this tool requires.

Unraid OS runs on a paid license model. As of this writing, the license tiers are based on the number of storage devices in your array (pricing data not available in the provided sources — check https://unraid.net/pricing directly for current numbers). This is a one-time purchase, not a subscription, which is one of the reasons Unraid users tend to stick with it long-term [3].

If you’re already an Unraid user, Config Guardian adds zero cost. If you’re evaluating whether to use Unraid at all, the OS license is the real pricing decision — Config Guardian is just one of many community tools that runs on top of it.

Docker Hub usage for pulling the image is free within normal pull limits.


Deployment reality check

The normal path (existing Unraid user): Community Apps → search “Config Guardian” → install. That’s it [README]. The template handles port mapping, volume mounts, and environment variables. You’re generating your first backup within five minutes.

The emergency path (flash drive just died): This is where the tool’s README earns its keep. The steps are:

  1. Install fresh Unraid on new flash drive
  2. Set up basic array, enable Docker
  3. SSH in, run the five-line docker run command from the README
  4. Restore from your saved backup package

The catch: your backup has to exist before the disaster. Config Guardian requires scheduled, recurring backups stored somewhere outside the Unraid server itself — a network share, an external drive, a cloud destination. If you installed it and never ran a backup, it helps you exactly as much as it costs you: nothing [README].

Volume mount requirements:

  • /var/run/docker.sock:ro — reads container state
  • /boot:ro — reads Unraid flash drive config
  • /mnt/user/appdata/unraid-config-guardian:/config — persistent config
  • /mnt/user/backups/unraid-docs:/output — backup destination

The Docker socket mount is standard for container management tools, but worth noting if you run your homelab with security isolation in mind.

Known issue from the README: Restored templates won’t appear in Unraid’s Docker dropdown unless “Template Authoring Mode” is enabled in Docker settings first. This is an Unraid setting, not a Config Guardian limitation, but it’s a gotcha that will trip someone up during an actual disaster recovery [README].

One-person project means no SLA, no support escalation path, and no guarantee of updates tracking Unraid OS changes. Unraid v7.2.0 shipped in late 2025 with a new responsive web interface and open-source API [4] — behavior of Config Guardian against API changes in newer Unraid versions is not documented.


Pros and Cons

Pros

  • Solves a real, specific pain point. Unraid’s flash-drive-based config storage creates an actual backup gap. This tool closes it cleanly without requiring manual documentation or custom scripts [README].
  • Dead simple install via Community Apps — the primary Unraid app store [README]. No YAML editing, no custom repos.
  • Structured recovery output. The backup package includes native Unraid XML templates (not just compose files), which means restoration is drop-in rather than a port/recreation exercise [README].
  • Change tracking. The changes.log between backups is genuinely useful for auditing what was modified — useful both for disaster recovery and for debugging “when did I add this container?” [README].
  • Password masking. MASK_PASSWORDS=true makes it reasonable to store backups in shared locations or off-site without leaking secrets [README].
  • CI/CD pipeline. The project has automated testing and a proper Docker Hub release flow — not a dump-and-abandon repo [README].
  • Free. For Unraid users, the marginal cost is zero.

Cons

  • 158 stars, one maintainer. This is the dominant risk. Bus factor of one. If the maintainer stops updating it, you’re on your own when Unraid changes its internal config structure [merged profile].
  • Configuration only — not a data backup. The README is clear about this, but it’s easy to install this and feel like you’re covered. You are not covered for your appdata or media [README].
  • License ambiguity. The license field in the metadata is “NOASSERTION.” For a tool you’re relying on for disaster recovery, you want legal clarity. The repo has a LICENSE file — read it before depending on this in any commercial context [merged profile].
  • No external destination support documented. The backup outputs to a local path. You need to separately handle getting that output off the Unraid server. If your server fails catastrophically (disk array + flash drive simultaneously), backups stored on the same box aren’t useful.
  • Unraid-only. This is obvious but complete — it has no value outside of an Unraid environment. If you migrate away from Unraid, this tool goes with it.
  • No community around the tool itself. 3 forks, no visible active issue discussion. Questions go unanswered or go to the broader Unraid forums, not a dedicated community.
  • Template authoring mode gotcha. The one documented recovery pitfall is a foot-gun — templates don’t appear in the dropdown without a specific Unraid setting enabled, and you’re unlikely to remember this during an actual emergency [README].

Who should use this / who shouldn’t

Use Config Guardian if:

  • You’re an established Unraid user with a stack you’d hate to rebuild from scratch.
  • You already use Community Apps and are comfortable with basic Docker container settings.
  • You’ve thought “I should document my setup” more than once and never done it.
  • You pair it with a real data backup tool (Kopia, Duplicacy, CA Backup) — Config Guardian is the config layer, not the replacement for the data layer.

Skip it if:

  • You’re evaluating Unraid and haven’t committed yet — this tool has no standalone value.
  • You want a comprehensive backup solution. This is specifically a configuration documentation tool.
  • You’re running a production workload where a single-maintainer community tool in the DR path is unacceptable.
  • You need verified recovery — the tool lacks documented testing of the restore path against current Unraid versions.

Consider it carefully if:

  • You’re storing the backup output on the same Unraid server without replication. A hardware failure that kills the flash drive and corrupts the array simultaneously also kills your backups.
  • You care about license clarity — the “NOASSERTION” status needs manual verification before using this in any formal context.

Alternatives worth considering

For the Unraid config backup problem specifically:

  • CA Backup/Restore Appdata — a Community Apps plugin focused on appdata backups. Different scope (data, not config scaffolding), but mentioned in Config Guardian’s README as a complement [README].
  • Appdata Backup plugin — another Unraid plugin in the same backup category. Widely used in the community [README].
  • Manual documentation — some homelab operators maintain a git repo with their docker-compose files and run Watchtower or similar for updates. Manual but zero dependency risk.
  • Kopia / Duplicacy / Rustic — full backup tools recommended by Config Guardian itself for the data layer [README]. Can be configured to also snapshot config directories.
  • Unraid’s built-in flash backup — Unraid has a flash drive backup option in the web UI that archives the USB contents. This covers the same ground as Config Guardian but is less structured for actual recovery — no compose files, no restore script.

For context: Unraid v7.2.0 shipped with an open-source API [4], which may enable more capable first-party or community backup tooling going forward. Worth watching.


Bottom line

Unraid Config Guardian does one thing: it prevents the specific misery of rebuilding a complex Unraid container stack from memory after a flash drive failure. For that problem, it’s the best free, one-click solution available via Community Apps. The output is thoughtfully structured — native XML templates, a docker-compose fallback, a restore script, and change tracking between runs.

The risks are real and worth stating plainly: one maintainer, ambiguous license, no external backup destination built in, and no recovery test documentation. If your homelab is a weekend project, these risks are acceptable. If your Unraid box is running anything business-critical, the single-maintainer dependency belongs in your risk register.

The correct mental model: Config Guardian is a fire extinguisher for a specific, well-defined fire. Install it, run weekly backups, store the output somewhere off the server. Pair it with Kopia or Appdata Backup for the actual data. Then stop thinking about it until the flash drive dies — and when it does, you’ll be very glad you spent the ten minutes.


Sources

  1. r/unRAID — “UnRAID Long Term Users, What Excites You at the Moment with Unraid?” — reddit.com. https://www.reddit.com/r/unRAID/comments/13iq2xi/unraid_long_term_users_what_excites_you_at_the/

  2. “How Unraid Helps Me Get the Most Out of Self-Hosting” — noted.lol. https://noted.lol/unraid-a-self-hosting-story/

  3. Brandon Brown — “How to self-host (almost) everything in your life with unRAID” — brandonb.ca. https://brandonb.ca/how-to-self-host-almost-everything-in-your-life-with-unraid

  4. “Self-Host Weekly (31 October 2025)” — selfh.st. https://selfh.st/weekly/2025-10-31/

  5. Unraid Forums — “Getting started with Unraid and self-hosting” — forums.unraid.net. https://forums.unraid.net/topic/185690-getting-started-with-unraid-and-self-hosting/

Primary sources:

Features

Integrations & APIs

  • Plugin / Extension System
  • REST API