Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Usage guide

Jump to bottom
P529 edited this page May 20, 2023 · 1 revision

Configuration

The configuration file contains various parameters for the backup process. The following parameters can be modified:

  • BackupTimer: Defines when a backup should be created, formatted as 'hh-mm'. E.g., '12-30' represents 12:30.
  • DeleteOldBackups: Allows for the automatic deletion of backups after a certain number of days (default is 7 days). Set to '0' to disable deletion.
  • BackupLimiter: Sets a limit on the total number of backups. If this number is exceeded, the oldest backup will be deleted. Set to '0' to disable this feature. Note: Enabling this feature will disable the DeleteOldBackups feature.
  • KeepUniqueBackups: If set to 'true', unique backups will not be deleted.
  • Blacklist: This is a list of files/directories that will not be backed up.
  • UploadBackup: Set to 'true' if you want to store your backups on an FTP server.
  • DeleteLocalBackup: If you're using FTP backups, setting this to 'true' will remove the local copy of the backup after it has been uploaded.

Commands

Here are the commands that you can use:

  • /backup reload: Reloads the configuration.
  • /backup list : Shows a list of 10 backups.
  • /backup search : Shows a list of 10 backups that contain the given search argument.
  • /backup create : Creates a new backup of a world.
  • /backup remove : Removes an existing backup.
  • /backup zip : Compresses a folder into a ZIP file.
  • /backup unzip : Extracts a ZIP file.
  • /backup ftp <download/upload/list>: Downloads, uploads, or lists FTP backup files.
  • /backup dropbox upload : Uploads a backup file to Dropbox.
  • /backup webdav upload : Uploads a backup file to WebDAV.
  • /backup shutdown: Shuts down the server after backup tasks are finished.
  • /backup tasks: Prints a list of currently running backup jobs.

Dropbox Configuration

The plugin supports backup to Dropbox. Here's how to configure it:

  • Set the Cloud.Dropbox.AppKey and Cloud.Dropbox.AppSecret.
  • If these are set correctly, an activation link will be generated automatically. Follow this link to authorize the app with your Dropbox account.
  • After authorizing, an access token will be generated. This should be set in the Cloud.Dropbox.AccessToken field.

For a detailed explanation on setting up Dropbox, watch this video: Dropbox Configuration

For additional help or questions, join the Discord server: Discord Link

Clone this wiki locally