EMQX Plugin Template

This is a rebar3 template to ease creation of EMQX Plugins in Erlang.

This plugin template is for EMQX >= 5.0.

We introduced a AVRO config schema mechanism for plugins in EMQX 5.7.0 to facilitate configuration updates for plugins at runtime via RESTAPI. Please see priv/config_schmea.avsc.example and priv/config_i18n.json.example as examples.

For EMQX >= 4.3, please see branch emqx-v4

For older EMQX versions, plugin development is no longer maintained.

A plugin template for Elixir (experimental) can be found at https://github.com/emqx/emqx-elixir-plugin.

Prerequisites

• A working build environment (eg build_essential) including make
• ASDF tool-chains recommended to manage EMQX released Erlang/OTP.
• MUST use OTP 25 For docker image deployment. See also ./.tool-versions and EMQX Release v5.5.0.
• rebar3

Usage

$ mkdir -p ~/.config/rebar3/templates
$ pushd ~/.config/rebar3/templates
$ git clone https://github.com/emqx/emqx-plugin-template.git
$ popd
$ rebar3 new emqx-plugin my_emqx_plugin
$ make -C my_emqx_plugin rel

Note

In order to use the AVRO config schema feature, please make sure the plugin template tag version >= 5.7.0 Rename files in the ./priv directory to ensure that EMQX can load them correctly after the plugin is installed. See also EMQX Documents - Plugins for more detail.

Note

If the REBAR_CACHE_DIR environment variable has been set, the directory for templates should be $REBAR_CACHE_DIR/.config/rebar3/templates. Here is a relevant issue.

This will create a tarball containing your custom plugin. You can use EMQX's Dashboard or it's command line tools to deploy it into your running EMQX cluster.

See EMQX documentation for details on how to deploy custom plugins.