BRIX On-Premises > BRIX On-Premises Standard / Backup and restore databases for BRIX Standard

Backup and restore databases for BRIX Standard

Data backup for BRIX Standard (KinD) should include:

  • PostgreSQL. The database stores the main system data: users, app items, workspace settings and app configurations, business processes, pages, widgets, tasks, events, and other configuration settings;
  • MongoDB. The database contains unstructured system settings, live chat data, and feed entries;
  • S3 Object Storage. The object storage holds files uploaded to and created in BRIX of any type and size, such as documents, photos, audio, and video files.

 

Backup of data for BRIX Standard (KinD)

начало внимание

During the backup process, the BRIX Standard (KinD) services are halted, rendering the app inaccessible.

конец внимание

  1. Stop the BRIX Standard app by executing the command:

sudo ./elma365-installer-docker.sh --stop

  1. To create a backup of the databases, run the installation script elma365-installer-docker.sh with the --dump key:

sudo ./elma365-installer-docker.sh --dump

Example of running the installation script with the --dump key:
backup-restore-2

Upon completion of the backup, you will see a message confirming the successful creation of the dump.

The dump will be saved in a separate folder, named with the version of the distribution and a timestamp, for example, "/backup/ELMA365_2023.2.15_2023.04.10-13.52.26".
By default, dumps are saved in the "/backup" path. The directory where the BRIX Standard (KinD) system backups will be saved is specified in the ELMA365_BACKUP_DIR parameter of the config-elma365.txt configuration file. For more details on how to save backup copies, see Modify BRIX Standard parameters.

  1. Start the BRIX Standard application by executing the command:

sudo ./elma365-docker.sh --start

Restore data for BRIX Standard (KinD)

Restoring data from a backup can help recover BRIX Standard (KinD) in the event of a virtual infrastructure failure or physical infrastructure breakdown.

If you use external databases, prepare them for restoration. For more details, refer to the following articles: PostgreSQL and MongoDB.

If restoration of the host system is not possible, install BRIX on a new server.

  1. Stop the BRIX Standard application by executing the command:

sudo ./elma365-docker.sh --stop

  1. If you have previously used PostgreSQL and MongoDB databases, prepare them for restoration by completing the following steps:
  1. Restore data from a backup copy.

начало внимание

Before restoring data, make sure that the folder containing the backup copy is located in the /backup folder or in another folder specified in the parameters of the configuration file. Example of a path to the backup: /backup/<backup-folder-name>. Restoring data from folders with a deeper layer such as /backup/elma365/<backup-folder-name> is not permitted.

конец внимание

To restore the data, run the installation script with the keys --restore and --path /backup/<backup-folder-name>:

sudo ./elma365-docker.sh --restore --path /backup/<backup-folder-name>

Example of executing the installation script with the keys --restore and --path /backup/<backup-folder-name>:
backup-restore-3

Upon completion of data restoration from the backup, you will see a message confirming the successful restoration.

  1. Start BRIX Standard by executing the command:

sudo ./elma365-docker.sh --start