diff --git a/README.md b/README.md index 64ef1c3..1bd1fbd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# Docker-Compose-Backup-Script +# 🐳 Docker Compose Backup Script -Dieses Script erstellt Backups von Docker Compose Stacks inklusive aller gemounteten Daten (Volumes & Bind-Mounts), komprimiert diese als ZIP-Archiv und kann optional einen Upload via SFTP durchführen. \ No newline at end of file +Dieses Script erstellt Backups von Docker Compose Stacks inklusive aller gemounteten Daten (Volumes & Bind-Mounts), komprimiert diese als ZIP-Archiv und kann optional einen Upload via SFTP durchführen. + +--- + +## ✨ Features + +* 📦 Backup kompletter Docker Compose Stacks +* 🔍 Automatische Erkennung laufender Projekte +* 🧠 Erkennt alle Mounts (Volumes + Bind Mounts) +* 🗜 Erstellung eines ZIP-Archivs +* 📊 Fortschrittsanzeige beim Packen (`pv`) +* 📤 Optionaler Upload via SFTP (SCP) +* 📧 E-Mail Benachrichtigung mit Logfile +* 🛑 Stoppt Container für konsistente Backups +* 🔁 Startet Stack automatisch wieder + +--- + +## 📋 Voraussetzungen + +Folgende Pakete müssen installiert sein: + +```bash +apt install docker.io jq rsync zip pv sshpass mailutils +``` \ No newline at end of file