Using the Snapshot System

Snapshots save a complete copy of your server, including all files, startup settings, and database configurations. They are useful for preserving your server's full state before making major changes, so you can restore everything exactly as it was if something goes wrong.

Because snapshots save everything - including your server version, startup settings, and all your files - they are also a great way to switch between completely different setups on the same server. For example, you could have one snapshot for a vanilla SMP you play with friends and another for a modpack. When you want to switch, just restore the snapshot for the setup you want to play and your server is ready to go, no reconfiguration needed.

What Does a Snapshot Include?

A snapshot saves:

• All server files - world data, plugins, configurations, and everything else in your server directory
• Startup command - the command used to start your server
• Docker image - the container image your server runs on
• Startup variables - settings like server version, difficulty, and other startup configuration
• Database configuration - your SQL database setup

This makes snapshots more comprehensive than backups, which only save your server files.

Accessing Snapshots

1. Log in to the Game Panel
2. Select your server
3. In the left menu, click Data
4. Select Snapshots

You can have up to 5 snapshots at a time. The page shows how many you have used out of your total allocation.

Creating a Snapshot

1. Click the Create Snapshot button
2. Enter a name for the snapshot (required)
3. Optionally add a description to help you remember what this snapshot is for
4. Click Create

The snapshot will begin creating in the background. You will see a spinner next to it while it is being processed. Once complete, the snapshot will show its size, creation date, and a checksum.

Tip: Give your snapshots descriptive names like "Before plugin update" or "Working 1.21 setup" so you can easily identify them later.

Restoring a Snapshot

Restoring a snapshot replaces your server's current files and startup settings with the ones saved in the snapshot.

1. Click the three dots next to the snapshot you want to restore
2. Select Restore Snapshot
3. A comparison screen will show you what will change:
   • Any differences in your startup command
   • Any differences in your Docker image
   • A side-by-side comparison of any startup variables that have changed since the snapshot was taken
4. Read the warning carefully - restoring will replace all current server files and startup settings, and this cannot be undone
5. Tick the confirmation checkbox
6. Click Restore

Your server will enter a restoring state while the snapshot is applied.

Locking and Unlocking Snapshots

You can lock a snapshot to prevent it from being accidentally deleted.

• Click the three dots next to a snapshot and select Lock Snapshot
• Locked snapshots display a red lock icon
• To unlock, click the three dots and select Unlock Snapshot

Locked snapshots cannot be deleted until they are unlocked.

Deleting a Snapshot

1. Click the three dots next to the snapshot
2. Select Delete Snapshot
3. Confirm the deletion

Note: You cannot delete a locked snapshot. Unlock it first if you need to remove it.

Snapshots vs Backups

Feature	Snapshot	Backup
Server files	Yes	Yes
Database	Yes	Yes
Startup command	Yes	No
Docker image	Yes	No
Startup variables	Yes	No
Off-site storage	No	Yes
Maximum allowed	5	Varies

Both have their strengths. Backups are stored off-site, meaning your data is kept on a separate system from your server. This makes them better for long-term redundancy and protection against hardware issues. They are also ideal for regular saves of your world and plugin data.

Snapshots are stored alongside your server and are better suited for capturing your entire server state before making changes. If you need to preserve startup settings, Docker image, and server version alongside your files, a snapshot is the way to go.

For the best protection, use both - regular backups for ongoing file safety, and snapshots before major changes like version upgrades or switching setups.

Need Help?

If you encounter any issues or need further assistance, you can reach us through:

• Support Ticket
• Discord Server - use the /support command
• Email: [email protected]