A flexible MySQL backup tool written in Go. Supports per-table and per-database backup modes, gzip compression, database/table filtering, structured logging, and email reporting.
- Backup modes:
file_per_table(separate file per table) orfile_per_database(single file per database) - Gzip compression with automatic tar archiving
- Flexible filtering:
onlyandexcluderules for databases and tables - Structured logging: text or JSON format with automatic password masking
- Email reporting: backup statistics and error notifications via SMTP
- Dry-run mode: preview what would be backed up without executing
- MySQL server with
mysqldumpavailable - SMTP server for email reports (optional)
curl -fsSL https://raw.githubusercontent.com/optimode/optidump/main/deployments/install.sh | bashThe image includes mysqldump and mariadb-dump clients. Mount the configuration and backup destination:
docker run --rm \
-v /path/to/config.yml:/etc/optidump/config.yml \
-v /opt/backup:/opt/backup \
ghcr.io/optimode/optidump --section productionSet logging.file to a path inside the backup volume (e.g., /opt/backup/optidump.log) for persistent audit logging. The log file will be preserved alongside the backups.
Also available on Docker Hub as optimode/optidump.
Download the .deb package from Releases:
sudo dpkg -i optidump_*.debDownload the .pkg.tar.zst package from Releases:
sudo pacman -U optidump_*.pkg.tar.zstmake buildBinaries are placed in the bin/ directory.
Create a YAML configuration file based on configs/config.example.yml. The file supports multiple named sections for different backup scenarios.
production:
server:
host: localhostport: 3306socket: # or Unix socket pathuser: backup_userpassword: secretbackup:
mode: file_per_table # or file_per_databasecompression: gz # gz or empty for no compressiondestination: /opt/backupcommand: /usr/bin/mysqldump # optional, default pathoptions: --opt --routines --triggers --events --skip-lock-tableslogging:
file: /var/log/optidump.loglevel: info # debug, info, errorformat: text # text or jsonreport:
sender: backup@example.comrecipient:
- admin@example.comonly: # optional: backup only theseapp_db:
analytics_db:
- events
- sessionsexclude: # optional: skip theseinformation_schema:
performance_schema:Store configuration files with restricted permissions (chmod 0600).
# Run backup
optidump --config /path/to/config.yml --section production
# Validate configuration
optidump --config /path/to/config.yml --check-config
# Dry-run: see what would be backed up
optidump --config /path/to/config.yml --section production --dry-run
# Override log level
optidump --config /path/to/config.yml --section production --level debug
# Show version
optidump --version| Flag | Description | Default |
|---|---|---|
-config | Path to configuration file | /etc/optidump/config.yml |
-section | Section name from config file | (required) |
-check-config | Validate config and exit | |
-dry-run | Preview mode, no actual backup | |
-level | Override log level (debug, info, error) | |
-console | Force console output | |
-version | Show version information |
The package includes a template service unit. Each instance runs a different config section:
# Run backup for "production" section
systemctl start optidump@production
# Enable on boot
systemctl enable optidump@productionBackups are organized in timestamped directories:
/opt/backup/
└── 2025-12-02-10-30/
├── database1/
│ ├── table1.sql.tar.gz
│ ├── table2.sql.tar.gz
│ └── table3.sql.tar.gz
└── database2/
├── users.sql.tar.gz
└── orders.sql.tar.gz
Text format (default):
[2025-12-02 10:30:15] INFO: Starting production backup
[2025-12-02 10:30:16] INFO: Backup: mysqldump --user=***** --password=***** ...
JSON format:
{"timestamp":"2025-12-02 10:30:15","level":"INFO","message":"Starting production backup"}Passwords are automatically masked in all log output.
MIT