ed/dockervault
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Eddie Nielsen 2026-03-22 12:20:49 +00:00
parent b7482bcad1
commit 59046963c6
1 changed files with 59 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

93
README.md
View file

@ -14,14 +14,15 @@ No guesswork. No forgotten volumes. No broken restores.
## 📚 Contents
- [🚀 What is DockerVault?](#-what-is-dockervault)
- [⚡ Quick Start](#-quick-start)
- [🛠 Tech Stack](#-tech-stack)
- [🔍 Example](#-example)
- [🧱 Current Features](#-current-features)
- [🔥 Roadmap](#-roadmap)
- [🧠 Philosophy](#-philosophy)
- [🤝 Contributing](#-contributing)
* [🚀 What is DockerVault?](#-what-is-dockervault)
* [🧠 Why DockerVault?](#-why-dockervault)
* [⚡ Quick Start](#-quick-start)
* [🛠 Tech Stack](#-tech-stack)
* [🔍 Example](#-example)
* [🧱 Current Features](#-current-features)
* [🔥 Roadmap](#-roadmap)
* [🧠 Philosophy](#-philosophy)
* [🤝 Contributing](#-contributing)
---
@ -34,26 +35,7 @@ DockerVault is a CLI tool that:
* Identifies **real data vs noise**
* Builds a structured backup understanding
Built for people who run real systems — not toy setups.
---
## 🛠 Tech Stack
DockerVault is built using simple, reliable components:
- **Python 3.10+** – core language
- **PyYAML** – parsing Docker Compose files
- **argparse** – CLI interface
- **pip / venv** – environment management
---
### 🔧 Designed for
- Linux systems (Ubuntu, Debian, Unraid environments)
- Docker Compose based setups
- CLI-first workflows
Built for people running real systems — not toy setups.
---
@ -85,6 +67,25 @@ dockervault scan /path/to/docker
---
## 🛠 Tech Stack
DockerVault is built using simple, reliable components:
* **Python 3.10+** – core language
* **PyYAML** – parsing Docker Compose files
* **argparse** – CLI interface
* **pip / venv** – environment management
---
### 🔧 Designed for
* Linux systems (Ubuntu, Debian, Unraid environments)
* Docker Compose based setups
* CLI-first workflows
---
## 🔍 Example
```bash
@ -132,30 +133,53 @@ dockervault scan ~/test-docker --json
* [x] Scan command
* [x] YAML parsing
---
### 🚧 Phase 2 – Intelligence
* [ ] Classify mounts (data / config / cache)
* [ ] Detect backup candidates
* [ ] Generate backup plan
---
### 🔜 Phase 3 – Storage
* [ ] SQLite inventory
* [ ] Historical tracking
* [ ] Change detection
---
### 🔜 Phase 4 – Execution
* [ ] Borg integration
* [ ] Backup automation
* [ ] Restore validation
---
### 🔔 Phase 5 – Notifications & Monitoring
* [ ] Email notifications
* [ ] ntfy.sh integration
* [ ] Webhook support
* [ ] Alerts on:
* missing backups
* new volumes
* changed data paths
* [ ] Daily/weekly reports
---
### 🧠 Future Ideas
- [ ] Auto-detect Docker hosts on network
- [ ] Multi-node backup coordination (Lanx-style)
- [ ] Backup simulation ("what would be backed up?")
- [ ] Restore dry-run validation
- [ ] Tagging system (critical / optional / ignore
* [ ] Auto-detect Docker hosts on network
* [ ] Multi-node backup coordination (Lanx-style)
* [ ] Backup simulation ("what would be backed up?")
* [ ] Restore dry-run validation
* [ ] Tagging system (critical / optional / ignore)
---
@ -181,5 +205,6 @@ Feel free to contribute, suggest improvements or fork the project.
<p align="center">
Built with ❤️ for Lanx by NodeFox 🦊
Maintained by Eddie Nielsen
Maintained by Eddie Nielsen & NodeFox 🦊
Feel free to contribute, suggest improvements or fork the project.
</p>