Ancient-Backup

# 🛡️ Ancient-Backup **The most advanced backup solution for Minecraft servers** (https://img.shields.io/modrinth/dt/ancient-backup?style=for-the-badge&logo=modrinth&color=00AF5C)](https://modrinth.com/plugin/ancient-backup) (https://img.shields.io/modrinth/v/ancient-backup?style=for-the-badge&color=blue)](https://modrinth.com/plugin/ancient-backup) (https://img.shields.io/badge/license-MIT-green?style=for-the-badge)](LICENSE) --- ## ✨ Features ### 🚀 **High-Performance Compression** - **ZSTD Compression**: 3-5x faster than traditional ZIP with better compression ratios - **Adjustable Levels**: Balance between speed and file size (0-9) - **Streaming Mode**: Compress and upload simultaneously with zero local disk usage ### 📤 **Multiple Upload Destinations** - **SFTP** - Secure FTP with SSH encryption (recommended) - **FTPS** - FTP over TLS/SSL - **OneDrive/SharePoint** - Microsoft Graph API integration - **Google Drive** - Direct cloud upload support ### 🔄 **Smart Upload Management** - **Parallel Uploads**: Upload to multiple destinations simultaneously - **Resume Support**: Automatically resume interrupted uploads (SFTP/FTPS) - **Adaptive Throttling**: Reduces backup speed if server TPS drops to prevent lag - **Upload Retry**: Manual `/abackup uploadlast` command to retry failed uploads ### 📊 **Real-Time Progress Tracking** - **Live Console Output**: See compression and upload progress every 5 seconds - **Discord Webhooks**: Beautiful embeds with progress bars and statistics - **Speed Monitoring**: Real-time MB/s tracking for uploads and compression ### 🎯 **Advanced Features** - **File Exclusions**: Skip large folders like dynmap tiles or BlueMap renders using glob patterns - **Automatic Retention**: Keep only the last N backups on remote servers - **Flexible Scheduling**: Run backups every X minutes or at specific times daily - **World Save Safety**: Automatically disables auto-save during backups to prevent corruption - **Memory Management**: Automatic RAM cleanup after backups complete - **Staff Notifications**: In-game notifications for players with permission ### 🔒 **Security & Reliability** - **Strict Host Key Checking**: Verify SFTP server fingerprints to prevent MITM attacks - **SSH Key Authentication**: Use private keys instead of passwords - **TLS/SSL Support**: Encrypted connections for FTPS - **Cancellable Backups**: Stop backups mid-process with `/abackup cancel` --- ## 📋 Requirements - **Server Software**: Paper/Spigot/Bukkit 1.20.6+ - **Java**: 21 or higher - **Permissions**: `ancientbackup.admin` for commands, `ancientbackup.notify` for notifications --- ## 🚀 Quick Start ### Installation 1. Download the latest version from Modrinth 2. Place the JAR file in your `plugins/` folder 3. Restart your server 4. Configure `plugins/Ancient-Backup/config.yml` ### Basic Configuration ```yaml backup: use-zstd: true # Enable ZSTD compression (recommended) zip-level: 1 # 1 = fast, 9 = smallest file schedule: enabled: true # Enable automatic backups every-minutes: 360 # Backup every 6 hours upload: sftp: enabled: true host: "your-server.com" port: 22 username: "backup-user" password: "your-password" remote-folder: "/backups/minecraft" ``` ### First Backup Run your first backup with: ``` /abackup start ``` Check status with: ``` /abackup status ``` --- ## 📦 Commands | Command | Permission | Description | |---------|-----------|-------------| | `/abackup start` | `ancientbackup.admin` | Start a new backup | | `/abackup cancel` | `ancientbackup.admin` | Cancel the running backup | | `/abackup status` | `ancientbackup.admin` | Check backup progress | | `/abackup uploadlast` | `ancientbackup.admin` | Retry uploading the last backup | | `/abackup reload` | `ancientbackup.admin` | Reload configuration | --- ## 🎨 Discord Integration Get beautiful real-time updates in Discord: ```yaml discord: enabled: true webhook-url: "https://discord.com/api/webhooks/..." notifications: on-backup-start: true on-zip-complete: true on-upload-start: true on-upload-complete: true on-backup-complete: true ``` **Features:** - 📊 Color-coded embeds for different phases - 📈 Visual progress bars - ⚡ Real-time speed and ETA - 🎯 Step-by-step progress tracking (1/5, 2/5, etc.) --- ## ⚙️ Advanced Configuration ### File Exclusions Exclude large folders to reduce backup size: ```yaml backup: exclude: - "logs/*.gz" - "logs/*.log.*" - "plugins/dynmap/web/tiles/**" - "plugins/BlueMap/web/**" - "**/cache/**" ``` ### Streaming Mode Compress and upload simultaneously (no local file): ```yaml upload: streaming-compression: true # Requires SFTP or FTPS ``` **Benefits:** - ⚡ Faster overall backup time - 💾 No local disk space usage - 🔄 Real-time progress updates **Limitations:** - ⚠️ Retention policies not supported in streaming mode - 📍