README.md

vmq_lfe_plugin

An LFE application

Table of Contents

• About
• Build
• Enable the Plugin
• Tests
• License

About ↟

vmq_lfe_plugin is a Plugin template you can use to build a full VerneMQ Plugin in LFE (Lisp Flavoured Erlang).

Build ↟

To build a binary version of the plugin, run

$ rebar3 lfe compile

Enable the Plugin ↟

You can dynamically enable your Plugin with VerneMQ's vmq-admin command line tool, or in the vernemq.conf file.

with vmq-admin

$ vmq-admin plugin enable --name=vmq_lfe_plugin --path=/your-vernemq-plugins/vmq_lfe_plugin

with vernemq.conf

Add below lines to the vernemq.conf. This will enable the plugin after every VerneMQ reboot. Also note that the path needs to go down to the _build/default/lib/vmq_lfe_plugin folder. (The _build directory is created by calling the rebar3 compile command as described above)

plugins.vmq_lfe_plugin = on
plugins.vmq_lfe_plugin.path = path/to/my-verne-plugins/vmq_lfe_plugin

Tests ↟

$ rebar3 lfe test

License ↟

Apache License, Version 2.0

Copyright © 2021, Andre Fatton.