HiveMQ Community Edition

HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5.

It is the foundation of the HiveMQ Enterprise Connectivity and Messaging Platform and implements all MQTT features. This project is the technical core of many of the largest MQTT deployments and is now available as Open Source Software under the Apache 2 license.

• Web Site: https://www.hivemq.com/

• Documentation:https://github.com/hivemq/hivemq-community-edition/wiki

• Community Forum: https://community.hivemq.com/

• Contribution Guidelines: Contributing.adoc

• License: The source files in this repository are made available under the Apache License Version 2.0.

Features

• All MQTT 3.1, 3.1.1 and MQTT 5.0 features

• MQTT over TCP, TLS, WebSocket and Secure WebSocket transport

• Java Extension SDK for:

  • Authentication

  • Authorization

  • Client Initializers

  • MQTT Packet Interceptors

  • Interacting with Publishes, Retained Messages, Clients and Subscriptions

• Running on Windows, Linux and MacOS (Linux is recommended)

HiveMQ CE is compatible with all MQTT 3 and MQTT 5 clients, including Eclipse Paho and HiveMQ MQTT Client.

Documentation

The documentation for the HiveMQ CE can be found here.

• MQTT Resources

  • MQTT Essentials

  • MQTT 5 Essentials

HiveMQ Community Forum

The ideal place for questions or discussions about the HiveMQ Community Edition is our brand new HiveMQ Community Forum.

How to use

Quick start

• Download the latest HiveMQ CE binary package.

• Unzip the package

• Run the run.sh (Linux/OSX) or run.bat (Windows) in the bin folder of the package.

cd hivemq-ce-<version>
./bin/run.sh

You can now connect MQTT clients to <ip address>:1883.

Caution

If you want to connect devices on external networks to HiveMQ CE, please make sure your server is reachable from those networks and the required ports (default: 1883) are accessible through your firewall.

Nightly Builds

Just in time builds for current branches on this repository and for specific commits are available here.

Run with Docker

All releases as well as the current state of the master are available in the hivemq/hivemq-ce repository on DockerHub. To execute this image, simply run the following command:

docker run --name hivemq-ce -d -p 1883:1883 hivemq/hivemq-ce

Building from source

Prerequisites

At least Java version 11 is required to build and run HiveMQ CE.

If you are in doubt, you can check the installed Java version by entering java -version on your command line.

Building the binary package

Check out the git repository and build the binary package.

git clone https://github.com/hivemq/hivemq-community-edition.git

cd hivemq-community-edition

./gradlew clean packaging

The package hivemq-ce-<version>.zip is created in the sub-folder build/zip/.

Building the Docker image

Check out the git repository and build the Docker image.

git clone https://github.com/hivemq/hivemq-community-edition.git

cd hivemq-community-edition

docker/build.sh

docker run hivemq/hivemq-ce

The Docker image hivemq/hivemq-ce is created locally.

You can tag the image or use the TARGET_IMAGE environment variable to manipulate the image name.

To change the default log level you can set the environment variable HIVEMQ_LOG_LEVEL when running the container.

Start

Unzip the created binary package

cd hivemq-ce-<version>

./bin/run.sh

For further development instructions see the contribution guidelines.

Contributing

If you want to contribute to HiveMQ CE, see the contribution guidelines.

License

HiveMQ Community Edition is licensed under the APACHE LICENSE, VERSION 2.0. A copy of the license can be found here.