Backup and Restore

Backups run automatically every 24 hours by default and can be taken while every component keeps running. The interval and the retention period are set per component (Backup & retention in its settings).

Backup

Since 4.2.0 a backup copies every database of the component (every .db file in its dbs folder) into one folder per run:

<install dir>/dbs/backup/2026-09-27_101500/
    webserver.db  app.db  metrics.db  snmp_config.db  ...

• Each database is copied inside a read transaction, so the copy is consistent even while the component is collecting.
• The folder and its files are readable by the service account only (0700 / 0600): a backup contains the component’s encryption key together with the secrets it protects. Store and transfer backups like credentials.
• Backup sets older than the retention period are deleted automatically, together with the loose backup files of versions before 4.2.0.

Backups can also be taken on demand, for one component or for all of them. Both actions need the admin role.

Backup all at once

This backs up the webserver and every enabled component.

1. Click on the backup all KV store button
   
   
   

A notification at the bottom right reports the result for each component.

Backup one component

1. Right-click the component in the topology and choose backup the database.
   
   
   
   

Restore

A component keeps its databases open while it runs, so a restore is always done with the component stopped:

1. Stop the component (service or daemon).
2. Pick one backup set, for example dbs/backup/2026-09-27_101500/, and copy all its files into the component’s dbs folder, replacing the current ones. Take every file from the same set: files from different runs may not match each other.
3. Start the component.

On the same host nothing else is needed: the encryption key travels inside the backup.

To restore on another host, also copy the component’s config folder (TLS certificates and signing keys) and keep the same _sharedInternal value in its config file. When the webserver starts it issues new access tokens to every component by itself.

Translations

• fr: Sauvegarde et restauration