?
Host a server
Modrinth App
Sign in
ModsPluginsData PacksShadersResource PacksModpacks
Settings
Backuper

Backuper

Simple backup plugin for Paper/Folia with FTP/GOOGLE DRIVE/SFTP support

18.5k
74

Compatibility

Minecraft: Java Edition

1.21.x
1.20.x
1.19.x
1.18.x
1.17.x
1.16.x

Platforms

Links

Report issues View source

Creators

DVDishka
DVDishkaOwner

Details

Licensed MIT
Published 2 years ago
Updated 2 weeks ago

Backuper

Simple backup plugin for Paper/Folia with FTP/SFTP/Google Drive support.

GitHub Downloads (all assets, all releases) Modrinth Downloads Hangar Downloads

bStats Graph Data

🔗 Pages 🔗

⭐ Key Features ⭐

  • Multiple Storage Types (Local/SFTP/FTP/Google Drive)
  • Automatic backups with customizable schedule
  • Backups Management
  • Archieving or storing backup as a folder
  • Flexible Configuration
  • Async to server thread and multithreaded
  • Player Notifications

🚀 Quick Start 🚀

  1. Install the plugin in your plugins folder
  2. Configure storage settings in plugins/Backuper/config.yml
  3. Set backup schedule and preferences
  4. For cloud storage (Google Drive), link your account using commands

⚙️ Basic Configuration ⚙️

After installing the plugin, configure the main settings in plugins/Backuper/config.yml:

Backup Settings

backup:
  autoBackup: true
  autoBackupPeriod: 1440
  autoBackupCron: ''
  • autoBackup - Enable/disable automatic backups
  • autoBackupPeriod - Backup interval in minutes (1440 = 24 hours). Used only when autoBackupCron is empty
  • autoBackupCron - Backup schedule (CronMaker for custom schedules). If specified, this value is used instead of autoBackupPeriod

Local Storage

storages:
  local:
    type: local
    enabled: true
    autoBackup: true
    
    backupsFolder: ./plugins/Backuper/Backups
    
    maxBackupsNumber: 10
    maxBackupsWeight: 0
    
    zipArchive: true
    zipCompressionLevel: 5
  • enabled - Enable/disable this storage
  • autoBackup - Save automatic backups to this storage
  • backupsFolder - Directory where backups will be stored
  • maxBackupsNumber - Maximum number of backups to keep (0 = unlimited)
  • maxBackupsWeight - Maximum total size in MB (0 = unlimited)
  • zipArchive - Store as ZIP files or folders
  • zipCompressionLevel - Compression level (0-9)

For detailed configuration and remote storage options (FTP/SFTP/Google Drive), see Configuration

💾 Storage Types 💾

  • Local - Store backups on the same server
  • FTP - Upload backups to FTP servers
  • SFTP - Secure file transfer via SSH
  • Google Drive - Cloud storage with OAuth authentication

📚 Documentation 📚

⚙️ Configuration ⚙️

See Configuration

💻 Commands 💻

See Commands

🔐 Permissions 🔐

See Permissions System

🔄 Version Compatibility 🔄

Version Numbering (X.Y.Z(A))

  • X - Breaking changes without backward compatibility
  • Y - Significant changes with backward compatibility
  • Z - Minor changes and improvements
  • A - Bugfixes or security/stability improvements (hotfixes)

Major Version Changes

  • 1.x.x → 2.x.x: Complete permission and command system overhaul
  • 2.x.x → 3.x.x: Storage-specific permissions and required storage specification in commands
  • 3.x.x → 4.x.x: Storage Type replaced with Storage Id, support for multiple storages of the same type, and reworked permissions system

📝 Notes 📝

  • Please report any issues to GitHub
  • RESTART option may not work well, so it's better to use STOP with a loop in your start script (start script auto restart ON)