Backing up and restoring SECollab

SECollab keeps its data in three places. A complete backup contains the three of them, taken at the same time:

Store Content Location
Neo4j database The published designs, the projects, the reviews, the links and most of the other resources. The secollab and trsreplica databases of the Neo4j server that the context parameters of SECollab reference.
PostgreSQL database The event logs, the history of the reviews and the content of the TRS feeds that SECollab provides. The PostgreSQL database of SECollab, usually named secollab.
Server workspace The files that the server keeps outside the databases. The directory set by the mdw.server.workspace context parameter. The Server Settings (see Server settings and activation keys) page shows it as Workspace Location.

A project export (see Importing and exporting projects) is not a backup. It contains one project, and you can import it only on a server with the same SECollab version.

Taking a consistent backup

The three stores must match. If users change data while you back up one store after the other, the stores can become inconsistent. Do the backup when the server has no activity, for example at night:

  1. Stop the SECollab web application, or the application server that runs it. This step guarantees that no publication or user action changes the data during the backup.
  2. Back up the Neo4j database. See Backup and restore in the Neo4j administration chapter.
  3. Back up the PostgreSQL database, for example with pg_dump:
    pg_dump --format=custom --dbname=secollab --file=secollab-2026-10-05.dump
  4. Copy the server workspace directory, for example to a backup disk.
  5. Start SECollab again.

Test your backups regularly: restore them on a test server and make sure that SECollab starts and shows the expected data.

Restoring a backup

  1. Stop SECollab.
  2. Restore the Neo4j database. See Backup and restore.
  3. Restore the PostgreSQL database, for example with pg_restore:
    pg_restore --clean --if-exists --dbname=secollab secollab-2026-10-05.dump
  4. Replace the server workspace directory with the copy that you took at the same time.
  5. Start SECollab, then log in and make sure that the data is correct.

Restore the three stores from the same backup. A mix of stores from different dates gives inconsistent data. For the details of the database tools, see the Neo4j operations manual and the PostgreSQL documentation.