# lucciano-stn/docker-volume-manager architecture

> Architecture diagram of the GitHub repository lucciano-stn/docker-volume-manager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lucciano-stn/docker-volume-manager
- Repository: https://github.com/lucciano-stn/docker-volume-manager

## Overview

Docker Volume Manager is a Bash tool for backing up and restoring Docker volumes, with local and SFTP archive management. Its principal workflow is to select volumes, create an archive, optionally transfer it remotely, and apply retention; separate commands list archives and restore them. The README documents these capabilities and runtime integrations, but no source excerpts were provided, so the graph represents documented responsibilities rather than verified internal call structure.

Main entry points: [`script/docker-volume-manager.sh`](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh) (Manager CLI), [`script/exemple.env`](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/exemple.env) (Configuration), [`script/exclude.txt`](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/exclude.txt) (Volume exclusions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_commands["Commands and control"]
  node_manager["Manager CLI"]
  node_config["Configuration<br/>[exemple.env]"]
  node_exclusions["Volume exclusions<br/>[exclude.txt]"]
end

subgraph group_backup_restore["Backup and restore"]
  node_backup["Volume backup"]
  node_restore["Volume restore"]
end

subgraph group_archive_ops["Archive operations"]
  node_local_archives[("Local archives")]
  node_sftp_transfer["SFTP transfer and listing"]
  node_retention["Retention and cleanup"]
  node_logging["Logging and rotation"]
end

node_operator(("Operator"))
node_scheduler(("systemd timer"))
node_docker[("Docker volumes")]
node_sftp_server[("SFTP server")]

node_operator -->|"runs command"| node_manager
node_scheduler -->|"runs backup"| node_manager
node_manager -->|"uses settings"| node_config
node_manager -->|"reads exclusions"| node_exclusions
node_manager -->|"selects backup"| node_backup
node_manager -->|"selects restore"| node_restore
node_manager -->|"lists archives"| node_local_archives
node_backup -->|"backs up volumes"| node_docker
node_backup -->|"writes archives"| node_local_archives
node_backup -->|"requests transfer"| node_sftp_transfer
node_sftp_transfer -->|"transfers archives"| node_sftp_server
node_sftp_transfer -->|"lists archives"| node_sftp_server
node_restore -->|"reads archive"| node_local_archives
node_restore -->|"requests remote archive"| node_sftp_transfer
node_restore -->|"restores volume"| node_docker
node_manager -->|"applies retention"| node_retention
node_retention -->|"prunes local"| node_local_archives
node_retention -->|"prunes remote"| node_sftp_server
node_manager -->|"records activity"| node_logging

click node_manager "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh"
click node_config "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/exemple.env"
click node_exclusions "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/exclude.txt"
click node_backup "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh"
click node_restore "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh"
click node_sftp_transfer "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh"
click node_retention "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh"
click node_logging "https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_manager,node_config,node_exclusions toneBlue
class node_backup,node_restore,node_docker,node_sftp_server toneAmber
class node_local_archives,node_sftp_transfer,node_retention,node_logging toneMint
class node_operator,node_scheduler toneIndigo
```

## Components

### Commands and control

- [Manager CLI](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh): `script/docker-volume-manager.sh`
- [Configuration](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/exemple.env): `script/exemple.env`
- [Volume exclusions](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/exclude.txt): `script/exclude.txt`

### Backup and restore

- [Volume backup](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh): `script/docker-volume-manager.sh`
- [Volume restore](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh): `script/docker-volume-manager.sh`

### Archive operations

- **Local archives**
- [SFTP transfer and listing](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh): `script/docker-volume-manager.sh`
- [Retention and cleanup](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh): `script/docker-volume-manager.sh`
- [Logging and rotation](https://github.com/lucciano-stn/docker-volume-manager/blob/main/script/docker-volume-manager.sh): `script/docker-volume-manager.sh`

### Other components

- **Operator**
- **systemd timer**
- **Docker volumes**
- **SFTP server**

## Connections

- Operator → Manager CLI: runs command (evidence: `README.md`)
- systemd timer → Manager CLI: runs backup (evidence: `README.md`)
- Manager CLI → Configuration: uses settings (evidence: `README.md`)
- Manager CLI → Volume exclusions: reads exclusions (evidence: `README.md`)
- Manager CLI → Volume backup: selects backup (evidence: `README.md`)
- Manager CLI → Volume restore: selects restore (evidence: `README.md`)
- Manager CLI → Local archives: lists archives (evidence: `README.md`)
- Volume backup → Docker volumes: backs up volumes (evidence: `README.md`)
- Volume backup → Local archives: writes archives (evidence: `README.md`)
- Volume backup → SFTP transfer and listing: requests transfer (evidence: `README.md`)
- SFTP transfer and listing → SFTP server: transfers archives (evidence: `README.md`)
- SFTP transfer and listing → SFTP server: lists archives (evidence: `README.md`)
- Volume restore → Local archives: reads archive (evidence: `README.md`)
- Volume restore → SFTP transfer and listing: requests remote archive (evidence: `README.md`)
- Volume restore → Docker volumes: restores volume (evidence: `README.md`)
- Manager CLI → Retention and cleanup: applies retention (evidence: `README.md`)
- Retention and cleanup → Local archives: prunes local (evidence: `README.md`)
- Retention and cleanup → SFTP server: prunes remote (evidence: `README.md`)
- Manager CLI → Logging and rotation: records activity (evidence: `README.md`)
