dockervault/README.md
2026-03-21 22:29:04 +00:00

1.6 KiB

DockerVault logo

🚀 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)

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