Color theme

Backup System

Eranio

Backup System

Create, restore and delete backups. The page lists every backup in the server's backup folder.


Overview

Three figures sit at the top: number of backups, storage used and time of the latest backup ("none yet" when there is none).

Below, the backups are shown as cards in two columns, each with file name, size (B, KB, MB or GB) and age ("2 hours ago"). The search field filters by file name. How many backups fit on a page is set by Items per page on the setup page (default 15). The list refreshes every 60 seconds.

Permissions

Action Permission
View backups hytale-admin.backups-read
Create, restore, delete backups hytale-admin.backups-manage

Create a backup

Create backup opens a dialog to choose the backup type:

Type What is backed up How
World, Hytale (default) The world Through the Java mod's own backup. Hytale saves all chunks first, so this is the safe way while the server is running.
Full The whole server directory Pelican packs the files as a ZIP
Mods The mods folder Pelican packs the files as a ZIP

The backup is stored in the backup folder from the setup page (default backup).

Result Message
Success "Backup created successfully" with the file name
Error "Failed to create backup", for world backups with the reason reported by the mod

Restore a backup

Restore asks for confirmation and for the restore type:

Type What happens
World The world folder (default universe) is emptied completely first, then the backup is extracted into it
Mods The mods folder is emptied completely first, then the backup is extracted into it
Full The backup is extracted into the server directory and overwrites existing files, nothing is deleted

The backup file itself is kept.

Important: Stop the server before restoring. With World and Mods, everything that is not in the backup is gone.

Result Message
Success "Backup restored successfully"
Error "Failed to restore backup"

Delete a backup

Delete removes the file permanently after a confirmation.

Result Message
Success "Backup deleted"
Error "Failed to delete backup"

All three actions are recorded in the activity log.


Troubleshooting

"Failed to create backup"

  • Disk full: check the server's free space
  • World backup: the Java mod must be running and reachable, the reason is shown in the message
  • Permissions: the backup folder must be writable

"Failed to restore backup"

  • The backup file may be damaged
  • Stop the server first, files may be locked
  • Not enough space to extract

Which type for what

Scenario Recommended type
Quick backup before experimenting World, Hytale
Before mod updates Mods
Before bigger changes or a move Full
Regular backup while running World, Hytale