From 3755c5754a01cab4a7578c3f0df172848aff26fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89mile?= Date: Thu, 28 Oct 2021 15:32:57 +0200 Subject: [PATCH] update readme for borg client configuration --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 924cb84..4e1cc8e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Borg Backup for YunoHost -[![Integration level](https://dash.yunohost.org/integration/borg.svg)](https://dash.yunohost.org/appci/app/borg) ![](https://ci-apps.yunohost.org/ci/badges/borg.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/borg.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/borg.svg)](https://dash.yunohost.org/appci/app/borg) ![](https://ci-apps.yunohost.org/ci/badges/borg.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/borg.maintain.svg) [![Install Borg with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=borg) -A [Borg](https://borgbackup.readthedocs.io/en/stable/index.html#what-is-borgbackup) implementation to backup a YunoHost server. This is the Borg Backup App to be installed on a server to backup. It works together with a [Borg Server App](https://github.com/YunoHost-Apps/borgserver_ynh) installed on a host server. +A [Borg](https://borgbackup.readthedocs.io/en/stable/index.html#what-is-borgbackup) implementation to backup a YunoHost server. This is the Borg Backup App to be installed on a server to backup. It works together with a [Borg Server App](https://github.com/YunoHost-Apps/borgserver_ynh) installed on a host server. ## :warning: NB. : This doc is partially obsolete and should be reworked! :warning: @@ -22,15 +22,16 @@ You should received an email after the first backup succeeded. ### Set up Borg Backup App on guest Server A Firstly, set up the Borg Backup App (`borg`) on the guest Server A you want to backup: + ``` $ yunohost app install borg -Indicate the domain name of server B where to upload backups: host.serverb -Indicate the ssh user to use to connect on this server: servera -Indicate a strong passphrase, that you will keep preciously if you want to be able to use your backups: N0tAW3akp4ssw0rdYoloMacN!guets -Would you like to backup your YunoHost configuration ? [0 | 1] (default: 1): -Would you like to backup mails and user home directory ? [0 | 1] (default: 1): -Which apps would you backup (list separated by comma or 'all') ? (default: all): -Indicate the backup frequency (see systemd OnCalendar format) (default: Daily): +In which borg repository location do you want to backup your files ?: user@host.serverb:/remote/repository +Provide a strong passphrase to encrypt your backups. No blank space: +Should Borg backup your YunoHost configuration? [yes | no] (default: yes): +Should Borg backup emails and user home directory? [yes | no] (default: yes): +Which apps should Borg backup ? (default: all): +With which regular time schedule should the backups be performed? (see systemd OnCalendar format) (default: Daily): +Do you want admin to receive mail notifications on backups ? [always | errors_only | never]: never ``` #### Syntax to define a backup time schedule @@ -44,7 +45,7 @@ You can schedule regular backups at specific time. Only one regular time schedul * 5,17:00 : Every day at 5 AM and at 5 PM See here for more info : https://wiki.archlinux.org/index.php/Systemd/Timers#Realtime_timer -#### Information generated by Borg Backup +#### Information generated by Borg Backup At the end of the installation, the Borg Backup App (``borg``) displays the SSH public key and the SSH user to give to the person who has access to the host Server B and will set up Borg Server App. ``` You should now install the "Borg Server" app on host.serverb and fill questions like this: @@ -93,9 +94,9 @@ borg list ./::ARCHIVE_NAME | grep db.sql borg list ./::ARCHIVE_NAME | grep dump.sql ``` * Be sure to have your passphrase available even if your server is completely broken - + ## How to restore a complete system - + *For infos on restoring process, check [this yunohost forum thread](https://forum.yunohost.org/t/restoring-whole-yunohost-from-borg-backups/12705/3) and [that one](https://forum.yunohost.org/t/how-to-properly-backup-and-restore/12583/3), also [using Borg with sshkeys](https://thisiscasperslife.wordpress.com/2017/11/28/using-borg-backup-across-ssh-with-sshkeys/), the [`borg extract` documentation](https://borgbackup.readthedocs.io/en/stable/usage/extract.html), and this [general tutorial on Borg Backup](https://practical-admin.com/blog/backups-using-borg/).* In the following explanations: @@ -211,7 +212,7 @@ sudo yunohost backup restore auto_borg_XX_XX_XX_XX:XX --apps [Get the storage space used by the backup repository on the host server](https://borgbackup.readthedocs.io/en/stable/usage/info.html) ``borg info /home/servera/backup`` -### Backup YunoHost apps with different criticallity levels +### Backup YunoHost apps with different criticallity levels If you want to backup your guest server: * with different YunoHost apps