# Backups: create, restore and download

## What this is about

A backup is a saved copy of your server's files that you can roll back to if
something goes wrong: a bad mod update, a griefed world, or a config change
that broke everything. This article covers the **Backups** tab: making backups,
restoring them, getting them onto your own computer, and keeping old ones
tidy automatically.

<p class="callout info">The banner at the top of the Backups tab tells you whether your node uses <strong>ZFS</strong>. That affects whether it's safe to back up while the server is running. See <a href="https://knowledgebase.suhosting.net/books/game-panel/page/zfs-backups">ZFS Backups</a>, and for Vintage Story, <a href="https://knowledgebase.suhosting.net/books/vintage-story/page/backing-up-vintage-story-safely">Backing Up Vintage Story Safely</a>.</p>

[![Backups tab](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/bk-05-overview-with-backup.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/bk-05-overview-with-backup.png)

## Your backup limit

The top of the tab shows something like **"2 of 5 maximum backups created."**
That's your plan's limit. When you hit it:

- **Manual backups** are refused. Delete or unlock an old one first.
- **Scheduled backups** automatically remove the **oldest unlocked** backup to make room.

**Locked** backups never count as removable, so lock only the ones you really
want to keep forever.

## Creating a backup

1. Go to the **Backups** tab, click **Create**, then **Create Backup**.
2. Give it a **Name** you'll recognise later (e.g. *Before 1.21 update*). Leave it empty for an automatic name.
3. Optional: **Ignored Files** lets you leave things out, one pattern per line. For example:
   ```
   logs/
   *.log
   cache/
   ```
   Click **Count Matches** to check what your patterns would skip.
4. Optional: choose a **Backup Group** (see *Keeping backups tidy* below).
5. Click **Create**.

The backup appears in the list and shows its progress. Large servers can take a
few minutes.

[![Create Backup window](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/bk-04-create-modal.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/bk-04-create-modal.png)

<p class="callout warning">On a <strong>non-ZFS</strong> node, <strong>stop your server first</strong> if it saves its world to a database (Vintage Story and many modded games do). Backing up while the game is writing a save can give you a backup that won't load.</p>

## Restoring a backup

1. Click the **⋯** button at the end of the backup's row (or right-click the row) and choose **Restore**.
2. Decide on the options:
   - **"Do you want to delete all files of this server before performing this action?"**: wipes the server first, so you get an *exact* copy of the backup. Leave it **off** to restore the backup's files *on top of* what's there now; files added since the backup will remain.
   - **"Restore the startup command, image, and variables from this backup"**: also puts back the startup command, Docker image and variables (e.g. game version) from when the backup was taken. Turn this on if you're rolling back a game version update.
3. Confirm. The server is **stopped** during the restore.

[![Backup menu](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/bk-06-row-menu.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/bk-06-row-menu.png)

[![Restore Backup window](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/bk-07-restore-modal.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/bk-07-restore-modal.png)

<p class="callout info">Rolling back after an update went wrong? Turn <strong>both</strong> options on. That gives you the server exactly as it was, including the version it was running.</p>

## Getting a single file back: Browse (ZFS nodes)

Don't want to roll back the whole server just to rescue one config file or one
player's data? If your server is on a **ZFS** node (the Backups tab shows a
green *"ZFS is enabled on this node"* banner), you can look inside a backup and
copy out only what you need.

[![Backups tab on a ZFS node](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/gRfzfs-01-backups.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/gRfzfs-01-backups.png)

1. Click the **⋯** on the backup and choose **Browse**.

   [![Backup menu with Browse](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/a83zfs-02-row-menu.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/a83zfs-02-row-menu.png)

2. The backup opens in the **file manager**. The path at the top shows **backups / *backup name***, and everything you see is **read-only**: nothing you do here changes the backup.

   [![Browsing a backup in the file manager](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/3GNzfs-03-browse-root.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/3GNzfs-03-browse-root.png)

3. Find the file you want, click its **⋯** and pick:
   - **Copy** to put it back into your **live** server. Choose the folder, check the file name, and click **Copy**. If a file with that name already exists, the panel asks before overwriting it.
   - **Download** to save it to your computer.
   - **Open** to read it without copying it anywhere.

   [![File menu inside a backup](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/O9mzfs-05-file-menu.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/O9mzfs-05-file-menu.png)

   [![Copy File window: pick where in your live files it goes](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/rgJzfs-06-copy-dialog.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/rgJzfs-06-copy-dialog.png)

4. Click **Exit Backup** (top right) to go back to your live files.

<p class="callout warning">Copying a world or save file back while the server is <strong>running</strong> can corrupt it, or the game may overwrite it on its next save. <strong>Stop the server first</strong>, copy the file, then start it again.</p>

**Not on a ZFS node?** There's no **Browse** option. Use **Export to Files**
(below), then open the archive in the file manager and copy out what you need.

## Downloading a backup to your computer

Click **⋯ → Download**.

Keeping your own copy offsite is a good idea for anything you'd be heartbroken
to lose.

## Export to Files

**⋯ → Export to Files** saves the backup as an archive **inside your server's
files** (choose the folder and file name). Handy if you want to copy a backup
to another server over SFTP, or unpack part of it with the file manager.

Exported archives use your server's disk space, so delete them when you're done.

## Locking a backup

**⋯ → Edit** and switch on **Locked**, then **Save**. A red open padlock in the **Locked?** column means unlocked. A locked backup:

- can't be deleted until you unlock it
- is never removed automatically by retention or by scheduled backups

[![Edit Backup window with the Locked switch](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/bk-08-edit-modal.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/bk-08-edit-modal.png)

Use it for milestones: *"World before the dragon fight"*, *"Pre-wipe season 3"*.

## Keeping backups tidy: groups and retention

A **backup group** is a folder for backups with optional **retention rules**
that delete old backups for you.

1. Click **Create**, then **Create Backup Group**.
2. Name it (e.g. *Nightly*) and set the retention rules you want:

| Rule | Keeps… |
|---|---|
| **Keep latest** | The newest N backups |
| **Keep all within days** | Everything from the last N days |
| **Keep daily** | The newest backup from each of the last N days |
| **Keep weekly** | The newest backup from each of the last N weeks |
| **Keep monthly** | The newest backup from each of the last N months |
| **Keep yearly** | The newest backup from each of the last N years |

A backup is kept if **any** rule wants it. Everything else in the group is
deleted on the next retention run. Leave a rule at **0** to switch it off. With
no rules at all, the group is just a label and never deletes anything.

**Example, nightly backups:** *Keep daily 7*, *Keep weekly 4* gives you one
backup for each of the last week, plus one per week for a month. With a nightly
schedule, that's about 10 backups at a time.

Each backup in a group shows when it's expected to be deleted, so there are no
surprises.

<p class="callout info">Retention only <strong>removes</strong> backups. It doesn't <strong>create</strong> them. Pair a group with a schedule that runs <strong>Create Backup</strong> in that group. See <a href="https://knowledgebase.suhosting.net/books/game-panel/page/schedules-automating-your-server">Schedules</a>.</p>

[![Create Backup Group window with retention rules](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/scaled-1680-/bk-03-group-modal.png)](https://knowledgebase.suhosting.net/uploads/images/gallery/2026-10/bk-03-group-modal.png)

Failed backups that aren't locked are cleaned up automatically after 24 hours.

## Common questions

**"Maximum number of backups reached"**: you're at your limit, and manual backups never delete old ones for you. Delete an old backup first. Backups created by a **schedule** don't have this problem, because they replace your oldest unlocked backup automatically.

**My backup failed.** Usually the server ran out of disk space during the backup, or a file changed mid-copy. Try again with the server stopped. If it keeps failing, open a ticket with the backup's name and time.

**Does a backup include my database?** Only server files by default. If your server has a **managed database**, you can back that up separately by choosing it as the **Source** when creating the backup.