mailcow-dockerized/helper-scripts
Claas Flint 1b833be760
Replace pigz with zstd for backup compression (#6897)
* Replace pigz with zstd for backup compression

This change replaces pigz (parallel gzip) with zstd (Zstandard) as the
compression algorithm for mailcow backups while maintaining full backward
compatibility with existing .tar.gz backups.

Benefits:
- Better compression ratios (12-37% improvement in tests)
- Improved compression speed with modern algorithm
- Maintains rsyncable functionality for incremental backups
- Full backward compatibility for restoring old .tar.gz backups
- Wide industry adoption and active development

Changes:
- Backup compression: pigz --rsyncable -p → zstd --rsyncable -T
- Backup decompression: pigz -d -p → zstd -d -T
- File extensions: .tar.gz → .tar.zst
- Added get_archive_info() function for intelligent format detection
- Updated backup Dockerfile to install zstd alongside pigz
- Restore function now auto-detects and handles both formats
- Updated FILE_SELECTION regex to recognize both .tar.zst and .tar.gz
- Updated comments to reflect new file extension

Backward Compatibility:
- Restore automatically detects .tar.zst (preferred) or .tar.gz (legacy)
- Existing .tar.gz backups can still be restored without issues
- pigz remains installed in backup image for legacy support
- Graceful fallback if backup file format not found

Testing:
- Added comprehensive test suite (test_backup_and_restore.sh)
- 12 automated tests covering all scenarios:
  * Backup creation (both formats)
  * Restore (both formats)
  * Format detection and priority
  * Error handling (missing files, empty dirs)
  * Content integrity verification
  * Multi-threading configuration
  * Large file compression (8.59 MB realistic data)

Test Results:
✓ zstd compression working
✓ pigz compression working (legacy)
✓ zstd decompression working
✓ pigz decompression working (backward compatible)
✓ Archive detection working
✓ Content integrity verified
✓ Format priority correct (.tar.zst preferred)
✓ Error handling for missing files
✓ Error handling for empty directories
✓ Multi-threading configuration verified
✓ Large file compression: 37.05% improvement
✓ Small file compression: 12.18% improvement

* move testing script into development folder

---------

Co-authored-by: DerLinkman <niklas.meyer@servercow.de>
2025-11-12 10:06:36 +01:00
..
dev_tests Replace pigz with zstd for backup compression (#6897) 2025-11-12 10:06:36 +01:00
docker-compose.override.yml.d chore(deps): update alpine docker tag to v3.22 (#6417) 2025-10-21 18:03:02 +02:00
_cold-standby.sh [Helper] Fix cold-standby script to support digits and override files (#6800) 2025-10-02 09:21:26 +02:00
add-new-lang-keys.php 🛠 fix: Language detection 2022-10-06 22:21:12 +08:00
backup_and_restore.sh Replace pigz with zstd for backup compression (#6897) 2025-11-12 10:06:36 +01:00
check_translations.rb 🛠 fix: Language detection 2022-10-06 22:21:12 +08:00
expiry-dates.sh Fixed permission for expiry-dates.sh 2023-03-03 12:41:24 +01:00
generate_caa_record.py T.: Added a script for generating CAA records 2023-10-23 19:44:28 +02:00
mailcow-reset-admin.sh Fix broken pipe error in reset-admin.sh 2023-03-28 11:17:59 +02:00
reset-learns.sh [Redis] redis-cli suppress auth warning 2024-11-19 15:10:52 +01:00
update_compose.sh [Compose Updater] Corrected syntax errors 2022-12-26 14:33:15 +01:00
update_postscreen_whitelist.sh expanded postscreen whitelist with modern freemailers + included checks.mailcow.email 2025-08-28 14:06:17 +02:00