Files
wiki/Catalogue-Self-Hosted/apps/app-unraid-guardian.md
T
2026-06-09 18:40:21 +02:00

7.7 KiB
Raw Blame History


title: Unraid Guardian created: 2026-06-07 updated: 2026-06-07 type: app tags: [catalogue, backups, unraid, disaster-recovery, shell, mit] confidence: high contested: false sources: [https://selfh.st/apps/?tag=Backups, https://github.com/stephondoestech/unraid-config-guardian]

💾 Unraid Guardian

Le « plan B » de votre serveur Unraid : exportez toute la config de votre array, de vos VMs, de vos conteneurs et de vos shares dans une archive chiffrée, prête à restaurer sur un Unraid neuf.

📋 Informations Générales

Champ Valeur
Site web (GitHub)
GitHub stephondoestech/unraid-config-guardian
License MIT
Langage Shell (bash)
Étoiles GitHub 169
Dernière MAJ 2026-06-07
Catégorie [[cat-backups

📝 Description

Unraid Guardian est un script shell qui transforme la configuration d'un serveur Unraid en une archive portable, chiffrée et versionnée, permettant de tout reconstruire à l'identique sur une clé USB neuve ou un nouveau serveur Unraid. C'est l'outil de disaster recovery spécifique à l'écosystème Unraid.

Concrètement, il collecte et empaquette :

  • config/ — toute la config système Unraid (network, shares, users, plugins, docker templates modifiés)
  • Disks assignments — l'affectation des disques au array et aux pools
  • VMs / VDisks — définitions des VMs (KVM/QEMU) et chemins de leurs VDisk
  • Docker containers — XML des conteneurs et leur configuration
  • Shares — configuration des shares et règles (mais pas leur contenu — c'est l'affaire d'un autre backup)
  • Plugins / Community Applications — liste des plugins installés pour réinstallation
  • Scripts utilisateur (cron, scripts perso)
  • Chiffrement GPG de l'archive finale (optionnel mais recommandé)
  • Métadonnées : date, version Unraid, taille, hostname
  • Versionnement : garde les N dernières archives (rétention configurable)
  • Push optionnel vers un dossier distant (SFTP, S3, Rclone) — l'archive peut être automatiquement envoyée hors du serveur
  • Cron-friendly : un seul script bash, planifiable

Public cible : utilisateurs Unraid (NAS, homelab, media server) qui veulent un DR réaliste : « si ma clé USB Unraid meurt, puis-je tout reconstruire en 1h ? ». Réponse : oui, avec un Guardian à jour.

🚀 Installation

Unraid (Community Applications)

  1. Community Applications > chercher Unraid Config Guardian (ou ajouter le repo de l'auteur).
  2. Installer le plugin : il ajoute un onglet « Guardian » dans les Settings Unraid.
  3. Configurer : destination locale (/boot/guardian-archives/ ou un share), rétention, chiffrement GPG optionnel, destination distante optionnelle.

Docker (exécution manuelle)

Si vous préférez ne pas l'installer comme plugin Unraid, vous pouvez le lancer comme un conteneur éphémère qui se bind sur la config Unraid :

# docker-compose.yml (à lancer depuis un autre serveur, pas depuis Unraid lui-même)
version: '3.8'
services:
  unraid-guardian:
    image: ghcr.io/stephondoestech/unraid-config-guardian:latest
    container_name: unraid-guardian
    volumes:
      - ./archives:/archives
      - /mnt/user/unraid-config:/unraid-config:ro   # chemin selon votre setup
    environment:
      - TZ=Europe/Paris
      - GUARDIAN_RETENTION=10
      - GUARDIAN_GPG_RECIPIENT=you@example.com
    labels:
      - "traefik.enable=false"

Le montage de la config Unraid en ro est essentiel : Guardian ne doit jamais écrire sur la config source.

⚙️ Configuration Initiale

  1. Installer le plugin via Community Applications.
  2. Choisir la destination des archives : un share /mnt/user/backups/guardian/ est idéal (différent du cache array pour ne pas perdre les archives en cas de crash disque).
  3. Activer le chiffrement GPG (fortement recommandé) : saisir l'ID de votre clé GPG publique ; la passphrase vous sera demandée à la restauration.
  4. Tester une première archive : bouton « Run now » dans l'UI, vérifier que le .tar.gz.gpg est bien créé.
  5. Programmer : un cron quotidien à 04h00 par exemple — l'archive est rapide (pas de data utilisateur, juste la config).
  6. Tester une restauration : sur une VM de test, installer Unraid vierge, restaurer l'archive, vérifier que shares, docker et VMs sont reconfigurés correctement.

🔄 Alternatives

Open Source

  • Unraid built-in backup (Tools > Flash Backup) — ne sauve que la clé USB, pas la config array ni les VM/docker.
  • borg / restic sur /boot et config/ — DIY, plus de contrôle, plus de travail.
  • Duplicati sur le share appdata — backup lourd de toutes les données utilisateur, complémentaire.
  • rsync + cron — pour synchroniser le share appdata (qui contient toutes les configs de conteneurs).
  • CA Appdata Backup / Restore (plugin Unraid) — sauvegarde et restauration rapide d'appdata, complémentaire à Guardian (qui ne sauve que la config système).

Comparaison Unraid Guardian vs autres

Critère Unraid Guardian Flash Backup CA Appdata Borg / Restic
Config système (manuel)
Config Docker (manuel)
Config VMs (manuel)
Plugins (liste) (XML)
Chiffrement GPG AES
Compression
Push distant (Rclone) (S3/SFTP)
Spécialisation Unraid Unraid Unraid Générique

Verdict : Unraid Guardian est le complément parfait d'un backup de données (Borg/Restic/duplicati) : il capture la config système que les backups génériques ratent. À utiliser en plus, pas à la place.

Propriétaires

  • Unraid Pro / Lifetime (payant) — la licence Unraid elle-même, pas un backup à proprement parler.
  • Veeam Agent for Linux — propriétaire, plus orienté VM complète.
  • Backblaze B2 — pas une alternative, juste une destination.

🔐 Sécurité

  • Règle 3-2-1 : l'archive Guardian est locale sur le serveur Unraid — elle mourra avec lui. Activez le push Rclone vers un S3/B2/SFTP distant (cf. strategie-backup-321). Une copie USB manuelle après chaque changement majeur est aussi une bonne idée.
  • Chiffrement GPG : l'archive contient les clés API, tokens Docker, mots de passe de shares en clair. Chiffrez-la systématiquement avec votre clé GPG publique ; seule la clé privée (hors-ligne) permettra de restaurer. Voir securisation-home-lab.
  • Clé GPG hors-ligne : votre clé privée GPG doit être stockée sur papier (paper key) ou USB chiffré LUKS dans un coffre — sans elle, l'archive chiffrée est inutilisable.
  • Test de restauration trimestriel : ne découvrez pas le jour du sinistre que votre archive est corrompue ou que la clé GPG est perdue. Planifiez un DR runbook (cf. strategie-backup-321).

📚 Ressources

Pages Liées