57 lines
1.1 KiB
Markdown
57 lines
1.1 KiB
Markdown
# DockerVault
|
|
|
|
Early CLI foundation for DockerVault.
|
|
|
|
## Current scope
|
|
|
|
- Python CLI project skeleton
|
|
- `scan` command
|
|
- Recursive discovery of Docker Compose projects
|
|
- YAML parsing with `PyYAML`
|
|
- Detection of:
|
|
- services
|
|
- images
|
|
- restart policies
|
|
- bind mounts
|
|
- named volumes
|
|
- `env_file`
|
|
- JSON or human-readable output
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -e .
|
|
```
|
|
|
|
Run a scan:
|
|
|
|
```bash
|
|
dockervault scan /path/to/docker/projects
|
|
```
|
|
|
|
JSON output:
|
|
|
|
```bash
|
|
dockervault scan /path/to/docker/projects --json
|
|
```
|
|
|
|
## What v0.2 adds
|
|
|
|
DockerVault no longer just finds compose files.
|
|
It now builds a first inventory layer that can be used for backup logic later:
|
|
|
|
- project name and root path
|
|
- compose files found in the project
|
|
- service metadata
|
|
- backup candidate paths from bind mounts and env files
|
|
- named volumes defined in compose
|
|
|
|
## Example direction
|
|
|
|
This is meant as the next brick in a bigger flow:
|
|
|
|
1. Discover Docker app folders
|
|
2. Learn what services and data paths exist
|
|
3. Later attach backup rules, Borg targets, retention, notifications, and restore metadata
|