From ab5bdc5bd61106ed5bb4bb36599cbd41e2403e2b Mon Sep 17 00:00:00 2001 From: Arthur BOUDREAULT <arthur@lydra.fr> Date: Mon, 18 Jul 2022 15:19:59 +0200 Subject: [PATCH] docs: refactor YunoHost backup to be more explicit w/ what we expect from user --- roles/ynh_backup/README-FR.md | 8 ++++---- roles/ynh_backup/README.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/roles/ynh_backup/README-FR.md b/roles/ynh_backup/README-FR.md index 3a383e8..d1a13a5 100644 --- a/roles/ynh_backup/README-FR.md +++ b/roles/ynh_backup/README-FR.md @@ -34,10 +34,10 @@ ynh_backup: dest_script: "/usr/bin" ``` -- `ynh_backup.scheduled` : active la fonctionnalité de sauvegarde des applications YunoHost, mettez la valeur à `True`. -- `ynh_backup.directory` : le dossier de sauvegarde par défaut est `/home/yunohost.backup/archives` cependant vous pouvez tout à fait choisir de sauvegarder les backups dans un autre dossier grâce à cette variable. Dans ce cas, de manière à pouvoir restaurer les backups depuis l'interface web, YunoHost créé automatiquement un lien symbolique de l'archive créée vers son dossier par défaut. -- `ynh_backup.scheduled_[hour|minute|weekday|month]`: modifie la planification de la tâche cron. Par défaut, elle se déclenchera tous les jours de l'année à 1 heure du matin. Pour plus d'informations concernant les réglages horaires cron, cet outil peut être utile : <https://crontab.guru/>. -- `ynh_backup.system` : **obligatoire**. Activez la sauvegarde du système YunoHost en mettant la valeur à `True`. +- `ynh_backup.scheduled` : active la fonctionnalité de sauvegarde des applications YunoHost en mettant la valeur à `True`. +- `ynh_backup.directory` : le dossier de sauvegarde par défaut est `/home/yunohost.backup/archives`. Vous pouvez choisir de sauvegarder les backups dans un autre dossier grâce à cette variable. Dans ce cas, de manière à pouvoir restaurer les backups depuis l'interface web, YunoHost créé automatiquement un lien symbolique de l'archive créée vers son dossier par défaut. +- `ynh_backup.scheduled_[hour|minute|weekday|month]`: modifie la planification de la tâche cron. Par défaut, elle se déclenchera tous les jours de l'année à 3 heure du matin. Pour plus d'informations concernant les réglages horaires cron, cet outil peut être utile : <https://crontab.guru/>. +- `ynh_backup.system` : **obligatoire**. Activez la sauvegarde du système YunoHost en mettant la valeur à `True`. A partir du moment où vous activez la fonctionnalité de sauvegarde locale, vous devez choisir entre system ou apps. Si vous mettez `ynh_backup.system` et `ynh_backup.apps` à `False`, les tâches seront ignorées. - `ynh_backup.apps` : **obligatoire**. Activez la sauvegarde des applications YunoHost en mettant la valeur à `True`. ### Sauvegardes distantes avec BorgBackup diff --git a/roles/ynh_backup/README.md b/roles/ynh_backup/README.md index 2c332bd..8d66d7a 100644 --- a/roles/ynh_backup/README.md +++ b/roles/ynh_backup/README.md @@ -34,10 +34,10 @@ ynh_backup: dest_script: "/usr/bin" ``` -- `ynh_backup.scheduled`: to enable the YunoHost applications backup feature, set the value to `True`. -- `ynh_backup.directory`: the default backup folder is `/home/yunohost.backup/archives` however you can choose to save the backups in another folder with this variable. In this case, in order to be able to restore the backups from the web interface, YunoHost automatically creates a symbolic link from the created archive to its default folder. -- `ynh_backup.scheduled_[hour|minute|weekday|month]`: modifies the scheduling of the cron task. By default, it will run every day of the year at 1am. For more information about cron time settings, this tool can be useful: <https://crontab.guru/>. -- `ynh_backup.system`: **mandatory**. Enables automatic backup of the YunoHost system by setting the value to `True`. +- `ynh_backup.scheduled`: Enable the YunoHost applications backup feature by setting the value to `True`. +- `ynh_backup.directory`: the default backup folder is `/home/yunohost.backup/archives`. You can choose to save the backups in another folder with this variable. In this case, in order to be able to restore the backups from the web interface, YunoHost automatically creates a symbolic link from the created archive to its default folder. +- `ynh_backup.scheduled_[hour|minute|weekday|month]`: modifies the scheduling of the cron task. By default, it will run every day of the year at 3am. For more information about cron time settings, this tool can be useful: <https://crontab.guru/>. +- `ynh_backup.system`: **mandatory**. Enables automatic backup of the YunoHost system by setting the value to `True`. From the moment you enable the local backup feature, you must choose between system or apps. If you set `ynh_backup.system` and `ynh_backup.apps` to `False`, tasks will be ignored. - `ynh_backup.apps`: **mandatory**. Enables automatic backup of YunoHost applications by setting the value to `True`. ### remote backups with YunoHost BorgBackup -- GitLab