Skip to content

Backup

The Backup module lets an administrator generate a full CyberElements configuration backup on demand and, conversely, restore an existing backup. It is used before a sensitive operation (upgrade, migration, structural change) or to roll back.

The screen presents two sections: Backup generation and Backup restoration. The state of both operations is polled every 5 seconds from the server.


Backup generation

Field Description
Generate backup Button that starts server-side generation. During the operation the form is covered by a loading mask reading Backup generation in progress.
(state) Label displayed to the right of the button. Possible values: No backup available, Backup generated on followed by the date, Backup generation failed, and A backup is available on the other server when the backup was produced on the second server of a cluster.
Download last backup Button enabled only when a backup is available locally. Downloads the .tar.gz file.

MSSQL backup

When the database is MSSQL, a warning is displayed at the top of the section; its wording differs between the tenant administration console and the system console. An additional warning appears when the vault also uses MSSQL.


Backup restoration

A permanent warning opens the section: restoring makes the platform unavailable for a few tens of seconds and disconnects every user.

Field Description
Restore database connection settings (databasesettings.ini) Checkbox visible only from the system console.
Create databases if necessary (PostgreSQL only) Checkbox visible only from the system console.
Migrate databases from earlier versions Checkbox. Tick it when the backup comes from an older CyberElements version — the databases are then upgraded to the current version after restoration. It does not appear when the database is MSSQL.
Backup file Mandatory upload field. Select a local .tar.gz file.
Restore backup Button that starts the restoration. During the operation the form is covered by a loading mask reading Backup restore in progress.
(restoration state) Label displayed to the right of the button. Possible values: Backup restored on followed by the date, Backup restore failed, or backup restore was partially successful. The following organisations could not be restored: followed by the list.

MSSQL restoration

As for generation, warnings specific to MSSQL and to an MSSQL vault are displayed above the form when those databases are in use.

Automatic polling

The backup and restoration states are refreshed automatically every 5 seconds while the window is open. During a running restoration, the display is not reset until the operation completes or fails.