248 lines
7.3 KiB
Markdown
248 lines
7.3 KiB
Markdown
# đ gitea-backup
|
|
|
|
> Script Bash professionnel de **sauvegarde et restauration complĂšte de Gitea** â base de donnĂ©es, dĂ©pĂŽts Git, LFS, avatars, attachments, configuration `app.ini`, clĂ©s SSH â avec menu interactif et planification cron intĂ©grĂ©e.
|
|
|
|
---
|
|
|
|
## ⚠Fonctionnalités
|
|
|
|
| Fonctionnalité | Détail |
|
|
|---|---|
|
|
| đŸ **Sauvegarde complĂšte** | DB + dĂ©pĂŽts Git + LFS + avatars + attachments + config |
|
|
| đ **Restauration interactive** | Menu avec 5 modes de restauration ciblĂ©e |
|
|
| đïž **Multi-base de donnĂ©es** | PostgreSQL, MySQL/MariaDB, SQLite3 â auto-dĂ©tection via `app.ini` |
|
|
| 𧰠**`gitea dump` natif** | Intégration optionnelle de la commande officielle Gitea en complément |
|
|
| Ⱐ**Planification cron** | Fréquences prédéfinies ou expression personnalisée + notifications email |
|
|
| đ **Manifest d'archive** | Version Gitea, stats dĂ©pĂŽts, taille LFS, extrait `app.ini` |
|
|
| đ **Rotation automatique** | Conservation configurable des N derniĂšres archives |
|
|
| đĄïž **ArrĂȘt/relance automatique** | Gitea est stoppĂ© proprement avant restauration, relancĂ© aprĂšs |
|
|
| đ **ClĂ©s SSH incluses** | Sauvegarde du rĂ©pertoire `.ssh` de l'utilisateur Gitea |
|
|
| đ **Journal** | Logging horodatĂ© dans `/var/log/gitea-backup.log` |
|
|
|
|
---
|
|
|
|
## đ PrĂ©requis
|
|
|
|
- OS : Debian / Ubuntu / RHEL / CentOS
|
|
- Bash â„ 4.0
|
|
- Droits : **root** (sudo)
|
|
- Commandes requises : `tar`, `gzip`, `awk`, `find`, `stat`
|
|
- Selon votre base de données :
|
|
- PostgreSQL â `pg_dump`, `pg_restore`, `psql`
|
|
- MySQL/MariaDB â `mysqldump`, `mysql`
|
|
- SQLite3 â `sqlite3`
|
|
- Optionnel : binaire `gitea` accessible pour le dump natif
|
|
|
|
---
|
|
|
|
## đ Installation
|
|
|
|
```bash
|
|
# Cloner le dépÎt
|
|
git clone https://git.h3campus.fr/Johnny/Redmine.git /opt/scripts/gitea-backup
|
|
cd /opt/scripts/gitea-backup
|
|
|
|
# Rendre le script exécutable
|
|
chmod +x gitea-backup.sh
|
|
|
|
# Copier et configurer le fichier .env
|
|
cp .env.gitea.example .env.gitea
|
|
nano .env.gitea
|
|
```
|
|
|
|
---
|
|
|
|
## âïž Configuration â fichier `.env.gitea`
|
|
|
|
```ini
|
|
# Utilisateur systĂšme Gitea
|
|
GITEA_USER=git
|
|
|
|
# RĂ©pertoire d'installation du binaire
|
|
GITEA_ROOT=/opt/gitea
|
|
|
|
# RĂ©pertoire de travail (repositories, data, log...)
|
|
GITEA_WORK_DIR=/var/lib/gitea
|
|
|
|
# Chemin vers app.ini (obligatoire)
|
|
GITEA_CONF=/etc/gitea/app.ini
|
|
|
|
# Chemin vers le binaire gitea
|
|
GITEA_BINARY=/usr/local/bin/gitea
|
|
|
|
# Dossier de stockage des archives
|
|
BACKUP_DIR=/opt/Backups/gitea
|
|
|
|
# Nombre d'archives Ă conserver
|
|
KEEP_BACKUPS=7
|
|
|
|
# Inclure les logs dans la sauvegarde
|
|
INCLUDE_LOG=false
|
|
|
|
# Activer le dump natif "gitea dump" en complément
|
|
USE_NATIVE_DUMP=true
|
|
|
|
# Surcharge DB optionnelle (auto-détectée depuis app.ini par défaut)
|
|
# DB_TYPE=postgresql
|
|
# DB_HOST=localhost
|
|
# DB_PORT=5432
|
|
# DB_NAME=gitea
|
|
# DB_USER=gitea
|
|
# DB_PASS=motdepasse
|
|
```
|
|
|
|
> Les valeurs `DB_*` sont **auto-détectées** depuis `app.ini`. Ne les renseigner que pour surcharger ou si la détection échoue.
|
|
|
|
---
|
|
|
|
## đ Utilisation
|
|
|
|
### Menu interactif (recommandé)
|
|
|
|
```bash
|
|
sudo ./gitea-backup.sh
|
|
```
|
|
|
|
```
|
|
[1] CrĂ©er une sauvegarde â Sauvegarde complĂšte (DB + dĂ©pĂŽts + donnĂ©es + config)
|
|
[2] Restaurer â Menu interactif de restauration
|
|
[3] Lister les sauvegardes â Voir les archives disponibles
|
|
[4] Planification Cron â GĂ©rer les sauvegardes automatiques
|
|
[5] Afficher l'aide â Documentation complĂšte
|
|
[0] Quitter
|
|
```
|
|
|
|
### Commandes directes
|
|
|
|
```bash
|
|
sudo ./gitea-backup.sh backup # Lancer une sauvegarde
|
|
sudo ./gitea-backup.sh restore # Menu de restauration
|
|
sudo ./gitea-backup.sh list # Lister les archives
|
|
sudo ./gitea-backup.sh cron # GĂ©rer la planification cron
|
|
sudo ./gitea-backup.sh help # Aide
|
|
```
|
|
|
|
---
|
|
|
|
## đŸ Contenu d'une archive de sauvegarde
|
|
|
|
Chaque archive `gitea_backup_YYYYMMDD_HHMMSS.tar.gz` contient :
|
|
|
|
```
|
|
gitea_backup_20260227_030000.tar.gz
|
|
âââ database.sql â dump complet de la base de donnĂ©es (PostgreSQL/MySQL)
|
|
âââ database.db â copie binaire (SQLite uniquement)
|
|
âââ manifest.txt â version Gitea, stats dĂ©pĂŽts, extrait app.ini
|
|
âââ config/
|
|
â âââ app.ini â configuration principale Gitea
|
|
â âââ ssh_keys/ â clĂ©s SSH de l'utilisateur Gitea
|
|
â âââ .env.gitea.backup â copie du fichier .env
|
|
âââ repositories.tar.gz â tous les dĂ©pĂŽts Git (bare repos)
|
|
âââ data.tar.gz â avatars, attachments, LFS, tokens
|
|
âââ native_dump/ â archive gitea dump officielle (si USE_NATIVE_DUMP=true)
|
|
âââ gitea_native_dump.zip
|
|
```
|
|
|
|
---
|
|
|
|
## đ Modes de restauration
|
|
|
|
| Mode | DB | DépÎts | Données | Config |
|
|
|---|:---:|:---:|:---:|:---:|
|
|
| **ComplĂšte** | â
| â
| â
| â
|
|
|
| **Base de donnĂ©es uniquement** | â
| â | â | â |
|
|
| **DĂ©pĂŽts Git uniquement** | â | â
| â | â |
|
|
| **DonnĂ©es uniquement** (avatars, LFS...) | â | â | â
| â |
|
|
| **Configuration uniquement** (app.ini + SSH) | â | â | â | â
|
|
|
|
|
> â ïž Le service Gitea est **automatiquement arrĂȘtĂ©** avant la restauration et **redĂ©marrĂ©** Ă la fin (modes 1 Ă 4).
|
|
> â ïž Les dossiers remplacĂ©s sont renommĂ©s `.pre_restore_TIMESTAMP` comme filet de sĂ©curitĂ©.
|
|
|
|
---
|
|
|
|
## â° Planification automatique (Cron)
|
|
|
|
Via le menu `[4]` ou `sudo ./gitea-backup.sh cron` :
|
|
|
|
| Option | Expression | Description |
|
|
|---|---|---|
|
|
| Quotidienne | `0 3 * * *` | Tous les jours Ă 03h00 |
|
|
| Biquotidienne | `0 3,15 * * *` | Ă 03h00 et 15h00 |
|
|
| Hebdomadaire | `0 3 * * 1` | Tous les lundis Ă 03h00 |
|
|
| Mensuelle | `0 3 1 * *` | Le 1er du mois Ă 03h00 |
|
|
| Personnalisée | `<expression>` | Saisie manuelle validée |
|
|
|
|
Exemple d'entrée installée :
|
|
|
|
```cron
|
|
MAILTO=admin@exemple.fr
|
|
0 3 * * * /opt/scripts/gitea-backup/gitea-backup.sh backup # gitea-backup-auto
|
|
```
|
|
|
|
---
|
|
|
|
## đ Structure du dĂ©pĂŽt
|
|
|
|
```
|
|
gitea-backup/
|
|
âââ gitea-backup.sh â script principal
|
|
âââ .env.gitea.example â modĂšle de configuration
|
|
âââ README.md â cette documentation
|
|
âââ LICENSE â licence MIT
|
|
```
|
|
|
|
---
|
|
|
|
## đ SĂ©curitĂ©
|
|
|
|
- Le fichier `.env.gitea` contient des mots de passe â **ne jamais le committer**.
|
|
- Ajouter au `.gitignore` :
|
|
```bash
|
|
echo ".env.gitea" >> .gitignore
|
|
```
|
|
- Restreindre l'accĂšs au dossier de sauvegardes :
|
|
```bash
|
|
chmod 700 /opt/Backups/gitea
|
|
```
|
|
- `app.ini` peut contenir des secrets (clĂ©s JWT, mots de passe SMTP) â les archives sont sensibles.
|
|
|
|
---
|
|
|
|
## đ DĂ©pannage
|
|
|
|
**Erreur `gitea dump` Ă©choue**
|
|
Le script bascule automatiquement sur la méthode manuelle. Vérifier que `GITEA_BINARY` est correct et que l'utilisateur `GITEA_USER` a les droits nécessaires.
|
|
|
|
**La détection DB échoue**
|
|
Forcer manuellement `DB_TYPE`, `DB_NAME`, `DB_USER`, `DB_PASS` dans `.env.gitea`.
|
|
|
|
**Permissions aprĂšs restauration**
|
|
```bash
|
|
chown -R git:git /var/lib/gitea
|
|
chmod 750 /etc/gitea
|
|
chmod 640 /etc/gitea/app.ini
|
|
```
|
|
|
|
**Gitea ne redémarre pas aprÚs restauration**
|
|
```bash
|
|
systemctl status gitea
|
|
journalctl -u gitea -n 50
|
|
```
|
|
|
|
**Consulter les logs de sauvegarde**
|
|
```bash
|
|
tail -f /var/log/gitea-backup.log
|
|
```
|
|
|
|
---
|
|
|
|
## đ€ Auteur
|
|
|
|
**Johnny Fontaine** â [j.fontaine@h3campus.fr](mailto:j.fontaine@h3campus.fr)
|
|
H3 Campus â [https://git.h3campus.fr/Johnny/Redmine](https://git.h3campus.fr/Johnny/Redmine)
|
|
|
|
---
|
|
|
|
## đ Licence
|
|
|
|
Ce projet est distribué sous licence **MIT**. Voir le fichier [LICENSE](LICENSE) pour plus de détails. |