S3 Cluster Discovery Plugin

Version: 1.1.0
License: Apache v2

The HiveMQ S3 Cluster Discovery Plugin allows your HiveMQ cluster nodes to discover each other dynamically by exchanging their information via S3 from Amazon Web Services.

How it works

On Startup each broker puts his own information into a file in S3. Then each broker regularly checks the configured S3 bucket for files from other brokers, each containing the information on how to connect to them. When the plugin finds files from other brokers it will try to form a cluster with them.

Additionally every broker updates its own file on a regular basis to prevent the file from expiring.


1. Copy the jar file plugins/s3-cluster-discovery-plugin-[version].jar to your [HIVEMQ_HOME]/plugins folder
2. Copy the conf/s3discovery.properties file to your [HIVEMQ_HOME]/conf folder
3. Modify the s3discovery.properties file for your needs
4. Done


For detailed information on how to configure the S3 plugin see the README file included in the download or visit the GitHub page.

Example Usage

1. Start more than one HiveMQ with clustering enabled
2. The HiveMQ nodes will form a cluster.