YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

[enh] Improve backup docs (#880)

Browse source 
* fix: download in place dowload

* fix: linux -> Linux

* fix: add colons and remove useless space

* fix: nextcloud -> Nextcloud

* fix typos

* remove space before colon

* fix: use only one line

* fix: sync with french

* fix typos

* remove useless spaces
This commit is contained in:
Nicolas Quiniou-Briand 2019-01-06 17:09:54 +01:00 committed by Alexandre Aubin
parent 92c8a4d87a
commit 5fd7fcaa02
2 changed files with 22 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
backup.md
View file

@ -54,22 +54,22 @@ For more informations and options about backup creation, consult `yunohost backu
#### Apps-specific configuration #### Apps-specific configuration
Some apps such as nextcloud may be related to a large quantity of data which are not backuped by default. This practice is referred to "backing up only the core" (of the app). However it's possible to enable the backup of all data of this app with `yunohost app setting nextcloud backup_core_only -v 0`. Be careful though that your archive might get huge if there's too much data to be backuped... Some apps such as Nextcloud may be related to a large quantity of data which are not backuped by default. This practice is referred to "backing up only the core" (of the app). However it's possible to enable the backup of all data of this app with `yunohost app setting nextcloud backup_core_only -v 0`. Be careful though that your archive might get huge if there's too much data to be backuped...
Downloading and uploading backups Downloading and uploading backups
--------------------------------- ---------------------------------
After creating backup archives, it is possible to list and inspect them via the corresponding views in the webadmin, or via `yunohost backup list` and `yunohost backup info <archivename>` from the command line. By default, backups are stored in `/home/yunohost.backup/archives/`. After creating backup archives, it is possible to list and inspect them via the corresponding views in the webadmin, or via `yunohost backup list` and `yunohost backup info <archivename>` from the command line. By default, backups are stored in `/home/yunohost.backup/archives/`.
There is currently no straightfoward way to dowload or upload a backup archive. There is currently no straightfoward way to download or upload a backup archive.
One solution consists in using `scp` (a program based on [`ssh`](/ssh)) to copy files between two machines via the command line. Hence, from a machine running linux, you should be able to run the following to download a specific backup : One solution consists in using `scp` (a program based on [`ssh`](/ssh)) to copy files between two machines via the command line. Hence, from a machine running Linux, you should be able to run the following to download a specific backup:
```bash ```bash
scp admin@your.domain.tld:/home/yunohost.backup/archives/<archivename>.tar.gz ./ scp admin@your.domain.tld:/home/yunohost.backup/archives/<archivename>.tar.gz ./
``` ```
Similarly, you can upload a backup from a machine to your server with Similarly, you can upload a backup from a machine to your server with:
```bash ```bash
scp /path/to/your/<archivename>.tar.gz admin@your.domain.tld:/home/yunohost.backup/archives/ scp /path/to/your/<archivename>.tar.gz admin@your.domain.tld:/home/yunohost.backup/archives/
@ -82,7 +82,7 @@ Restoring backups
#### From the webadmin #### From the webadmin
Go in Backup > Local storage and select your archive. You can then select which items you want to restore, then click 'Restore'. Go in Backup > Local storage and select your archive. You can then select which items you want to restore, then click on 'Restore'.
![](/images/restore.png) ![](/images/restore.png)
@ -96,12 +96,15 @@ To restore an app, the domain on which it was installed should already be config
#### Restoring during the postinstall #### Restoring during the postinstall
One specific feature is the ability to restore a full archive *instead* of the postinstall step. This makes it useful when you want to reinstall a system entirely from an existing backup. To be able to do this, you will need to upload the archive on the server and place it in `/home/yunohost.backup/archives` though. Then, instead of `yunohost tools poinstall` you can run : One specific feature is the ability to restore a full archive *instead* of the postinstall step. This makes it useful when you want to reinstall a system entirely from an existing backup. To be able to do this, you will need to upload the archive on the server and place it in `/home/yunohost.backup/archives`. Then, instead of `yunohost tools postinstall` you can run:
```bash ```bash
yunohost backup restore <archivename> yunohost backup restore <archivename>
``` ```
Note: Don't start the postinstall step. Decline invite when doing installation
via `bash`/`wget`.
To go futher To go futher
------------ ------------

27
backup_fr.md
View file

@ -8,7 +8,7 @@ Les sauvegardes avec YunoHost
YunoHost contient un système de sauvegarde, qui permet de sauvegarder (et restaurer) les configurations du système, les données "système" (comme les mails) et les applications si elles le supportent. YunoHost contient un système de sauvegarde, qui permet de sauvegarder (et restaurer) les configurations du système, les données "système" (comme les mails) et les applications si elles le supportent.
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 disponible via celle-ci. 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.
Actuellement, la méthode de sauvegarde actuelle consiste à créer des archives `.tar.gz` qui contiennent les fichiers pertinents. Pour le futur, YunoHost envisage de supporter nativement [Borg](https://www.borgbackup.org/) qui est une solution plus flexible, performante et puissante pour gérer des sauvegardes. Actuellement, la méthode de sauvegarde actuelle consiste à créer des archives `.tar.gz` qui contiennent les fichiers pertinents. Pour le futur, YunoHost envisage de supporter nativement [Borg](https://www.borgbackup.org/) qui est une solution plus flexible, performante et puissante pour gérer des sauvegardes.
@ -17,7 +17,7 @@ Créer des sauvegardes
#### Depuis la webadmin #### Depuis la webadmin
Vous pouvez facilement créer des archives depuis la webadmin en allant dans Sauvegardes > Archives locales et en cliquant sur "Nouvelle sauvegarde". Vous pourrez ensuite sélectionner quoi sauvegarder (configuration, données "système", applications). Vous pouvez facilement créer des archives depuis la webadmin en allant dans Sauvegardes > Archives locales et en cliquant sur "Nouvelle sauvegarde". Vous pourrez ensuite sélectionner les éléments à sauvegarder (configuration, données "système", applications).
![](/images/backup.png) ![](/images/backup.png)
@ -50,11 +50,11 @@ yunohost backup create --system data_mail
yunohost backup create --system data_mail --apps wordpress yunohost backup create --system data_mail --apps wordpress
``` ```
Pour plus d'informations et d'option sur la création d'archives, consultez `yunohost backup create --help`. Vous pouvez également lister les parties de système qui sont sauvegardable avec `yunohost hook list backup`. Pour plus d'informations et d'options sur la création d'archives, consultez `yunohost backup create --help`. Vous pouvez également lister les parties de système qui sont sauvegardables avec `yunohost hook list backup`.
#### Configuration spécifiques à certaines apps #### Configuration spécifique à certaines apps
Certaines apps comme Nextcloud sont potentiellement rattachées à des quantités importantes de données, qui ne sont pas sauvegardées par défaut. Dans ce cas, on dit que l'app "sauvegarde uniquement le core" (de l'app). Néanmoins, il est possible d'activer la sauvegarde de toutes les données de cette application avec (dans le cas de Nextcloud) `yunohost app setting nextcloud backup_core_only -v 0`. Soyez prudent: en fonction des données stockées dans nextcloud, il se peut que l'archive que vous obtenez ensuite devienne énorme... Certaines apps comme Nextcloud sont potentiellement rattachées à des quantités importantes de données, qui ne sont pas sauvegardées par défaut. Dans ce cas, on dit que l'app "sauvegarde uniquement le core" (de l'app). Néanmoins, il est possible d'activer la sauvegarde de toutes les données de cette application avec (dans le cas de Nextcloud) `yunohost app setting nextcloud backup_core_only -v 0`. Soyez prudent : en fonction des données stockées dans Nextcloud, il se peut que l'archive que vous obtenez ensuite devienne énorme...
Télécharger et téléverser des sauvegardes Télécharger et téléverser des sauvegardes
----------------------------------------- -----------------------------------------
@ -63,13 +63,13 @@ Après avoir créé des sauvegardes, il est possible de les lister et de les ins
Il n'existe actuellement pas de solution "rapide et facile" pour télécharger ou téléverser une archive depuis une autre machine. Il n'existe actuellement pas de solution "rapide et facile" pour télécharger ou téléverser une archive depuis une autre machine.
Une solution consiste à utiliser `scp` (un programme basé sur [`ssh`](/ssh)) pour copier des fichiers entre deux machines grâce à la ligne de commande. Ainsi, depuis une machine sous Linux, vous pouvez utiliser la commande suivante pour télécharger une archive: Une solution consiste à utiliser `scp` (un programme basé sur [`ssh`](/ssh)) pour copier des fichiers entre deux machines grâce à la ligne de commande. Ainsi, depuis une machine sous Linux, vous pouvez utiliser la commande suivante pour télécharger une archive :
```bash ```bash
scp admin@your.domain.tld:/home/yunohost.backup/archives/<nom_d'archive>.tar.gz ./ scp admin@your.domain.tld:/home/yunohost.backup/archives/<nom_d'archive>.tar.gz ./
``` ```
De façon similaire, vous pouvez téléverser une sauvegarde depuis une machine vers votre serveur avec: De façon similaire, vous pouvez téléverser une sauvegarde depuis une machine vers votre serveur avec :
```bash ```bash
scp /path/to/your/<nom_d'archive>.tar.gz admin@your.domain.tld:/home/yunohost.backup/archives/ scp /path/to/your/<nom_d'archive>.tar.gz admin@your.domain.tld:/home/yunohost.backup/archives/
@ -121,30 +121,29 @@ ln -s $PATH_TO_DRIVE/yunohost_backup_archives /home/yunohost.backup/archives
#### Sauvegardes automatiques #### Sauvegardes automatiques
Vous pouvez ajouter une tâche cron pour déclencher automatiquement une sauvegarde régulièrement. Par exemple pour sauvegarder l'application wordpress toutes les semaines, créez un fichier `/etc/cron.weekly/backup-wordpress` avec le contenu suivant: Vous pouvez ajouter une tâche cron pour déclencher automatiquement une sauvegarde régulièrement. Par exemple pour sauvegarder l'application wordpress toutes les semaines, créez un fichier `/etc/cron.weekly/backup-wordpress` avec le contenu suivant :
```bash ```bash
#!/bin/bash #!/bin/bash
yunohost backup create --apps wordpress yunohost backup create --apps wordpress
``` ```
puis rendez-le exécutable :
puis rendez-le exécutable:
```bash ```bash
chown +x /etc/cron.weekly/backup-wordpress chown +x /etc/cron.weekly/backup-wordpress
``` ```
Soyez prudent à propos de ce que vous sauvegardez et de la fréquence: il vaut mieux éviter de se retrouver avec un disque saturé car vous avez voulu sauvegarder 30 Go de données tous les jours... Soyez prudent à propos de ce que vous sauvegardez et de la fréquence : il vaut mieux éviter de se retrouver avec un disque saturé car vous avez voulu sauvegarder 30 Go de données tous les jours...
#### Sauvegarder sur un serveur distant #### Sauvegarder sur un serveur distant
Vous pouvez suivre ce tutoriel sur le forum pour mettre en place Borg entre deux serveurs: https://forum.yunohost.org/t/how-to-backup-your-yunohost-server-on-another-server/3153 Vous pouvez suivre ce tutoriel sur le forum pour mettre en place Borg entre deux serveurs : https://forum.yunohost.org/t/how-to-backup-your-yunohost-server-on-another-server/3153
Il existe aussi l'application Archivist qui permet un système similaire: https://forum.yunohost.org/t/new-app-archivist/3747 Il existe aussi l'application Archivist qui permet un système similaire : https://forum.yunohost.org/t/new-app-archivist/3747
#### Backup complet avec `dd` #### Backup complet avec `dd`
Si vous êtes sur une carte ARM, une autre méthode pour créer une sauvegarde complète consiste à créer une image (copie) de la carte SD. Pour cela, éteignez votre serveur, insérez la carte SD dans votre ordinateur et créez une image avec une commande comme: Si vous êtes sur une carte ARM, une autre méthode pour créer une sauvegarde complète consiste à créer une image (copie) de la carte SD. Pour cela, éteignez votre serveur, insérez la carte SD dans votre ordinateur et créez une image avec une commande comme :
```bash ```bash
dd if=/dev/mmcblk0 of=./backup.img dd if=/dev/mmcblk0 of=./backup.img