Skip to main content

Backup

The Backup feature in 1Gateway allows you to automatically and manually create snapshots of your system's state, including configuration, logs, audit data, and catalog.

Accessing Backup Settings​

  1. Click the left menu button (three lines) in the top-left corner.
  2. Navigate to Setup.
  3. Scroll down and select Backups.

Backup Configuration​

In the Configuration section on the left, click the gear icon to edit backup settings. The following options are available:

  • Enable: Set to true to activate automatic backups.
  • Interval: Define how often backups should occur (e.g., every 10 minutes, 2 hours, etc.).
  • Retention: Number of backups to retain. When this limit is reached, the oldest automatic backup is deleted upon creation of a new one.
    Note: Manually created backups are not affected by retention limits.
  • Location: File path for storing backups. Default is ./data/backup/.
  • Include Logs: If checked, system logs will be included in each backup.
  • Include Audit: If checked, audit data will be included.
  • Include Catalog: If checked, the catalog will be included.
  • Include Catalog: If checked, the catalog (the set of installed plugins) will be included.
    Note: Since plugins are also available in the plugin repository, it is not always necessary to back them up. Be aware that including both Audit and Catalog can make the backup file very large.

Catalog​

The catalog property refers to the data/catalog directory located in the 1Gateway installation directory. This directory contains important runtime artifacts and configuration resources used by the system.

Directory Contents The catalog directory includes:

  • Installed plugins
    All plugins currently installed in 1Gateway.
  • Plugin logos
    Logo assets associated with the installed plugins.
  • Schemas
    • NormalizedAlarm schema
    • NormalizedIncident schema
    • Any additional custom schemas defined in the system
  • Archive of installed items
    A historical archive of items installed through 1Gateway.

Manual Backups​

To create a backup manually, click the Backup Now button in the left section of the Backups screen.

Viewing and Downloading Backups​

On the right side of the screen, you will see a list of existing backups. Each entry includes a download icon, which you can click to download the corresponding backup file.

Restoring a Backup​

To restore a backup, simply drag and drop the backup file onto the main UI screen. The system will automatically load the backup and apply its configuration.

Backup