LLI Wiki — My Digital Knowledge Base

BorgBackup vers un stockage distant SSH : commandes utiles

Création de dépôt, sauvegarde, restauration, prune et compactage avec BorgBackup sur un stockage distant.

Cette note rassemble les commandes BorgBackup utilisées pour sauvegarder des hôtes et répertoires Linux vers un stockage distant via SSH (type Hetzner Storage Box, SSH sur le port 23) : création de dépôt, sauvegarde, liste, montage, recherche, restauration, prune et compactage.

Références : Backup and restore files with Borg et Install and configure BorgBackup (Hetzner community).

Dans les exemples, user@example.com est le compte du stockage distant et myrepo un nom de dépôt.

Préparer l'accès SSH

Copier la clé publique vers le stockage, puis tester en SFTP/SSH (adapter le port à votre fournisseur) :

ssh-copy-id -p 23 -s user@example.com
sftp -P 23 user@example.com
ssh -p 23 user@example.com

Initialiser un dépôt et exporter sa clé

borg init --encryption=repokey ssh://user@example.com:23/./backups/myrepo
borg key export --paper ssh://user@example.com:23/./backups/myrepo

Conserver la clé exportée (et la passphrase) en dehors du dépôt, dans un gestionnaire de mots de passe ou sur papier. Sans elles, un dépôt chiffré ne peut pas être restauré.

Enregistrer la clé dans un fichier :

borg key export ssh://user@example.com:23/./backups/myrepo > encrypted-key-backup
borg key export --paper ssh://user@example.com:23/./backups/myrepo > encrypted-key-backup.txt

Lister et monter

borg list ssh://user@example.com:23/./backups/myrepo
borg mount ssh://user@example.com:23/./backups/myrepo mnt/borg/

Rechercher dans une archive (simulation)

Les motifs peuvent être de type shell (sh:), fnmatch (fm:) ou expression régulière (re:) :

borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "sh:**/report.jpg"
borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "sh:**/*.jpg"
borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "fm:*.jpg"
borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "fm:*report*"
borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "re:.*report.*"
borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "sh:home/user/**/*.sh"
borg extract --dry-run -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "sh:var**/*.log"

Restaurer

Retirer --dry-run pour extraire. Si le binaire Borg distant n'est pas dans le chemin par défaut (par exemple sur un NAS), utiliser --remote-path :

borg extract -v --list ssh://user@example.com:23/./backups/myrepo::archive-name "re:home\/.*app.log"
borg extract -v --list --remote-path /usr/local/bin/borg ssh://user@example.com:222/volume1/backups/myrepo::archive-name "path/to/file.jpg"

Créer une sauvegarde

Monter un répertoire distant via SSHFS puis le sauvegarder :

sshfs -o allow_other,default_permissions user@example.com:~/ mnt/website
sudo chmod 777 mnt/website

borg create --stats --progress ssh://user@example.com:23/./backups/website::website-$(date +"%Y-%m-%d-%H%M%S"-${USER}) /home/user/mnt/website/public_html/

Sauvegarder un disque local, la passphrase étant fournie par l'environnement :

export BORG_PASSPHRASE='<PASSWORD>'
borg create --stats --progress ssh://user@example.com:23/./backups/myrepo::data-{now:%Y-%m-%d} /mnt/disk/backup_data/
borg create --stats --progress ssh://user@example.com:23/./backups/myrepo::data-$(date +"%Y-%m-%d-%H%M%S"-${USER}) /mnt/disk/backup_data/

Sauvegarder un stockage cloud monté avec rclone :

rclone mount remote: mnt/cloud/ --daemon
export BORG_PASSPHRASE='<PASSWORD>'
borg create --stats --progress ssh://user@example.com:23/./backups/myrepo::cloud-$(date +"%Y-%m-%d-%H%M%S"-${USER}) ~/mnt/cloud/

Sauvegarder un VPS complet (système de fichiers racine sans les pseudo systèmes de fichiers) :

export BORG_PASSPHRASE='<PASSWORD>'
export REPOSITORY='ssh://user@example.com:23/./backups/myrepo'

borg create -v --stats                   \
$REPOSITORY::'myhost-{now:%Y-%m-%d}'     \
/                                        \
--exclude /dev                           \
--exclude /proc                          \
--exclude /sys                           \
--exclude /var/run                       \
--exclude /run                           \
--exclude /lost+found                    \
--exclude /mnt                           \
--exclude /var/lib/lxcfs ;

Prune

Attention : la rétention s'applique à la date de l'archive, pas à celle des fichiers qu'elle contient. Toujours lancer d'abord avec --dry-run.

borg prune --keep-daily=7 --keep-monthly=6 --keep-yearly=2 -v --list --dry-run ssh://user@example.com:23/./backups/myrepo
borg prune --keep-within=7d --keep-monthly=6 --keep-yearly=2 -v --list --dry-run ssh://user@example.com:23/./backups/myrepo
borg prune --keep-within=7d --keep-monthly=3 --keep-yearly=1 -v --list --dry-run ssh://user@example.com:23/./backups/myrepo

Supprimer des archives

borg delete --progress --save-space --stats --list --info --glob-archives 'myhost*' ssh://user@example.com:23/./backups/myrepo

Compacter

borg compact --progress --verbose --cleanup-commits ssh://user@example.com:23/./backups/myrepo

Informations

borg info ssh://user@example.com:23/./backups/myrepo
borg version ssh://user@example.com:23/./backups/myrepo

Optimisation des performances

Voir Borg backup et compression : performances comparées. Deux réglages utilisés ici :

export BORG_FILES_CACHE_TTL=50
# à ajouter à borg create :
--compression=zstd,3

Remarques

Mastodon LLIMastodon SocialFosstodon