Configuration

Configuration File

You can customize the behavior of the backup mod by changing the config file.

This is an example on how the config file could look like:

path: "./server_backups"
schedule: "0 */6 * * *"
files:
  include:
    - "world/*"
    - "config/*"
  exclude:
    - "server.jar"

path

• default: "./backup"

Path to the directory where backup files should be saved. This can be both, an absolute or relative path to the game folder. If no absolute path is specified, it defaults to the current working directory, aka. to the directory where the server.jar sits in.

schedule

• default: "0 * * * *"

Specify on what cron schedule the server should make updates. By default every hour.

files

include

• default: []

Specify paths that should be included in the backup. This is a relative path to the current working directory. You can also specify glob patterns. If no paths are specified the server will backup all files inside the current working directory.

exclude

• default: []

Specify paths that should be excluded from the backup. This is a relative path to the current working directory. You can also specify glob patterns.

Note

• Excluded paths have a HIGHER precedence than paths included, exclude will win over include if a path is matched in both include and exclude.
• The session.lock file inside the world folder will always be excluded.
• The folder specified for path will always be excluded. This prevents the server from backing up its own backups.

archive

compressionLevel

• default: 1

Specify the compression level to use when compressing ZIP files. This does only affect ZIP compression.

format

• default: "ZIP"
• possible values: "ZIP", "TAR"

Specify what format to use when compressing files.

maxKeep

• default: 5
• disable by setting: 0

Specify how many backups to keep at maximum. If a new backup is created, which exceeds the keep maximum, the oldest backup gets removed. Setting the maxKeep to 0 will disable this function.

maxAge

maxFolderSize

notify

doBackupOn:

schedule

noPlayersOnline

shutdown