π LunarDump CLI Documentation
Welcome to the official documentation for LunarDump, a modern, developer-friendly Command-Line Interface (CLI) tool designed to streamline, encrypt, and automate your database backup workflows.
π Key Architecture & Features
- Multi-Engine Support: Seamlessly handles PostgreSQL, MySQL, MariaDB, and MongoDB.
- Zero-Trust AES-256-GCM Encryption: Local, authenticated end-to-end encryption applied before any data leaves your server.
- Memory-Efficient Streaming: Direct pipe streaming through 64KB chunks in RAM directly into cloud storage endpointsβpreventing RAM spikes even on multi-gigabyte databases.
- Multi-Cloud Target: Built-in support for AWS S3, Google Cloud Storage (GCS), Cloudflare R2, MinIO, and local storage.
- Backup Verification (
--verify): On-the-fly stream decryption, integrity authentication, and checksum generation (SHA-256 / MD5). - Automated Retention Cleaner: Automatically purges expired backup archives based on your custom
retention_dayswindow. - Rich Telemetry: Interactive progress UI and webhook notifications to Telegram & Slack.
Pre-installed in HackTrack OS
LunarDump is included natively in HackTrack OS. You can launch lunardump directly from any terminal window or from the system menu under Extra Tools.
π Quick Navigation
- Installation & Setup - Install via
pip,uv, and verify system binary dependencies. - Quickstart Guide - Set up your first
config.yamland.envin 5 minutes. - Configuration Reference - Complete schema reference guide for database, security, and cloud storage settings.
- CLI Commands - Reference for
run,config check,keygen,restore, anddb dump. - Backup Integrity Verification - Validate backup files with
--verify.
π¬ Community & Support
Have questions, need help setting up your backup pipeline, or want to connect with other LunarDump users?
π Join our official Telegram Community (t.me/lunardump)!