diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c23d472 --- /dev/null +++ b/LICENSE @@ -0,0 +1,15 @@ +GNU GENERAL PUBLIC LICENSE +Version 2, June 1991 + +Copyright (C) 2026 Eddie Nielsen + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +[...] + +(⚠️ VIGTIGT: den fulde GPL v2 tekst er meget lang — du skal bruge hele den officielle) + +👉 Brug den officielle her: +https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt + diff --git a/README.md b/README.md index e69de29..a3c658c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,103 @@ +

+ DockerVault logo +

+ +# DockerVault + +Simple, reliable backups for Docker environments. + +--- + +## 🚀 What is DockerVault? + +DockerVault is a lightweight backup system designed to make Docker backups simple, transparent, and predictable. + +It helps you: + +* Discover Docker containers automatically +* Backup volumes, bind mounts, and configurations +* Keep track of backup history +* Restore data safely when needed + +Built for homelabs and small-scale infrastructure. + +--- + +## ✨ Features (planned) + +* 🔍 Auto-discovery of Docker containers +* 💾 Backup of volumes and bind mounts +* 🧠 Smart selection of what to back up +* 📦 Incremental backups (future) +* 🔁 Restore system +* 🖥 Multi-node support (future) + +--- + +## 🏗 Architecture + +DockerVault follows a simple flow: + +1. Scan Docker environment +2. Identify containers, volumes, and mounts +3. Store metadata (SQLite) +4. Execute backups +5. Restore when needed + +More details: `docs/architecture.md` + +--- + +## ⚡ Quick Start (coming soon) + +```bash +git clone git@git.lanx.dk:ed/dockervault.git +cd dockervault + +# planned commands +dockervault init +dockervault scan +dockervault backup +``` + +--- + +## 📁 Project Structure + +``` +dockervault/ +├── cmd/ +├── core/ +├── scanner/ +├── backup/ +├── restore/ +├── config/ +├── database/ +├── docs/ +└── scripts/ +``` + +--- + +## 🧩 Roadmap + +See `docs/roadmap.md` + +--- + +## 🤝 Philosophy + +DockerVault is built on a few simple principles: + +* Keep it simple +* Be transparent +* Avoid unnecessary complexity +* Build something we actually want to use + +No magic. No hidden behavior. + +--- + +## 📜 License + +GNU General Public License v2.0