Dev License: This installation of WHMCS is running under a Development License and is not authorized to be used for production use. Please report any cases of abuse to [email protected]

DriveBackupV2 Print

  • 0

DriveBackupV2 provides an extra layer of security to your data by backing it up remotely. It can creates backups to Google Drive, OneDrive or a remote (S)FTP server.

Setup

First, you need to download the latest version of DriveBackupV2.

Import the downloaded DriveBackupV2.jar file in the plugins folder in the server and restart your server.

When the server restarts, it will load the plugin and generate files in the new folder called DriveBackupV2.

  • Setup backups using Google Drive

    To connect your Google Drive account, run the command /drivebackup linkaccount googledrive in the server.

    This will give you a link and a code to connect to your account.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e8bcf2d9-7359-4bfb-83c0-42285dc2960b/Untitled.png

    On the given link, it will ask you to enter the code seen in the message.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/da6a2d0a-24bb-4db5-83c2-30c428b00915/Untitled.png

    After the code, follow the next steps, allow it to access the folder to make backups and you successfully connected your account. A message letting you know it connected will display in server

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/01b123af-8a19-446d-9a79-d4b8a55951f2/Untitled.png

  • Setup backups using OneDrive

    To connect your OneDrive account, run the command /drivebackup linkaccount onedrive in the server.

    This will give you a link and a code to connect to your account.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/6b8eab5c-ac23-4b2f-86f1-1813477b73bc/Untitled.png

    On the given link, it will ask you to enter the code seen in the message.

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3750a2a-68d5-4efe-8140-ff434dc58817/Untitled.png

    After the code, follow the next steps, allow it to access the folder to make backups and you successfully connected your account. A message letting you know it connected will display in server

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/daa09453-767b-4fef-8722-056b18e7524f/Untitled.png

  • Setup backups using a remote (S)FTP

    (S)FTP backups is configurable in the config.yml file of the plugin, explained here.

Configuration

In the generated plugins folder DriveBackupV2 there is a file called config.yml which allows configuring the plugin. To apply any changes done here, you need to save the file and run the command /drivebackup reloadconfig in the server to reload the config.

delay How often to run a backup, in minutes. By default, this is set to 60 minutes. If you want to make a backup every 2 hours, you will set this to 120 minutes.

backups-require-players Whether automatic backups should be disabled if there hasn't been any new player activity since the last backup. This is on by default.

zip-compression The compression level of the backup .zip files. A higher compression level means a smaller file. You can set this between 0 and 9, with nine being the highest compression level. Set this to -1 to use the default.

Remote backups

keep-count How many backups to keep remotely before deleting the oldest one. By default it is set to 20. Setting it to -1 will disable the automatic delete.

destination The path to the folder to save backups in on the remote server. This should be relative to the remote root folder. This is set to backups by default.

Local backups

local-keep-count How many backups to keep locally before deleting the oldest one. By default, it is set to 0. Setting it to -1 will disable the automatic delete.

dir The path to the folder to save backups locally. This should be relative to the folder containing the Minecraft server jar. This is set to backups by default. Example: If you want to save to folder /home/container/backups/data you should set it to backups/data.

Specifying what to backup

By default, it will backup world and plugins folders, you can specify any files and/or folders.

backup-format-timezone The timezone for the backup zip files' naming format. The list of timezones can be found here.

Example timezones

backup-list The list of files/folders to back up. The entries are divided to 4 things:

  • path The file/folder path should be the path to the file/folder you want to backup. It is relative to /home/container. Example: important/data will select the folder data in important. The full path would be /home/container/important/data.

  • format The file name format is the naming scheme of the zip file that will be created, this should contain a timestamp, included using date and time pattern letters. You can learn more about them here.

    Naming Format

  • glob Backs up all folders matching the file glob specified. When this setting is set, the path setting is ignored and doesn't apply. Each folder matching the specified file glob is still backed up in separate zip files. Example: world* will select all folders that start with name "world". In PaperMC, that's world, world_nether and world_the_end.

  • create Whether to not create a zip backup for the specified path.

  • blacklist A list of file globs. Files/folders matching a glob will not be included in the backup. Example: **/*.jar will blacklist all files with the jar extension.

Example backup list:

backup-list:
- path: "world"
	format: "'Backup-world-'yyyy-M-d--HH-mm'.zip'"
	create: true
- path: "plugins"
	format: "'Backup-plugins-'yyyy-M-d--HH-mm'.zip'"
	create: true
backup-list:
- glob: "world*"
	format: "'Backup-world-'yyyy-M-d--HH-mm'.zip'"
	create: true

Scheduled backups

scheduled-backups backups run at each specified day of the week/time combination.

schedule-timezone The timezone the times in the schedule are in. The list of timezones can be found here.

backup-schedule-list The list of the days/times to run a backup. The entries are divided to 2 things:

  • days The days to run the backup on should be a list of any of the following:
    • Days of the week: sundaymondaytuesdaywednesdaythursdayfriday or saturday.
    • Groups of days: weekdays or weekends.
    • All days: everyday.
  • time The time to run the backup should be in 24-hour format. If the time is before 10 o'clock, then there must be a zero in front of the hour. Example: 05:00 (5 AM), 12:00 (12 PM)

Example of a schedule list in config.yml:

backup-schedule-list:
- days: 
  - "monday"
  - "friday"
  time: "06:00"
- days: 
  - "weekends"
  time: "21:30"

(S)FTP Setup

You can configure to backup to FTP, FTPS or SFTP server. Currently, DriveBackupV2 can only back up to one such server at a time.

This configuration is under section ftp of the config.yml containing:

  • enabled Whether this backup method is enabled.
  • hostname The hostname or IP address of the server to connect to.
  • port The port of the server. For FTP and FTPS, this is usually 21. For SFTP, this is usually 22.
  • sftp Whether the server to is an SFTP server.
  • ftps Whether the server to is an FTPS server.
  • username The username to connect to the server under.
  • password The password to be used to authenticate with the server. Leave blank if no password required.
  • working-dir The directory to work in on the server. Leave blank to use the default. This is not to be confused with the backup destination setting.

This settings only applies to STFP servers:

  • sftp-public-key The path to the key to be used to authenticate with the server. The path should be relative to the DriveBackupV2 folder. Leave blank if you are not using public-key authentication.

    DriveBackupV2 can connect to SFTP servers that use both basic and public-key authentication.

  • sftp-passphrase The passphrase to be used in conjunction with the key to authenticate with the server. Leave blank if you are not using public-key authentication or no passphrase is required.


Was this answer helpful?

« Back

Powered by WHMCompleteSolution