Backup & Restore

Navigate to System > Backup & Restore to create backups, manage backup files, and restore the system from a previous state. Backups can also be driven from a script with the Python API Client.

Backup Tiers

Every backup is either Configuration or Full:

Configuration backups complete in seconds. Full backups may take several minutes depending on how much historical data exists.

Neither tier archives built stacks. They are large and specific to the server's CPU architecture, so a backup carries the uploaded wheels instead and the stacks are rebuilt during a restore. Your component environments themselves live in the system database and are backed up with it.

Scheduled Backups

The settings section at the top of the page configures automatic backups:

Click Save Changes after modifying any setting.

Creating a Manual Backup

1. In the Create Backup card, select the tier (Configuration or Full)
2. Click Create Backup
3. A progress bar appears showing the current step and completion percentage
4. When finished, the backup appears in the history table below

All other actions on the page are disabled while a backup or restore is in progress.

Backup History

The history table lists all existing backups with:

Each row has three actions:

• Download: saves the backup file to your computer
• Restore: starts a restore from that backup, without downloading it first — see From a backup already on the server
• Delete: permanently removes the backup file from the server

Restore and Delete need the edit backup settings permission; without it they are disabled and say so on hover. See Roles & Permissions.

Restoring from a Backup

There are two ways to start a restore. Both run the same operation and show the same progress — they differ only in where the archive comes from.

From a backup already on the server

Use this for any backup listed in the history table. Nothing is downloaded or re-uploaded, which matters most for Full backups that can run to many gigabytes.

1. Find the backup in the Backup History table
2. Click the Restore action on that row
3. The confirmation dialog shows the backup's tier, when it was created, and who created it
4. For Full backups, an optional checkbox lets you include historical time-series data in the restore. Leave it unchecked to restore only the configuration.
5. Click Restore System to begin. A progress bar tracks the operation.

From a backup file you upload

Use this when the archive is not on this server — restoring onto a fresh install, or moving a system to new hardware.

1. In the Restore from Backup card, drag and drop (or browse to select) a .tar.gz backup file
2. After upload, the backup's metadata is displayed: filename, tier, Koios version, and who created it
3. For Full backups, an optional checkbox lets you include historical time-series data in the restore. Leave it unchecked to restore only the configuration.
4. Click Restore System
5. A confirmation dialog warns that this will overwrite all current system data
6. Confirm to start the restore. A progress bar tracks the operation.

What happens during a restore

Koios stops the application services before restoring, then restores the database, media files, certificates, and license, rebuilds any stacks from the archived wheels, and restarts the services when it finishes.

Services are unavailable for the duration of the restore and come back automatically once it completes.

What's Next

• Data Retention: configure how long historical data is kept
• System Overview: check system status after a restore