From 4c4057735dce98c5fb37c6c41f5636af3ecfd1b9 Mon Sep 17 00:00:00 2001 From: Eddie Nielsen <โ€œedโ€@edcore.dkโ€> Date: Mon, 23 Mar 2026 17:59:08 +0000 Subject: [PATCH] docs: add roadmap section --- README.md | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 111 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8e06b00..991e5c5 100644 --- a/README.md +++ b/README.md @@ -261,19 +261,121 @@ SKIP: --- -## ๐Ÿ”ฅ Roadmap +## ๐Ÿ—บ Roadmap -* [ ] Named volume inspection (`docker volume inspect`) -* [ ] Docker API integration -* [ ] Multiple compose files support -* [ ] Email / ntfy notifications -* [ ] Web interface -* [ ] Backup history tracking -* [ ] Restore validation -* [ ] Scheduling integration +DockerVault is built with a clear philosophy: +**simple core, intelligent behavior, and extensible design โ€” without unnecessary complexity or vendor lock-in.** --- +### ๐Ÿš€ v1 โ€” Core Engine (Current Focus) + +> Build a reliable, deterministic backup discovery engine + +- [x] Docker Compose scanning +- [x] Volume and bind mount detection +- [x] Intelligent classification (critical / review / skip) +- [x] Backup plan generation +- [x] Borg backup integration +- [x] Dry-run mode +- [x] Automation mode (`--automation`, `--quiet`) + +--- + +### ๐Ÿ”ง v2 โ€” Observability & Automation + +> Make DockerVault production-ready + +- [ ] Advanced logging (human + JSON output) +- [ ] Webhook support (primary notification system) +- [ ] ntfy integration (lightweight alerts) +- [ ] Email notifications (optional reports) +- [ ] Change detection (new/missing volumes) +- [ ] Backup summaries (stats, duration, warnings) +- [ ] Basic run history (file-based, no database) + +--- + +### ๐Ÿง  v3 โ€” Intelligence Layer + +> Move from tool โ†’ system awareness + +- [ ] "Explain why" classification decisions +- [ ] Anomaly detection (size, duration, structure) +- [ ] System understanding confidence +- [ ] Backup diff between runs +- [ ] Smarter classification patterns + +--- + +### ๐Ÿงช v4 โ€” Reliability & Safety + +> Ensure backups are actually usable + +- [ ] Restore testing (ephemeral container validation) +- [ ] Integrity checks (borg/restic verify) +- [ ] Pre/post execution hooks +- [ ] Backup profiles (critical / full / custom) + +--- + +### ๐Ÿ” v5 โ€” Security & Encryption + +> Strong, transparent data protection + +- [ ] Engine-native encryption (Borg / Restic) +- [ ] Encryption validation checks +- [ ] Optional post-process encryption (age / gpg) +- [ ] Clear key handling guidelines + +--- + +### ๐Ÿ”Œ v6 โ€” Plugin Ecosystem + +> Extend without bloating core + +- [ ] Storage backends (S3, WebDAV, SSH, etc.) +- [ ] Optional cloud integrations (Dropbox, Google Drive, Proton Drive) +- [ ] Notification plugins (webhook-first approach) +- [ ] Pluggable architecture for extensions + +--- + +### ๐ŸŒ v7 โ€” Platform & Deployment + +> Make DockerVault easy to run anywhere + +- [ ] Official Docker image +- [ ] Non-interactive container mode +- [ ] Unraid Community Apps template +- [ ] Configurable via environment + config file + +--- + +### ๐Ÿงญ Design Principles + +- **No vendor lock-in** โ€” webhook over platform integrations +- **Self-hosting friendly** โ€” works fully offline/local +- **Transparency over magic** โ€” explain decisions +- **Stateless-first** โ€” no database required by default +- **Extensible architecture** โ€” plugins over core bloat +- **Backup โ‰  done until restore works** + +--- + +### ๐Ÿ”ฎ Future Ideas + +- Multi-host awareness (Lanx environments) +- Centralized monitoring integration (OpenObserve, etc.) +- Web UI (optional, not required) +- Automation pipelines via webhook +- Advanced reporting and visualization + +--- + +> Built with โค๏ธ for real systems โ€” not toy setups. +--- + ## ๐Ÿง  Philosophy DockerVault is built on a simple idea: