Configuration Backup / Restore
This describes how to keep the gateway's PLC registration information / tags / environment settings in a safe place and restore them when needed.
Container-mode boxes create an automatic pre-snapshot during OTA upgrades
(/data1/pp-backups/pe-backup-<ts>.tar.zst). The "Backup" button in the UI invokes the host's backup.sh
via a signal file — a combined snapshot of Cassandra drain + Redis AOF + HiveMQ + Node-RED + /etc/kopens.
For restore, run restore.sh <archive> over SSH (the current state is also backed up automatically before restoring).
Manual: sudo bash /opt/kopens/install/bin/backup.sh. For details, see
Container Mode Backup/Restore.
When should you back up
| Situation | Recommendation |
|---|---|
| When you have finished registering all PLCs / tags for the first time | Initial backup |
| After a large change (adding / modifying dozens of tags) | Back up immediately after the change |
| Regularly (weekly / monthly) | Operational standard |
| Right before an upgrade / reinstall | Mandatory |
1. Backing up from the screen
Click the [Settings] gear icon in the upper right → Backup (clock icon).
- The backup file is created automatically.
- The download location / file name varies by environment.
- It is usually saved to the internal backup directory on the PC or downloaded immediately.
Move the generated file to a separate, safe storage location (in-house NAS, cloud drive, etc.). If the gateway PC itself fails, any backup stored on it is lost along with it.
2. Exporting PLCs / tags to CSV
If, apart from a full backup, you want to view and manage only the PLC / tag list in Excel, you can use the CSV export function.
- In the [Connection] menu → [CSV Bulk Upload] screen, there is an option such as "Download current registrations".
- Edit the downloaded CSV in Excel and bulk-upload it again.
CSV can also be used as an editable backup.
3. Restore
Situations requiring a restore (PC replacement / reinstall / rolling back an incorrect change) usually require help from 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
- Have the system administrator run the restore script (or restore the Cassandra data)
- Restart the gateway
If you are restoring from a CSV backup, you can re-register everything via [Connection] → [CSV Bulk Upload].
Frequently asked questions
Q. How large is a backup, typically?
With roughly 100 to 1000 PLCs / tags, it is usually a few MB to a few tens of MB. If time series data is backed up as well, it can be much larger (ask your administrator for a separate plan).
Q. Is time series (historical data) backed up too?
The default backup includes settings only. Time series data is managed in a separate store (Cassandra, etc.) and requires its own backup policy. Check the time series backup / retention period with your system administrator as well.
Q. Are passwords included in the backup?
Administrator passwords / MQTT passwords and the like are included. Do not share backup files carelessly. Encrypted storage is recommended where possible.
Q. How do I set up automatic backups?
You can configure the operating system's cron / task scheduler to run the backup command on a regular basis. Ask your system administrator to set up automatic backups.