Backup & Restore
Backup & Restore
Section titled “Backup & Restore”Protecting your server data is critical. The KyuubiSoft Panel provides comprehensive backup functionality.
Backup Overview
Section titled “Backup Overview”Backups include:
- World data (all worlds)
- Server configuration
- Player data
- Plugin configurations
Backups are stored as compressed .tar.gz archives.
Creating Backups
Section titled “Creating Backups”Manual Backup
Section titled “Manual Backup”- Go to Backups
- Click Create Backup
- Wait for completion
- Backup appears in list
Scheduled Backups
Section titled “Scheduled Backups”Set up automatic backups:
- Go to Scheduler
- Click Add Task
- Select Backup type
- Configure schedule:
# Daily at 4 AM0 4 * * *# Every 6 hours0 */6 * * *
- Save task
Pre-Update Backups
Section titled “Pre-Update Backups”Configure automatic backup before updates:
- Go to Settings → Updates
- Enable Backup Before Update
- Enable Backup Config Before Update
Backup Storage
Section titled “Backup Storage”Location
Section titled “Location”Backups are stored in:
/opt/hytale/backups/Naming Convention
Section titled “Naming Convention”hytale_backup_YYYYMMDD_HHMMSS.tar.gzhytale_manual_YYYYMMDD_HHMMSS.tar.gzStorage Management
Section titled “Storage Management”- Monitor backup folder size
- Old backups are NOT auto-deleted
- Manually remove old backups or set up cleanup
Restoring Backups
Section titled “Restoring Backups”From Panel
Section titled “From Panel”- Go to Backups
- Find the backup to restore
- Click Restore
- Confirm the action
- Server restarts automatically
Restoring overwrites current server data. Create a backup of current state first.
Manual Restore
Section titled “Manual Restore”# Stop the serverdocker-compose stop hytale
# Extract backupcd /opt/hytale/datatar -xzf /opt/hytale/backups/hytale_backup_20260130_040000.tar.gz
# Start the serverdocker-compose start hytaleDownloading Backups
Section titled “Downloading Backups”Download backups for off-site storage:
- Go to Backups
- Click Download on desired backup
- Save the
.tar.gzfile
Backup Best Practices
Section titled “Backup Best Practices”Frequency
Section titled “Frequency”| Server Type | Recommended |
|---|---|
| Development | Daily |
| Small Server | Every 6 hours |
| Large Server | Every 2-4 hours |
| Before Updates | Always |
Retention
Section titled “Retention”Keep backups for:
- Last 7 days: All backups
- Last 30 days: Daily backups
- Older: Weekly backups
Off-Site Storage
Section titled “Off-Site Storage”Don’t keep all backups on the same server:
- Download important backups
- Use cloud storage (S3, Google Drive)
- Set up automated sync
Testing Restores
Section titled “Testing Restores”Regularly test your backups:
- Create a test environment
- Restore a backup
- Verify data integrity
- Document the process
Disaster Recovery
Section titled “Disaster Recovery”Complete Data Loss
Section titled “Complete Data Loss”If all data is lost:
- Install fresh KyuubiSoft Panel
- Configure same environment variables
- Restore from off-site backup
- Verify server functionality
Corrupted World
Section titled “Corrupted World”If world data is corrupted:
- Stop the server
- Identify last known good backup
- Restore that backup
- Accept data loss since backup
Configuration Issues
Section titled “Configuration Issues”If configuration is broken:
- Restore only config files from backup
- Or manually fix configuration
- Keep config backups separate
Backup Contents
Section titled “Backup Contents”What’s Included
Section titled “What’s Included”backup/├── worlds/ # All world data├── config.json # Server config├── panel-config.json # Panel settings├── players/ # Player data├── whitelist.json # Whitelist└── plugins/ # Plugin configsWhat’s NOT Included
Section titled “What’s NOT Included”- Server JAR file
- Assets
- Mods/Plugins (binaries)
- Panel users/roles
- Backup files themselves
Troubleshooting
Section titled “Troubleshooting”Backup Fails
Section titled “Backup Fails”- Check disk space:
Terminal window df -h /opt/hytale/backups - Check permissions:
Terminal window ls -la /opt/hytale/backups - Review container logs
Restore Fails
Section titled “Restore Fails”- Verify backup file integrity:
Terminal window tar -tzf backup.tar.gz - Check available disk space
- Ensure server is stopped
Large Backups
Section titled “Large Backups”For large worlds:
- Increase container memory
- Use compression:
tar -czf - Consider incremental backups
- Exclude unnecessary files