🚑 Sauvegardes

Dans le contexte de l'auto-hébergement, les sauvegardes (backups) sont un élément important pour pallier les événements inattendus (incendies, corruption de base de données, perte d'accès au serveur, serveur compromis...). La politique de sauvegardes à mettre en place dépend de l'importance des services et des données que vous gérez. Par exemple, sauvegarder un serveur de test aura peu d'intérêt, tandis que vous voudrez être très prudent⋅e si vous gérez des données critiques pour une association ou une entreprise. Dans ce genre de cas, il est crucial d'avoir de disposer de sauvegardes dans un, ou idéalement plusieurs endroits différents.

Sauvegarde manuelle

YunoHost comes with a backup system that allows you to back up (and restore) system configurations and data (e.g. emails) and apps, if they support it.

Vous pouvez gérer vos sauvegardes via la ligne de commande (yunohost backup --help) ou la webadmin (dans la section Sauvegardes) bien que certaines fonctionnalités ne soient pas disponibles via celle-ci.

The current default method consists of creating a .tar archive containing all relevant files.

Créer une sauvegarde

Depuis la webadmin

You can easily create backup archives from the webadmin by going to Backups > Local storage and clicking on New backup. You will then be asked to select which configuration, data and apps you want to back up.

Depuis la ligne de commande

Vous pouvez créer de nouvelles archives depuis la ligne de commande. Voici quelques exemples de commandes et leur comportement correspondant :

• Tout sauvegarder (système et apps) :

yunohost backup create

• Backing up only apps:

yunohost backup create --apps

• Backing up only two apps (WordPress and shaarli):

yunohost backup create --apps wordpress shaarli

• Backing up only emails:

yunohost backup create --system data_mail

• Backing up emails and WordPress:

yunohost backup create --system data_mail --apps wordpress

For more information and options regarding backup creation, consult yunohost backup create --help. You can also list the system parts that can be backed up with yunohost hook list backup.

Télécharger la sauvegarde

Depuis la webadmin

Après avoir créé des sauvegardes, il est possible de les lister et de les inspecter grâce aux vues correspondantes dans l'interface d'administration web. Un bouton propose de télécharger l'archive. Si l'archive fait plus de 3Go, il peut être préférable de procéder via SFTP.

Sauvegarde > Archives locales > <Nom de l'archive> > Télécharger

Avec un client SFTP

À l'heure actuelle, la solution la plus accessible pour récupérer les sauvegardes de grosse taille est d'utiliser le programme FileZilla comme expliqué dans cette page.

Par défaut, les sauvegardes sont stockées dans /home/yunohost.backup/archives/.

Depuis la ligne de commande

Les commandes yunohost backup list et yunohost backup info <archive_name> fournissent des informations sur les noms et les tailles des sauvegardes.

Il est possible d'utiliser scp (un programme basé surssh) pour copier des fichiers entre deux machines grâce à la ligne de commande. Ainsi, depuis une machine sous GNU/Linux, vous pouvez utiliser la commande suivante pour télécharger une archive :

scp admin@your.domain.tld:/home/yunohost.backup/archives/<archive_name>.tar ./

En cas de port SSH autre que 22 :

scp -P ssh_port admin@your.domain.tld:/home/yunohost.backup/archives/<archive_name>.tar ./

attention

Don't forget to store your backup in a different location from your server.

info

If you want, you can connect an external disk to your server so that the archives are saved directly to it. See this guide on adding external storage to your server.

Tester

You should regularly test your backups by at least listing the contents of the archives and checking the size of the associated data. It is best to practice restoration regularly.

# List the files
tar -tvf /home/yunohost.backup/archives/ARCHIVE.tar | less

# List database exports
tar -tvf /home/yunohost.backup/archives/ARCHIVE.tar | grep "(db|dump)`.sql"

# Check the weight
ls -lh /home/yunohost.backup/archives/ARCHIVE.tar

Restaurer

info

SPOILER : Plus votre volume de données et le nombre d'applications sont important, plus votre restauration sera complexe.

Cas simple : peu de données, archive déjà présente

Depuis la webadmin

Allez dans Sauvegardes > Archives locales et sélectionnez l'archive. Vous pouvez ensuite choisir les différents éléments que vous voulez restaurer puis cliquer sur "Restaurer".

Depuis la ligne de commande

From the command line, you can run yunohost backup list to get the available archive names. They are basically their filenames without extensions.

You can then run yunohost backup restore <archivename> (hence without its .tar extension) to restore an archive. As for yunohost backup create, this will restore everything in the archive by default. If you want to restore only specific items, you can use something like yunohost backup restore <archivename> --apps wordpress, which will restore only the WordPress app.

astuce

Dans le cas d'une restauration complète, il est possible de restaurer à la place de lancer la configuration initiale.

To restore an app, the domain on which it was installed should already be configured (or you need to restore the corresponding system configuration). You also cannot restore an app that is already installed... which means that to restore an old version of an app, you must first uninstall it.

Téléverser une archive

Dans de nombreux cas, l'archive n'est pas sur le serveur sur lequel on souhaite la restaurer. Il faut donc la téléverser, ce qui selon son poids peut prend plus ou moins de temps.

Avec un client SFTP

À l'heure actuelle, la solution la plus accessible pour téléverser les sauvegardes est d'utiliser le programme FileZilla comme expliqué dans cette page.

Par défaut, les sauvegardes sont à placer dans /home/yunohost.backup/archives/.

Depuis la ligne de commande

You can use scp (a command built on ssh) to copy files between two machines from the CLI. For example, for a Linux terminal:

scp /path/to/your/<archive_name>.tar admin@your.domain.tld:/home/yunohost.backup/archives/

En cas de port SSH autre que 22 :

scp -P ssh_port /path/to/your/<archive_name>.tar admin@your.domain.tld:/home/yunohost.backup/archives/