Docker Container Data Backup Tool

中文 README.md

A command-line tool for backing up and restoring Docker container data.

Key Features

• Backs up and restores Docker container data volumes.
• Supports both command-line arguments and interactive operations.
• Employs XZ compression algorithm for efficient compression.
• Offers command-line completion for Bash, Zsh, Fish, and PowerShell.
• Supports custom configuration files.

Installation

Ensure you have the Rust toolchain installed on your system, then execute:

# Install rdbkp2
cargo install rdbkp2

# Create symbolic link to enable sudo rdbkp2 ... usage
# sudo ln -s $(where rdbkp2) /usr/local/bin/rdbkp2  # Create a symbolic link for rdbkp2 to /usr/local/bin/rdbkp2 to enable sudo rdbkp2 ... usage
rdbkp2 link install                                 # Use this command to replace manual symbolic link creation above

# Check for updates
rdbkp2 update

# Uninstall rdbkp2
rdbkp2 uninstall

Usage

Listing Available Containers

rdbkp2 list

Backing Up Container Data

[!TIP] The default backup directory is selected based on the following priority:

1. $APPDATA/rdbkp2 (Windows) or ~/.local/share/rdbkp2 (Unix)
2. $HOME/rdbkp2
3. ./rdbkp2 (current directory)

Interactive Mode:

rdbkp2 backup -i

Command-line Mode:

rdbkp2 backup -c container_name -o /path/to/backup/dir

Restoring Container Data

Interactive Mode:

rdbkp2 restore -i

Command-line Mode:

rdbkp2 restore -c container_name -f /path/to/backup/file

Create/Remove Symbol-link for program

rdbkp2 link install             # create the symbol-link at /usr/local/bin/rdbkp2
rdbkp2 link uninstall           # remove the symbol-link at /usr/local/bin/rdbkp2

Command-Line Completion

Generate command-line completion scripts for various shells:

# Generate Bash completion script
rdbkp2 completions bash > ~/.local/share/bash-completion/completions/rdbkp2

# Generate Zsh completion script
rdbkp2 completions zsh > ~/.zsh/_rdbkp2

# Generate Fish completion script
rdbkp2 completions fish > ~/.config/fish/completions/rdbkp2.fish

# Generate PowerShell completion script
# Windows PowerShell
mkdir -p $PROFILE\..\Completions
rdbkp2 completions powershell > $PROFILE\..\Completions\rdbkp2.ps1

Enabling Completion Functionality

Bash

Add the following lines to your ~/.bashrc or ~/.bash_profile:

source ~/.local/share/bash-completion/completions/rdbkp2

Zsh

After placing the completion script in the correct location, ensure completion is enabled in your ~/.zshrc:

autoload -Uz compinit
compinit

Fish

Fish shell automatically loads completion scripts from the ~/.config/fish/completions directory. No additional configuration is needed.

PowerShell

Add the following line to your PowerShell profile:

. $PROFILE\..\Completions\rdbkp2.ps1

Command-Line Arguments

Common Arguments

Backup Command (backup)

Restore Command (restore)

[!CAUTION] 💖 Caution: Restoring Docker container bound volumes requires Administrator privileges.
✅ Please run [program] as sudo / Run as Administrator.

List Command (list)

No arguments. Displays all available containers.

Completions Command (completions)

• shell: Specifies the shell type (bash/zsh/fish/powershell)

Link SubCommand (Link install/uninstall)

[!CAUTION] 💖 Caution: Install soft-symbol-link requires Administrator privileges.

Important Notes

1. When using the Restore function, ensure you operate with sudo / Administrator privileges.
   • This permission is required for write operations when changing and overwriting Docker container-mounted volumes.
2. Ensure sufficient disk space is available for backups.
3. It is recommended to back up your current data before restoring.
4. You need to have permissions to access the Docker daemon.
5. Windows users need to ensure Docker Desktop is running.

Reliability Improvements

• The CLI now checks container state before issuing docker stop, so already-stopped containers no longer cause silent failures.
• Graceful shutdowns poll Docker status with a bounded timeout and surface explicit feedback when a container cannot stop in time.
• Restore workflows validate backup metadata before copying files and confirm destructive operations, ensuring unexpected archives are rejected.
• Updated Docker client calls to the latest bollard::query_parameters API so builds stay warning-free and aligned with upstream changes.

Acknowledgments

Notes:

1. Platform-Specific Dependencies:

   • runas is Windows-only; other libraries are cross-platform (Linux/macOS/Windows).

2. Performance Optimization:

   • strip = true: Removes debug symbols in release builds to reduce binary size.
   • lto = "thin" and opt-level = 3: Enables Link-Time Optimization (LTO) and maximum optimization level.

3. Acknowledgements: Special thanks to these open-source projects for providing foundational support to rdbkp2!