Configuring
FTB Backups 2 can be configured by opening the ftbbackups2.json located in the config folder of the modpack.
Configuration options
| Name | Description | Default value |
|---|---|---|
auto | Allow the creation of backups automatically | true |
command_permission_level | Permission level to use the /backup command (0-4) | 3 |
notify_op_only | Only send backup status to server ops | true |
do_not_notify | Don't send backup status at all | false |
retention_mode | Backup retention mode. Valid Modes:
| MAX_BACKUPS |
max_backups | Sets the maximum number of backups to keep, only applies when retention_mode is set to MAX_BACKUPS | 5 |
keep_latest | The latest x number of backups will be retained, only applies when retention_mode is set to TIERED | 5 |
keep_hourly | Sets number of hourly backups to keep, only applies when retention_mode is set to TIERED | 1 |
keep_daily | Sets number of daily backups to keep, only applies when retention_mode is set to TIERED | 1 |
keep_weekly | Sets number of weekly backups to keep, only applies when retention_mode is set to TIERED | 1 |
keep_monthly | Sets number of monthly backups to keep, only applies when retention_mode is set to TIERED | 1 |
backup_cron | How frequently backups should be taken, this uses the Quartz cron format, for more information go here | 0 */30 * * * ? |
manual_backups_time | Time between manual backups using the command, prevents spamming the backup command | 0 |
only_if_players_been_online | Only run a backup if a player has been online since the last backup | true |
additional_directories | Additional folder/directories to include in backup | [] |
additional_files | Additional files and directories to include in backup. Can specify a file name, path relative to server directory or wildcard file path Examples: - All file paths are relative to server root) fileName.txt - Any/all file named "fileName.txt" folder/file.txt - Exact file path folder/ - Everything in this folder path/starts/with* - Any files who's path starts with *path/ends/with.txt - Any files who's path ends with *path/contains* - Any files who's path contains | [] |
display_file_size | Displays the backup file size in the backup message | false |
backup_location | Where the backup folder containing the backups should be located, relative to the server | . |
backup_format | Specify the backup format. Valid options are ZIP and DIRECTORY | ZIP |
minimum_free_space | Minimum free disk space in MB. If a backup's creation would leave less than this amount of disk space remaining, the backup will be aborted. | 500 |
free_space_if_needed | If the previous backup failed due to lack of space, the oldest backup will be deleted to free space. | false |
excluded | Specify files or folders to be excluded. Can specify a file name, path relative to server directory or wildcard file path Examples: - All file paths are relative to server root) fileName.txt - Any/all file named "fileName.txt" folder/file.txt - Exact file path folder/ - Everything in this folder path/starts/with* - Any files who's path starts with *path/ends/with.txt - Any files who's path ends with *path/contains* - Any files who's path contains | [] |
preview_dimension | The dimension used when creating backup preview image, specify "all" to enable automatic detection of primary dimension (can be very slow) Specify "none" to disable preview | minecraft:overworld |
Cron examples
The cron format used is the Quartz cron format, you can find more information and examples here: https://www.quartz-scheduler.net/documentation/quartz-3.x/tutorial/crontrigger.html#examples
The format is as follows:
s i h dom m dow y
⎜ ⎜ ⎜ ⎜ ⎜ ⎜ ⎜
'--+--+--+--+--+--+--> 1st: seconds
'--+--+--+--+--+--> 2nd: minutes
'--+--+--+--+--> 3rd: hours
'--+--+--+--> 4th: days of month ---\
'--+--+--> 5th: months | mutually exclusive
'--+--> 6th: days of week ---/
'--> 7th: years