Prepare a Backup

NXRM stores data in blob stores. Metadata and configuration information are stored separately in databases. The blob stores and metadata databases must be backed up together or the blob store metadata may be non-descript when attempting to restore the exported data. Your backup strategy should involve copying both your databases and blob stores together to a new location, in order to keep the data intact.

Complete the following steps to perform a backup:

  1. Blob Store Backup
  2. Database Backup

Blob Store Backup

The filesystem or object store containing the blobs must be backed up outside of NXRM.

  • For File blob stores, the directory storing the blobs should be backed up.  For a typical configuration this will be $data-dir/blobs.  
  • For S3 blob stores, bucket versioning can be used as an alternative to backups or the bucket can be mirrored to another S3 bucket.

Database Backup

The databases that you export have pointers to blob stores which contain components and assets potentially across multiple repositories. If you don’t back them up together the component metadata can point to non-existent blob stores, or the blob store metadata may be non-descript when attempting to restore the exported data. So, your backup strategy should involve copying both your databases and blob stores together to a new location, in order to keep the data intact.

Here’s a common scenario for backing up custom configurations in tandem with the database export task:

  1. Configure the Admin - Export databases for backup Task to export databases.
  2. Run the scheduled task to export the databases to the configured folder.
  3. Back up custom configurations in your installation and data directories at the same time you run the export task.
  4. Back up all blob stores.
  5. Store all backed up configurations and exported data together.

Write access to databases is temporarily suspended until a backup is complete. It’s advised to schedule backup tasks during off-hours.