Skip to main content

Backup and Recovery

The OPC Router stores its data in two locations: in the configuration store, where the engineering configuration is stored as YAML files, and in the project database, where the Publish function saves the runtime state. A backup that includes only one of these two locations will not fully restore the system.

What to Back Up

Configuration Store

The engineering configuration is located in the configuration directory—by default, C:\ProgramData\inray\OPC Router 5\config on Windows, and /data/config in the container. The Git-controlled portion of this directory is the subfolder versioned.

warning

Back up the entire configuration directory, not just versioned. The values for the secrets are stored separately and are not part of a version—a backup that includes only the versions will restore the connections later without their credentials.

Project Database

The project database contains the published status, the transfer log, and status data. For instructions on how to back it up on Windows—and why the program directory must also be included—see Creating a Backup . In the container, the data is located in the mount path /data; see Mount Paths .

Project Backups and Export

There are two additional ways to back up the engineering alone:

  • Automatic Project Backup – In the default settings , you can specify when it runs, how many versions are retained, where the backup is saved, and whether authentication data is included.
  • Export Project – writes selected areas of the project structure to a .rpe export file. It contains the project engineering: plug-in configurations, templates, and flows, including dependent structures, options, notifications, and GDS applications, as well as authentication data if desired. It contains no license (the license ID and system name are included in the file only as a source reference—importing the file does not license the target system), no user accounts, and no runtime data such as transfer logs or status information.

Restore

There are three ways to restore. Each of them initially restores only the configuration; the runtime will not apply the changes until you publish them to .

Starting PointMethod
A Snapshot of VersioningSelect a state and restore it; see Create and Restore Snapshots .
An export file Import a project ; this resolves conflicts in plug-in configurations and flows.
Restored files from the configuration storeRestore the files and restart the OPC Router. The restored state appears in Web Management as pending changes.
note

A restored snapshot leaves the values of the secrets unchanged because only the reference to the Key is versioned. An export file, on the other hand, contains the values of the referenced secrets; during import, a Key may be incremented. Both are available at Secrets .