Restoring Procedures
This page explains how to restore the database in PlexTrac.
This should only be used when absolutely necessary as it can result in some data loss.


  • Access to command-line where PlexTrac is hosted
  • Recent backup performed using the PlexTrac Utility
  • Possession of both the database and uploads in tar.gz format (See instructions here on how to perform a backup and prepare it to be moved to a new host)

Restoring Process

Step 1: Create a new directory in /opt/plextrac and move any contents from /opt/plextrac/backups/couchbase/ and /opt/plextrac/backups/uploads/ to this new directory.
If you do not see the directories listed above, the plextrac backup command has likely not been run yet. One this command is run, it will create these directories.
Step 2: Place only the desired {{uploads}}.tar.gz to restore to in the following directory: /opt/plextrac/backups/uploads.
Step 3: Place only the desired {{database}}.tar.gz in the /opt/plextrac/backups/couchbase.
Ensure when performing Step 2 and Step 3 that when placing the files in the given directories, these are the only files in those directories. Other files or directories may lead to errors during the restore process.
Step 4: In the /opt/plextrac/backups/couchbase directory, unzip the {{database.tar.gz}}.
tar -xvf {{database.tar.gz}}
Step 5: Make sure the path to the extracted database directory follows this example: /opt/plextrac/backups/couchbase/2022-04-13T165909Z/2022-04-13T165909Z-full.
The restore script is looking for this particular file structure. If you try running a restore, while the path to the database backup looks something like this (two backup directories exist in the path) /opt/plextrac/backups/couchbase/backups/2022-04-13T165909Z/2022-04-13T165909Z-full, the following error will occur when trying to restore:
Step 6: Run plextrac restore. Depending on the size of the database and uploads directories, it can take up several minutes for the restore to complete.
plextrac restore -v
Step 7: Enter yes or no to proceed with the restore of the database, then enter yes or no to restore the uploads.
Step 8: Navigate to the platform and check that the data has been restored.
Click Next below to learn about moving backup data.