Commands

Note: A number of subcommands changed in version 0.15.0. You can see the docs for version 0.14 here.

Type /backup followed by one of these subcommands:

Command Use
init Initialize fastback for the current world. Run this first.
help Get help on commands.
local Perform a local backup immediately.
full Perform a local backup followed by a remote push (if configured).
restore Restore a backup snapshot.
delete Delete an individual snapshot.
info Info about current backup state and settings.
list List backup snapshots for this world.
push NEW! Push a snapshot to the remote.
prune Delete old snapshots according to the retention policy.
gc Run garbage collection to free up disk space.
create-file-remote Create a remote backup target on the file system.
remote-delete Delete a remote snapshot.
remote-list List remote snapshots.
remote-prune Delete old snapshots from the remote backup according to the remote retention policy.
remote-restore Restore a remote snapshot.
set retention-policy Set retention policy for local snapshots.
set remote-url Set the url for remote backups.
set shutdown-action Set an action to perform on shutdown.
set autoback-action Set an action to perform during auto-backups.
set autoback-wait Set the minimum number of minutes to wait between auto-backups.
set restore-directory Target directory for restored snapshots. Useful for servers with limited tmp space.
set remote-retention-policy Set retention policy for remote snapshots.
set mods-backup-enabled NEW! Whether to also backup mod jars and config files (in .fastback/mods-backup)
set broadcast-enabled NEW! Whether to send a server-wide notice when a backup is starting.
set broadcast-messageNEW! Customized server-wide notice message.
set lock-cleanup-enabled NEW! Automatic cleanup of orphaned index.lock files. Be careful!
set force-debug-enabled NEW! Enable verbose debugging output to the console. Useful if you’re running into problems.