Control Center Backup and Restore
Since HiveMQ 4.2.0 it is possible to create backups and restore from backups with the HiveMQ Control Center.
For a detailed explanation of how the backup and restore functions work, see HiveMQ Backup and Restore.
Control Center Backups
The Backup page of your HiveMQ Control Center provides a clear overview of your previous backups as well as a convenient way to create and restore from backups:
Every backup you create is shown in the Stored Backups overview table. This table provides information about the start date of the backup and the size of the file after compression. The table also provides the download and delete actions.
To download a backup file from HiveMQ, select the
download action of the desired backup. A dialog opens
where you can see the preparation progress. When backup preparation is complete, select
save to download the backup to your filesystem.
Create New Backup
To create a new backup file from all persistent HiveMQ data in a HiveMQ cluster, select
After a confirmation, HiveMQ creates a backup file. Completed backups are appear in the Stored Backups overview.
|Before you start, make sure that there is at least 1 GB disk space available on the node where you want to create the backup.|
To cancel the backup action, select
You can leave the backup page during the creation of the backup. When the backup is finished, a notification displays on every page of the control center.
|You can only create one backup at a time.|
The backup contains the following data:
Client session data (persistent sessions only)
Shared subscription queues
Restore From Backup
To restore a backup to a fresh HiveMQ cluster, you can upload a backup file. Click into the empty text field
on the right side. Choose a backup file on your filesystem. Click the
Upload button and confirm the restoration action in the dialog that opens.
A fresh HiveMQ cluster is defined as follows:
No client sessions.
No retained messages.
No queued messages.
If any of the data listed above is present, HiveMQ denies a restoration.
You can leave the backup page while HiveMQ completes the restore from backup process. When the restoration is finished, a notification displays on every page of your control center.
|Once the import process begins, the backup import cannot be stopped.|