Update README.md

Plan Borg/README.md

@@ -5,6 +5,10 @@
 
 Le plan Borg est une solution de sauvegarde basée sur Borgmatic.
 
+Documentations :
+- Borgmatic : https://torsion.org/borgmatic/docs/reference/command-line/ ;
+- Borgbackups : https://borgbackup.readthedocs.io/en/stable/index.html (recommandation d'aller voir le sous-menu `Usage`).
+
 [[_TOC_]]
 
 # Principes
@@ -16,46 +20,45 @@ Quelques pré-requis :
 
 Organisation des fichiers côté serveur de sauvegarde :
 - /etc/borgmatic/
-  - retention.yaml
-  - excludes
-- /etc/borgmatic.d/
+  - retention.yaml : paramétrage par défaut de la purge, par défaut inclus par les fichiers de configuration de `/etc/borgmatic.d`,
+  - excludes : pattern d'exclusion pour la sauvegarde du serveur de sauvegarde,
+- /etc/borgmatic.d/ : configurations des sauvegardes, 1 fichier par machine pour permettre la personnalisation,
   - fqdn1.yaml
   - fqdn2.yaml
   - …
-- /var/backups/borg/
-  - dobackups.log
-  - dochecks.log
-  - doprunes.log
-  - fqdn1.repo
-  - fqdn2.repo
+- /var/backups/borg/ : espace de stockage des sauvegardes
+  - dobackups.log : log des sauvegardes,
+  - dochecks.log : log des vériciations des sauvegardes,
+  - doprunes.log : log des purges des sauvegardes,
+  - fqdn1.repo : dépôt des sauvegardes de la machine fqdn1,
+  - fqdn2.repo : dépôt des sauvegardes de la machine fqdn2,
   - …
-- /srv/borg/bin/
-  - doreport : TODO
-  - dobackups
-  - doprunes
-  - dochecks
-  - countbackups
-  - dobackup-remote
-  - doinit
-  - doinit-remote
-  - doprunesb
-  - dochecksb
-  - doinit-rsync
-  - doinit-local
-  - dobackup-local
-  - lastbackups
-  - dobackup-rsync
+- /srv/borg/bin/ : ensemble de scripts pour gérer les sauvegardes,
+  - doreport : génère un rapport sur les sauvegardes,
+  - dobackups : lance la sauvegarde de toutes les machines, appelé par `cron`,
+  - doprunes : lance la purge de chaque dépôt de sauvegarde, appelé par `cron`,
+  - dochecks : lance la vériciation de chaque dépôt de sauvegarde, appelé par `cron`,
+  - countbackups : affiche le nombre de sauvegardes pour chaque dépôt de sauvegarde,
+  - dobackup-remote : lance une sauvegarde en mode `remote`, c'est à dire par une commande `ssh`,
+  - doinit : créé un dépôt de sauvegarde dans `/var/backups/borg/`,
+  - doinit-remote : appelle `doinit` et créé le fichier de configuration associé,
+  - doinit-rsync : appelle `doinit` et créé le fichier de configuration associé,
+  - doinit-local : appelle `doinit` et créé le fichier de configuration associé pour le serveur de sauvegarde,
+  - dobackup-local : lance une sauvegarde du serveur de sauvegarde,
+  - lastbackups : affiche la dernière sauvegarde de chaque dépôt,
+  - dobackup-rsync : lance une sauvegarde en mode `rsync`, c'est à dire via un miroir (en cours),
 - /srv/borg/models/
-  - cron
-  - excludes
-  - retention.yaml
-- /srv/borg/.borg-passphrase
-- /srv/borg/.ssh/
+  - cron : modèle pour un fichier `cron`,
+  - excludes : modèle pour l'exclusion par défaut pendant les sauvegardes,
+  - retention.yaml : modèle pour le paramétrage par défaut des purges,
+- /srv/borg/.borg-passphrase : passphrase des dépôts,
+- /srv/borg/.ssh/ :
+  - authorized_keys : définition des accès restreint pour les machines à sauvegarder,
 
 Organisation des fichiers côté machine sauvegardée en mode `remote` :
 - /etc/borgmatic/
