Description

Simple Backup utility for servers.  Automatic backups at intervals, with configurable options such as compression to zip file, pausing auto backups if no players are online, etc.

See https://github.com/spoorn/SimpleBackup/blob/main/SUMMARY.md for technical details on the backup logic, compression, benchmarks, multi-threading, etc.

Features

• Automatic backups at configurable intervals
• Pausing backups if no players are online to save resources
• Backups are done asynchronously to minimize impact on game performance during backups
• Compressing backup to .zip or .tar.lz4 file
• Configurations to limit number of backups to keep, and guards to ensure backups do not exceed the disk space
• Manual backups can be triggered with command /simplebackup start, /simplebackup zip, /simplebackup lz4, /simplebackup directory
• Manual backup permissions can be configured in the config
• Backup is stored in the game directory under backup/ parallel to mods/ and config/ folders, or can be configured to any absolute path in the system
• Backup file format is YYYY-MM-DD_HH-MM-SS(.zip|.tar.lz4) (example: backup/2022-05-04_05-04-13.zip for ZIP format, or  backup/2022-05-04_05-04-13/ for DIRECTORY format)
• Message will be broadcast to players when backup is in progress.  The message is configured in the config to allow for language translations and keep the mod completely server-side.  The messages can be disabled
• And yeah, the mod is only required on the server!

For help on choosing which backup format to use, see https://github.com/spoorn/SimpleBackup/blob/main/README.md

Config

You can tune all the features in the config file at config/simplebackup.json5. Check out the config documentation at https://github.com/spoorn/SimpleBackup/blob/main/config-documentation.json5 for more details

Note: the config file must be in UTF-8 format. For example, if you're using a special keyboard or text editor to type special characters for the broadcast messages, it must be encoded in UTF-8. If you aren't sure, you can put your special characters in a tool like https://checkserp.com/encode/unicode/, and use that in the config file, which will be able to be parsed correctly.

Dependencies

This mod requires:

• Fabric API - /mod/fabric-api?hl=en-USi 

!requires fabric

Need a Server?