Plugins

One of the outstanding features of HiveMQ is its ability to extend HiveMQ with virtually every functionality you can imagine. HiveMQs plugin system is highly event and callback oriented, which allows a deep integration of HiveMQ into your already existing application- and IT infrastructure.

A list of officially supported off-the-shelf plugins can be found here.

There are also Enterprise Integrations available if you need a more complex integration of HiveMQ. Learn more about that Enterprise Integrations on the website.

Developing custom plugins
To get started with writing plugins, you should take a look at our official Plugin Developer Guide.

Installing Plugins

The installation of plugins is very simple: Download the zip archive of your desired plugin and drop the jar file into the HiveMQ plugins folder. Plugins which expect configuration files also come with one or more config files. Drop these files into the conf folder

Instructions for installing plugins

  1. Download a plugin from the HiveMQ plugin store

  2. Unzip the contents of your download.

  3. Copy the jar file to $HIVEMQ_DIRECTORY/plugins.

  4. Copy the configuration file to the $HIVEMQ_DIRECTORY/conf folder

  5. Modify the properties of the plugin according to the plugins installation guide or README file.

Validating if the plugin works

HiveMQ will log every plugin it uses when starting up. A typical log entry with a plugin enabled looks like the following listing:

Startup log with an enabled plugin
2018-12-12 17:34:23,936 INFO  - Loaded Plugin HiveMQ Example Plugin - v1.0.0

Configuring Plugins

Every plugin comes with its own configuration file (if it needs any). Please read the installation guide or the README file which comes with every officially supported plugin.

Developing Plugins

HiveMQ can can be deeply integrated in your existing application- and IT infrastructure. For complex or unique scenarios there is often no one-size-fits-all plugin. HiveMQ gives the ability to write your own plugins for your very own integration scenarios.

The public SDK is available for free and open source on Github. For more information about developing HiveMQ plugins, please refer to our extensive Plugin Documentation^.

Professional plugin development
For individually developed and fully supported Enterprise Integration plugins which are guaranteed to scale with the HiveMQ MQTT broker, don’t hesitate to contact us. Plugin development trainings and workshops are also available. Please contact sales@hivemq.com for more details.