docs: add roadmap section
This commit is contained in:
parent
11a07b23d2
commit
4c4057735d
1 changed files with 111 additions and 9 deletions
120
README.md
120
README.md
|
|
@ -261,19 +261,121 @@ SKIP:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🔥 Roadmap
|
## 🗺 Roadmap
|
||||||
|
|
||||||
* [ ] Named volume inspection (`docker volume inspect`)
|
DockerVault is built with a clear philosophy:
|
||||||
* [ ] Docker API integration
|
**simple core, intelligent behavior, and extensible design — without unnecessary complexity or vendor lock-in.**
|
||||||
* [ ] Multiple compose files support
|
|
||||||
* [ ] Email / ntfy notifications
|
|
||||||
* [ ] Web interface
|
|
||||||
* [ ] Backup history tracking
|
|
||||||
* [ ] Restore validation
|
|
||||||
* [ ] Scheduling integration
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### 🚀 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
|
## 🧠 Philosophy
|
||||||
|
|
||||||
DockerVault is built on a simple idea:
|
DockerVault is built on a simple idea:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue