Skip to content

Backup and restore ​

The 丰盘ECM system is deployed as Docker containers, and a data sharing mechanism links the containers to the host. All data of the 丰盘 system is stored in the /opt/xpan/ directory on the host. Operational mistakes, virus attacks, and similar incidents can damage your company's data, so set up a backup plan as soon as 丰盘 goes into production.

To learn more about the operations architecture, read 丰盘 system architecture.

Data backup ​

All data files of the system are stored in /opt/xpan/. The subdirectories are structured as follows:

  • bin: binary files of upgrade packages for some components
  • data: database files, user-uploaded files, keys, and other sensitive data of the entire 丰盘 system.
  • logs: log files of key 丰盘 components; see Troubleshooting.
  • tools: CLI tool package for managing the 丰盘 system; see Linux operations.
  • setup: temporary files generated during installation and upgrades

The /opt/xpan/data/ directory contains three main subdirectories:

  • files: all documents that users upload to the 丰盘 system
  • pgdata: data directory of the system's PostgreSQL database, including user information, system permissions, and document metadata.
  • secrets: important key files of the system, including the database password and certificate files.

If backup resources are plentiful, the IT administrator can back up the entire directory. If backup space is tight, at minimum back up /opt/xpan/data/ on a regular schedule so that 丰盘 data can be restored promptly after a host failure.

How to restore the system ​

With a backup ready, restore the system on a new host in three steps:

Step 1: Copy the backup to /opt/xpan/ on the new server, keeping the directory structure.

Step 2: Download the latest installation script xpan-install.sh on the new server (see Installation and deployment).

Step 3: Install the software image with the same version as the old system by passing the version parameter (-v) on the new server.

Find the version of the old system on the "System Management / Version Upgrade" page, for example 23.9.1. If you do not know the version, contact our support team to look up the activation version associated with your license, then run sh xpan-install.sh -v 23.9.1. Data from different versions may be incompatible, so always restore with the same image version; otherwise you may run into unexpected problems.

Important

The 丰盘ECM system uses OTA remote updates to upgrade customers automatically to the latest pushed version. We recommend upgrading to the latest stable version at least every six months. We also retire very old versions on a regular basis, so follow our official account or watch your email for important notices such as version retirement. If you keep using a retired version and an operational incident later requires a reinstall, you get no technical support. Data from the old version also cannot be restored on the new host.