AutoBackup Wiki
Welcome to the AutoBackup Wiki! Here, we'll walk you through the process of setting up and configuring your AutoBackup plugin, ensuring seamless backups for your Minecraft server.
Installation Steps:
- Download the Plugin: Purchase and download the AutoBackup plugin from SpigotMC.
- Server Folder: Navigate to your server's plugins directory.
- Typically, this is found inside your server root and named 'plugins'.
- Transfer the Plugin: Move or copy the downloaded AutoBackup .jar file to the plugins directory.
- Start the Server: Launch your Minecraft server. This will allow AutoBackup to generate its default configuration files.
- Stop the Server: For configuration purposes, it's essential to halt your server.
- Configuring the Plugin: Navigate to the plugins/AutoBackup directory and open the config.yml file in a text editor.
Configuration Guide:
backup-interval:
- Purpose: Determines how frequently your server will be backed up.
- Format: The interval is defined in seconds.
- Default Value: 180 (which translates to every 3 minutes)
upload-as-folder:
- Purpose: Decide if the backup should be uploaded as a folder or as a ZIP file.
- Format: Boolean (true/false).
- Default Value: false (Backup will be uploaded as a ZIP file)
- Note: It's advised not to alter this setting unless you're sure about the implications.
SFTP:
This section is for detailing your SFTP server, which will be used to store your backups.
- hostname: Your SFTP server's IP or hostname.
- port: The port used for SFTP connections.
- username: The username for your SFTP account.
- password: The password for your SFTP account.
- remoteBackupPath: The path on your SFTP server where the backups will be stored.
- target-machine-seperator: Specifies the directory separator for the target machine.
- "/" for Linux-based systems
- "\" for Windows-based systems
- aliveInterval: Determines the serverAlive interval in milliseconds. It's a safety feature to keep the connection alive.
- Default Value: 5000 (5 seconds)
Final Steps:
- Save Configurations: After making your desired changes to the config.yml, ensure to save the file.
- Restart the Server: To apply the changes, restart your Minecraft server.
- Verify the Installation: Ensure AutoBackup is running correctly by executing the instant backup command and checking the specified SFTP location for the backup.
That's it! You've successfully set up and configured AutoBackup for your Minecraft server. Enjoy peace of mind, knowing your server data is safe and sound. If you encounter any issues or have further queries, refer to the SpigotMC forum thread or reach out to the plugin developer.