offen/docker-volume-backup
Docker Volume Backup
This project is a Docker volume backup tool and data lifecycle manager that archives volume data to local storage, SSH, or cloud providers. It operates as a containerized backup orchestrator and companion container that coordinates volume snapshots and manages the restoration of data for disaster recovery.
The tool distinguishes itself through integrated security and consistency controls, utilizing GPG or age encryption to secure archives before remote transmission. It ensures data integrity by managing container states, such as stopping services or running database dump utilities via lifecycle hooks, before the backup process begins.
Broad capabilities include automated task scheduling with multi-schedule management and the enforcement of retention policies to prune old archives. It supports a wide range of storage backends, including S3 compatible object storage, Azure Blob, WebDAV, and Dropbox. Additionally, the system includes a template-based notification system to alert users of backup success or failure.
The utility supports non-root execution and can connect to Docker engines via TCP or Unix sockets, including rootless mode.
Features
- Backup Orchestrators - Acts as a containerized orchestrator that coordinates volume snapshots and lifecycle scripts.
- Backup Consistency Management - Uses lifecycle hooks to run dump utilities or pause containers to ensure data integrity before backups.
- Backup Retention Policies - Applies expiration rules to backups by grouping them with filename prefixes to manage data retention.
- Disaster Recovery Workflows - Restores Docker volumes from archives to recover lost data or roll back system states.
- Database Backup Utilities - Provides integration with dump utilities to ensure database consistency before volume archiving.
- Volume Restorations - Recovers archived backup files back into a volume to restore the system to a known state.
- Lifecycle Script Execution - Triggers custom scripts at defined stages of the backup lifecycle, such as before or after archive creation.
- Data Lifecycle Management - Schedules recurring snapshots, manages retention policies, and performs volume restoration for Docker containers.
- Docker Volume Backup Tools - Archives Docker volumes to local storage, SSH, or cloud providers like S3 and Azure Blob Storage.
- Backup Job Scheduling - Provides scheduling and configuration of recurring backup tasks for various volume sets using environment files.
- Volume Backup Scheduling - Runs volume backups on a recurring timetable or as one-off executions to maintain recovery points.
- Backup Pruning - Automatically removes outdated backup archives from local or remote storage based on age to manage disk space.
- Backup Lifecycle Hooks - Executes custom scripts at specific backup lifecycle stages to ensure data consistency and environment setup.
- Docker Daemon Sockets - Interacts with Docker engines using local Unix sockets or remote TCP endpoints to orchestrate volume backups.
- Policy-Based Retention - Automates the removal of old backup archives based on age and filename prefixes to manage storage capacity.
- Dropbox Storage Integration - Uploads volume backups to Dropbox accounts using OAuth2 authentication.
- Amazon S3 Backup Storages - Handles data redundancy and rotation for Docker volumes using S3-compatible storage.
- SSH Storage - Saves volume data to local directories or remote servers via SSH.
- Container State Controllers - Controls the operational state of containers, such as stopping services or scaling to zero, during backup processes.
- Cloud Storage Integrations - Transfers volume data to remote providers including S3 compatible object storage, Azure Blob, and Dropbox.
- Multi-Routine Management - Creates independent backup routines by loading multiple configuration files and executing them as separate jobs.
- Sidecar Containers - Runs as a companion sidecar container that interacts with the Docker daemon to manage volume access.
- Encrypted Archiving Tools - Secures volume backups using GPG or age encryption before uploading to remote storage.
- Encrypted Backups - Protects backup archives using GPG or age encryption to ensure data remains secure on remote backends.
- GPG Encrypted Archiving - Encrypts Docker volume data using GPG or age before remote transmission to ensure security.
- GPG-Based Encryption - Secures backup archives using GPG or age encryption before they are transmitted to remote storage.
- Storage Abstractions - Uses a common interface to abstract diverse storage backends including S3, WebDAV, Azure Blob, and SSH.
- Object Storage Backups - Transfers Docker volume archives to S3-compatible object storage for durable offsite backups.
- Storage Management - Local and S3-compatible volume backup utility.
