🛡️ Backup_Borg — Borg + Docker + SMS (Free Mobile)

---

Table des matières

🇫🇷 Français

• Fonctionnalités
• Prérequis
• Installation rapide
• Configuration
• Cron exemple
• Logs & Monitoring
• Notes de sécurité (important)
• FAQ
• Contribuer
• Licence

Fonctionnalités

• 🚀 Monte un NAS CIFS et effectue les sauvegardes automatiquement
• 🐳 Export optionnel des conteneurs Docker en archives tar.gz
• 💾 Sauvegarde complète du serveur avec BorgBackup (déduplication + compression)
• 🧹 Suppression automatique des anciennes sauvegardes (Docker >10j, Borg >40j)
• 📲 Notifications SMS via Free Mobile pour suivre succès/erreurs
• 🔁 Paramètres sûrs (set -euo pipefail) et exclusions intelligentes

Prérequis

• Debian/Ubuntu (testé)
• Droits sudo
• Accès réseau au NAS
• (Optionnel) Docker pour export des conteneurs
• (Optionnel) Compte Free Mobile (user + token) pour SMS

Installation rapide

1. Copier le script et rendre exécutable :

sudo cp backup /usr/local/bin/backup
sudo chmod +x /usr/local/bin/backup

2. Créer le dossier de configuration et les fichiers secrets :

sudo mkdir -p /etc/backup_script
sudo nano /etc/backup_script/smb.conf   # Identifiants CIFS
sudo nano /etc/backup_script/borg_pass  # Mot de passe Borg, chmod 600
sudo chmod 600 /etc/backup_script/*

3. Tester le script :

sudo /usr/local/bin/backup -h    # aide
sudo /usr/local/bin/backup      # sauvegarde manuelle

Configuration

Modifier les variables en début de script :

SOURCE_DIR="/"
DEST_DIR="/var/backup"
MOUNT_POINT="/var/backup"
NAS_SERVER="192.168.1.10"
CONFIG_FILE="/etc/backup_script/smb.conf"
BORG_PASSPHRASE="$(cat /etc/backup_script/borg_pass)"
DOCKER="1"
BACKUP_DOCKER="/var/backups/docker/"
NAME_FOR_NOTIFY="mon-serveur"
FREE_MOBILE_USER="0123456789"
FREE_MOBILE_CODE_AUTH="abcdEFGhijk"
PHONE_NUMBER="+33XXXXXXXXX"

CIFS /etc/backup_script/smb.conf :

username=MON_USER
password=MON_MOT_DE_PASSE
domain=MON_DOMAINE  # optionnel

🔒 Protéger le fichier : chmod 600 /etc/backup_script/smb.conf

Cron exemple

Exécution chaque nuit à 03h00 :

0 3 * * * /usr/local/bin/backup >> /var/log/backup_cron.log 2>&1

Logs & Monitoring

• Fichier log principal : /var/log/backup.log
• Suivi des exports Docker, sauvegarde Borg, montage/démontage NAS
• Intégration possible avec Prometheus/ELK/syslog

Notes de sécurité (important)

• Ne jamais rendre BORG_PASSPHRASE world-readable
• Préférer fichier ou variable d'environnement pour secrets
• Ajouter un lockfile pour éviter les exécutions concurrentes
• Tester régulièrement la restauration

FAQ

Q — Pourquoi Borg ?
A — Déduplication, compression et sécurité intégrée pour vos backups.

Q — Les SMS ne fonctionnent pas ?
A — Tester l’API Free Mobile manuellement :

curl -G --data-urlencode "msg=hello" "https://smsapi.free-mobile.fr/sendmsg?user=USER&pass=CODE"

Q — Les exports Docker sont volumineux ?
A — Oui. Préférer docker save ou un registre externe si nécessaire.

Contribuer

• Ajouter un service systemd + timer pour planification propre
• Ajouter un lockfile
• Ajouter mode dry-run / tests unitaires
• Support pour notifications Slack/Teams

Licence

MIT © Titithen00b

---

🇬🇧 English

• Features
• Prerequisites
• Quick start
• Configuration
• Cron example
• Logs & Monitoring
• Security notes (must-read)
• FAQ
• Contributing
• License

Features

• 🚀 Mount a CIFS NAS and run backups automatically
• 🐳 Optional export of Docker containers to tar.gz archives
• 💾 Full server backup with BorgBackup (deduplication + compression)
• 🧹 Auto-prune old backups (Docker >10d, Borg >40d)
• 📲 SMS notifications via Free Mobile for success/error tracking
• 🔁 Safe defaults (set -euo pipefail) and smart excludes

Prerequisites

• Debian/Ubuntu (tested)
• sudo privileges
• Network access to NAS
• (Optional) Docker access
• (Optional) Free Mobile account (user + auth token) for SMS notifications

Quick start

1. Copy script and make executable:

sudo cp backup /usr/local/bin/backup
sudo chmod +x /usr/local/bin/backup

2. Create config folder and credentials:

sudo mkdir -p /etc/backup_script
sudo nano /etc/backup_script/smb.conf
sudo nano /etc/backup_script/borg_pass
sudo chmod 600 /etc/backup_script/*

3. Test manually:

sudo /usr/local/bin/backup -h
sudo /usr/local/bin/backup

Configuration

Set variables at the top of the script:

SOURCE_DIR="/"
DEST_DIR="/var/backup"
MOUNT_POINT="/var/backup"
NAS_SERVER="192.168.1.10"
CONFIG_FILE="/etc/backup_script/smb.conf"
BORG_PASSPHRASE="$(cat /etc/backup_script/borg_pass)"
DOCKER="1"
BACKUP_DOCKER="/var/backups/docker/"
NAME_FOR_NOTIFY="my-server"
FREE_MOBILE_USER="0123456789"
FREE_MOBILE_CODE_AUTH="abcdEFGhijk"
PHONE_NUMBER="+33XXXXXXXXX"

CIFS file /etc/backup_script/smb.conf:

username=MY_USER
password=MY_PASSWORD
domain=MY_DOMAIN  # optional

🔒 Protect credentials: chmod 600 /etc/backup_script/smb.conf

Cron example

Nightly at 03:00:

0 3 * * * /usr/local/bin/backup >> /var/log/backup_cron.log 2>&1

Logs & Monitoring

• Main log: /var/log/backup.log
• Tracks Docker export, Borg backup, NAS mount/unmount
• Can be integrated into Prometheus/ELK/syslog

Security notes (must-read)

• Never make BORG_PASSPHRASE world-readable
• Prefer environment variable or file for secrets
• Add lockfile to prevent concurrent runs
• Test restores regularly

FAQ

Q — Why Borg?
A — Deduplication, compression and built-in encryption for backups.

Q — SMS not received?
A — Test Free Mobile API manually:

curl -G --data-urlencode "msg=hello" "https://smsapi.free-mobile.fr/sendmsg?user=USER&pass=CODE"

Q — Docker exports are large?
A — Consider docker save or external registry; export containers only if necessary.

Contributing

• Add systemd service + timer for clean scheduling
• Add lockfile
• Add dry-run / unit tests
• Support for Slack/Teams notifications

License

MIT © Titithen00b