mirror of
https://github.com/YunoHost-Apps/borg_ynh.git
synced 2024-09-03 18:16:05 +02:00
[fix] Doc title level
This commit is contained in:
ljf (zamentur)
GitHub
parent
48548ae799
commit
e66ffe5998
1 changed files with 12 additions and 12 deletions
24
README.md
24
README.md
|
|
@ -10,7 +10,7 @@
|
|||
|
||||
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.
|
||||
|
||||
# How backup your server with this app ?
|
||||
## How backup your server with this app ?
|
||||
You want to backup a critical "guest" Server A onto a remote "host" Server B, you need:
|
||||
* Domain name of server B: ``host.serverb``
|
||||
* Name of the server B SSH user (to be created by ``borgserver``) for connection from Server A: ``borgservera``
|
||||
|
|
@ -23,7 +23,7 @@ You want to backup a critical "guest" Server A onto a remote "host" Server B, yo
|
|||
|
||||
You should received an email after the first backup succeeded.
|
||||
|
||||
## Set up Borg Backup App on guest Server A
|
||||
### 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_ynh
|
||||
|
|
@ -36,7 +36,7 @@ Which apps would you backup (list separated by comma or 'all') ? (default: all):
|
|||
Indicate the backup frequency (see systemd OnCalendar format) (default: Daily):
|
||||
```
|
||||
|
||||
### Syntax to define a backup time schedule
|
||||
#### Syntax to define a backup time schedule
|
||||
You can schedule regular backups at specific time. Only one regular time schedule is possible for one ``borg`` instance, see below for workaround. Some examples:
|
||||
* Monthly :
|
||||
* Weekly :
|
||||
|
|
@ -47,7 +47,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:
|
||||
|
|
@ -61,7 +61,7 @@ $ cat /root/.ssh/id_borg_ed25519.pub
|
|||
ssh-ed25519 AAAA[...] root@guest.servera
|
||||
```
|
||||
|
||||
## Set up Borg Server App on host Server B
|
||||
### Set up Borg Server App on host Server B
|
||||
Secondly, set up the Borg Server App (``borgserver``) on the host Server B that will store your backups:
|
||||
```
|
||||
$ yunohost app install borgserver
|
||||
|
|
@ -70,7 +70,7 @@ Indicate the public key given by Borg Backup app (borg) setup: ssh-ed25519 AAAA[
|
|||
Indicate the storage quota: 5G
|
||||
```
|
||||
|
||||
## Test the Borg Apps setup
|
||||
### Test the Borg Apps setup
|
||||
At this step your backup should run at the scheduled time. Note that the first backup can take very long, as much data has to be copied through ssh. Following backups are incremental: only newly generated data since last backup will be copied.
|
||||
|
||||
If you want to test correct Borg Apps setup before scheduled time, you can start a backup manually on guest Server A:
|
||||
|
|
@ -84,7 +84,7 @@ $ BORG_RSH="ssh -i /root/.ssh/id_borg_ed25519 -oStrictHostKeyChecking=yes " borg
|
|||
```
|
||||
You will need the passphrase to run ``borg`` commands on the backup repository created on the host Server B.
|
||||
|
||||
# Check regularly your backup
|
||||
## Check regularly your backup
|
||||
If you want to be sure to be able to restore your server, you should try to restore regularly the archives. But this process is quite time consumming.
|
||||
|
||||
You should at least:
|
||||
|
|
@ -92,7 +92,7 @@ You should at least:
|
|||
* Check regularly the presence of info.json and db.sql or dump.sql in your apps archives
|
||||
* Be sure to have your passphrase available even if your server is completely broken
|
||||
|
||||
# How to restore a complete system
|
||||
## 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/).*
|
||||
|
||||
|
|
@ -200,16 +200,16 @@ sudo yunohost app remove borg
|
|||
sudo yunohost backup restore auto_borg_XX_XX_XX_XX:XX --apps
|
||||
```
|
||||
|
||||
# Tips
|
||||
## Tips
|
||||
|
||||
## Edit the list of YunoHost apps to backup
|
||||
### Edit the list of YunoHost apps to backup
|
||||
``yunohost app setting borg apps -v "nextcloud,wordpress"``
|
||||
|
||||
## Other usefull borg commands
|
||||
### Other usefull borg commands
|
||||
[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
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue