Configuration Backup and Restore
This describes how to safely store the gateway's equipment registration information / tags / environment settings and restore them when needed.
Container mode boxes automatically generate a pre-snapshot during OTA upgrades
(/data1/pp-backups/pe-backup-<ts>.tar.zst). The UI "Backup" button calls the host's backup.sh
as a signal file — an integrated snapshot of Cassandra drain + Redis AOF + HiveMQ + Node-RED + /etc/kopens.
Restoration is done via SSH with restore.sh <archive> (current state is also automatically backed up before restoration).
Manual: sudo bash /opt/kopens/install/bin/backup.sh. For more information, see
Backup and Restore.
When should you back up
| Situation | Recommendation |
|---|---|
| After initially registering all PLCs / tags | First backup |
| After large changes (adding/modifying dozens of tags) | Backup immediately after changes |
| Periodically (weekly / monthly) | Operational standard |
| Before upgrade / reinstallation | Mandatory |
1. Backing up from the screen
Click the [Settings] gear icon in the upper right corner → Backup (clock-shaped icon).
- A backup file is automatically created.
- The download location / filename varies depending on the environment.
- It is typically saved in the PC's internal backup directory or downloaded immediately.
Move the created file to a separate, secure storage (in-house NAS, cloud drive, etc.). If the gateway PC itself fails, any backup stored on it is lost as well.
2. Exporting PLC / tags as CSV
In addition to full backups, if you want to view and manage only the PLC / tag list in Excel, you can use the CSV export function.
- In the [Connections] menu → [CSV Bulk Upload] screen, there is an option like "Download current registered contents".
- After editing the downloaded CSV in Excel, you can upload it again in bulk.
The CSV can also be used as an editable backup.
3. Restore
Situations requiring restore (PC replacement / reinstallation / undoing incorrect changes) usually require the help of a system administrator.
General procedure:
- Install / boot the new gateway
- Log in with the same system administrator account
- Upload the backup file to the gateway host
- The system administrator runs the restore script (or restores the Cassandra data)
- Restart the gateway
To restore from a CSV backup, you can register everything again in bulk via [Connections] → [CSV Bulk Upload].
Frequently Asked Questions
Q. How large are the backups typically?
With around 100 ~ 1000 PLCs / tags, they are usually a few MB to tens of MB. If you back up time-series data too, it can be much larger (request a separate plan from the administrator).
Q. Are time-series (historical data) also backed up?
The default backup includes settings only. Time-series data is managed in a separate storage (e.g., Cassandra) and requires a separate backup policy. Please confirm the time-series backup / retention period with the system administrator.
Q. Are passwords included in the backup?
Administrator passwords / MQTT passwords, etc., are included. Do not share backup files carelessly. If possible, we recommend encrypted storage.
Q. How do I set up automatic backups?
You can configure the operating system's cron / task scheduler to run backup commands periodically. Please ask your system administrator to introduce automatic backups.