4.0.x to 4.1.x Migration Guide

This is a minor HiveMQ upgrade. HiveMQ 4.1 is a drop in replacement for HiveMQ 4.0.x

No manual steps are required for upgrading from HiveMQ 4.0 to HiveMQ 4.1.

Cluster Upgrade

This HiveMQ version supports rolling upgrade, and it is possible to run HiveMQ version 4.0 and version 4.1 simultaneously in the same cluster. By default, the HiveMQ cluster enables all new cluster features once all nodes are upgraded to the new version.
No manual intervention is required.

To ensure a seamless and successful rolling upgrade process, see HiveMQ Rolling Upgrades.

For more information, see HiveMQ Clusters.

Upgrade a Single-node HiveMQ Instance

  • Create a backup of the entire HiveMQ installation folder

  • Install HiveMQ 4.1 as described in the HiveMQ Installation Guide

  • Migrate the configuration file contents of your old HiveMQ installation

  • To migrate the persistent data, copy all contents in the data folder from your backup to the new HiveMQ 4.1 data folder. On first start HiveMQ 4.1 will migrate the persistent data from your previous installation into its new persistent storage.

HiveMQ is specifically designed to deliver the highly-available ultra-scalable MQTT clusters that professional MQTT deployments require. To fully benefit from the advantages the HiveMQ Enterprise and Professional editions offer, we recommend running HiveMQ in a cluster environment. For more information, see https://www.hivemq.com/docs/hivemq/latest/user-guide/cluster.[HiveMQ Cluster].

Configuration File Changes

HiveMQ 4.1 introduces an additional option in the configuration file. The Listener configuration now allows you to set a specific <name>. If you choose not to set a specific name, HiveMQ will assign a default name to the listener, so you can upgrade from HiveMQ 4.0.x to HiveMQ 4.1 without making changes to your config file.

Persistent Data Migration

HiveMQ 4.1 automatically migrates all data in your data folder from previous versions to updated file storage formats.

To allow HiveMQ to migrate the persistent data from previous versions you have to copy the contents of your data folder from the previous installation to the data folder of the new installation.

Linux example
cp -r /opt/hivemq-4.0.2/data/* /opt/hivemq-4.1.0/data/

On the first start up HiveMQ 4.1 automatically migrates the persistent data from your previous installation into its new persistent storage.

Enterprise Extensions

HiveMQ 4.1 introduces the use of Enterprise Extensions. NOTE: Before you activate an enterprise extension, make sure all of your cluster nodes have been upgraded to HiveMQ 4.1.x