Sauvegardes

Gardez une copie de votre configuration pour la remettre en place après une mauvaise mise à jour, un disque en panne ou un passage sur une nouvelle machine.

Avant de commencer

• Settings > Backups (Paramètres > Sauvegardes) demande la permission Change settings (modifier les paramètres). Seul le propriétaire peut restaurer.
• Télécharger, supprimer et restaurer demandent une connexion par mot de passe datant de quelques minutes au plus.

Faire une sauvegarde

1. Ouvrez Settings > Backups.
2. Choisissez Back up now (sauvegarder maintenant). Vous devriez voir la nouvelle sauvegarde sous Saved backups (sauvegardes enregistrées).
3. Choisissez Download (télécharger) à côté d’elle pour en garder une copie hors du serveur.

Mettre la clé maîtresse à l’abri

Les sauvegardes ne contiennent jamais la clé maîtresse, celle qui ouvre les mots de passe et les clés API de vos paramètres. Sans la bonne clé, une sauvegarde restaurée ne peut pas les lire.

1. Sous Master key (clé maîtresse), le propriétaire choisit Download key kit (télécharger le kit de clé).
2. Gardez le fichier loin du serveur et à l’écart de vos sauvegardes. Vous devriez voir l’avertissement du kit de clé disparaître de Settings > Backups et des contrôles de santé.

Pour vous en servir plus tard, renommez-le en holyarrs.key et placez-le dans le dossier de configuration. Vous n’êtes pas le propriétaire ? Demandez-lui de le télécharger.

Restaurer une sauvegarde

Danger

Les changements faits depuis la sauvegarde sont perdus. Ayez d’abord la bonne clé maîtresse sous la main.

1. Appuyez sur Restore from a file (restaurer depuis un fichier) et choisissez un zip de sauvegarde HolyArrs.
2. Confirmez.
3. HolyArrs vérifie le fichier. Vous devriez voir Restore ready. It applies on the next start. (restauration prête, elle s’applique au prochain démarrage).
4. HolyArrs redémarre et met la sauvegarde en place. Avec la politique de redémarrage Docker recommandée, ça se fait tout seul.

Vos bases de données actuelles sont déplacées dans /config/backups/before-restore-<time>, ce qui permet d’annuler une restauration.

Options

À quelle fréquence

Option	Sauvegarde	Conserve
Balanced (équilibré, par défaut)	Tous les jours	Les 7 derniers jours et 4 copies hebdomadaires
Light (léger)	Une fois par semaine	4 semaines. Le moins de place
Careful (prudent)	Tous les jours	Toutes les copies pendant 30 jours

La sauvegarde planifiée la plus récente est toujours conservée. Ces règles ne nettoient que les sauvegardes planifiées. Celles que vous faites vous-même restent jusqu’à ce que vous les supprimiez (bouton corbeille sur la ligne ; c’est définitif). HolyArrs sauvegarde aussi avant une mise à jour qui modifie les données stockées et garde les 3 plus récentes ; voir Mises à jour.

Passer sur une nouvelle machine

Une nouvelle installation crée sa propre clé maîtresse au premier démarrage. Cette clé ne peut pas ouvrir vos anciennes sauvegardes, donc la restauration est refusée. Mettez d’abord l’ancienne clé en place. Dans les exemples, le conteneur s’appelle holyarrs ; utilisez votre propre nom.

1. Avant le premier démarrage, créez le conteneur sans le démarrer : docker compose create, ou votre ligne docker run avec docker create à la place de docker run -d.
2. Copiez votre ancienne clé dedans : docker cp holyarrs.key holyarrs:/config/. Un kit de clé renommé en holyarrs.key convient aussi. Ça fonctionne avec un volume nommé comme avec un dossier de l’hôte ; au démarrage, HolyArrs attribue les fichiers de /config à vos PUID et PGID. Si vous utilisez HOLYARRS_MASTER_KEY_FILE, placez plutôt la clé à ce chemin sur l’hôte, lisible par vos PUID et PGID.
3. Restaurez la sauvegarde. Choisissez une des deux façons :

   • Démarrez HolyArrs, terminez le premier lancement, puis utilisez Restore from a file dans Settings > Backups.

   • Ou restaurez avant le premier démarrage. Placez le zip, sans changer son nom, dans un dossier appelé backups et copiez-le avec docker cp backups holyarrs:/config/. Lancez ensuite la restauration une fois avec la même image :

     • Compose : docker compose run --rm holyarrs restore <zip name>
     • Docker CLI : docker run --rm --volumes-from holyarrs -e PUID=<puid> -e PGID=<pgid> holyarrs/holyarrs:<tag> restore <zip name>

     Avec un chemin de fichier de clé, ajoutez -e HOLYARRS_MASTER_KEY_FILE=<its path> pour que la restauration se vérifie avec votre clé. restore --list affiche les noms des sauvegardes qu’il voit.

4. Démarrez HolyArrs. Vous devriez retrouver votre bibliothèque et vos paramètres.

Vous avez démarré la nouvelle installation avant de copier la clé ? S’il n’y a rien à garder dessus, arrêtez HolyArrs, copiez votre ancienne clé par-dessus la nouvelle avec le même docker cp, restaurez, puis démarrez.

Si ça ne fonctionne pas

Symptôme : « Backups are off in this build ». Cause : cette copie tourne sans son gestionnaire de sauvegardes. Solution : aucune dans l’application ; il n’y a pas de commandes de sauvegarde.

Symptôme : télécharger, supprimer ou restaurer vous demande votre mot de passe. Cause : ces actions demandent une connexion récente par mot de passe. Solution : connectez-vous de nouveau avec votre mot de passe et réessayez.

Symptôme : la restauration est refusée à cause de la clé maîtresse. Cause : la clé du dossier de configuration ne correspond pas à la sauvegarde. Solution : remettez le bon holyarrs.key en place et réessayez.

La restauration refuse aussi un zip trop gros ou abîmé, qui contient des fichiers inattendus, qui vient d’une version de base de données plus récente ou qui contient des données que votre clé ne peut pas lire.

Pour les experts

Ce que contient une sauvegarde

Chaque sauvegarde est un zip avec la base de données principale, la base de données des événements s’il y en a une, et backup.json (version de HolyArrs, versions des bases de données, type de sauvegarde, date de création). Les médias, les téléchargements, les illustrations, les journaux et la clé maîtresse n’y sont pas.

Restaurer avant le premier démarrage

docker cp fonctionne avec un volume nommé comme avec un dossier de l’hôte ; au démarrage, HolyArrs attribue les fichiers de /config à vos PUID et PGID. Avec HOLYARRS_MASTER_KEY_FILE, placez plutôt la clé à ce chemin sur l’hôte, lisible par PUID et PGID.

1. Placez le zip, sans changer son nom, dans un dossier appelé backups et copiez-le : docker cp backups holyarrs:/config/.
2. Lancez la restauration une fois avec la même image :
   • Compose : docker compose run --rm holyarrs restore <zip name>
   • Docker CLI : docker run --rm --volumes-from holyarrs -e PUID=<puid> -e PGID=<pgid> holyarrs/holyarrs:<tag> restore <zip name>
3. Avec un chemin de fichier de clé, ajoutez -e HOLYARRS_MASTER_KEY_FILE=<its path> pour que la restauration se vérifie avec votre clé.
4. Démarrez HolyArrs.

restore --list affiche les noms des sauvegardes qu’il voit.

Voir aussi

• Mises à jour
• Installer
• Contrôles de santé