-  - config.yaml
-  - excludes
+  - config.yaml : configuration de la sauvegarde,
+  - excludes : liste des patterns d'exclusion de la sauvegarde,
 
 # Installation d'un serveur de sauvegarde
 
@@ -344,25 +347,50 @@ Sys. de fichiers Taille Utilisé Dispo Uti% Monté sur
 
 ## Récupération
 
-Explorer la sauvegarde :
+Lister les sauvegardes de la machine `audio.a-lec.org` :
+```
+$ sudo borgmatic -c /etc/borgmatic.d/audio.a-lec.org.yaml list
+/var/backups/borg/audio.a-lec.org.repo: Listing archives
+2023-01-20T01:34                     Fri, 2023-01-20 01:34:12 [625a6eb4255718932254fa8eda18a17f10ada05d051c1576168758ea1ec9e014]
+2023-01-21T12:52                     Sat, 2023-01-21 12:52:23 [b256357077848c23ca0650164f4ec51ecb97a8bb8fc38d652a8acb1e0968a951]
+2023-01-22T01:03                     Sun, 2023-01-22 01:03:37 [c51614c0545d106881e49942d58d2f1c1adebfe3e11fae22d897de4442dafc58]
+2023-01-23T00:11                     Mon, 2023-01-23 00:11:34 [8c6720c3b4da7646512d90c4f65a6063d95894bfc909e57ef20d94622bfac04f]
+2023-01-24T00:11                     Tue, 2023-01-24 00:11:41 [687d58fd4acfad1bf0f3aa302ed57484e149db7447bef05865888cdf8b2fcc5c]
 ```
 
+Lister les fichiers d'une sauvegarde :
+```
+mkdir -p tmp ; cd tmp
+sudo borgmatic -c /etc/borgmatic.d/audio.a-lec.org.yaml list --archive 2023-01-25T00:11
+/var/backups/borg/audio.a-lec.org.repo: Listing archives
+drwxr-xr-x root   root          0 Fri, 2023-01-20 01:22:45 etc
+drwxr-xr-x root   root          0 Mon, 2021-08-16 17:00:51 etc/console-setup
+-rw-r--r-- root   root         34 Thu, 2019-08-15 16:11:30 etc/console-setup/compose.ARMSCII-8.inc
+-rw-r--r-- root   root         31 Thu, 2019-08-15 16:11:30 etc/console-setup/compose.CP1251.inc
+-rw-r--r-- root   root         31 Thu, 2019-08-15 16:11:30 etc/console-setup/compose.CP1255.inc
+-rw-r--r-- root   root         31 Thu, 2019-08-15 16:11:30 etc/console-setup/compose.CP1256.inc
+-rw-r--r-- root   root        569 Fri, 2022-05-13 11:40:24 etc/fstab
+[…]
 ```
 
-Récupérer un fichier :
+Récupérer un fichier ou un dossier :
 ```
-```
-
-Récupérer un dossier :
-```
-
+mkdir -p tmp ; cd tmp
+sudo borgmatic -c /etc/borgmatic.d/audio.a-lec.org.yaml extract --archive 2023-01-25T00:11 --path /etc/fstab
+ll etc/fstab 
+-rw-r--r-- 1 root root 569 13 mai    2022 etc/fstab
 ```
 
 Récupérer tout une sauvegarde :
 ```
-
+mkdir -p tmp ; cd tmp
+sudo borgmatic -c /etc/borgmatic.d/audio.a-lec.org.yaml extract --archive 2023-01-25T00:11
 ```
 
 ## Suppression
 
-TODO
+Borgmatic ne prévoit pas de commande pour supprimer une sauvegarde. Il faut passer par Borgb :
+```
+borg delete /var/backups/borg/audio.a-lec.org.repo::2023-01-25T00:11
+```
+