vernemq / vernemq_dev

VerneMQ plugin development dependencies

VerneMQ: A Distributed MQTT Broker

Old Docker Repo	New Docker Repo

New: VerneMQ can now use Github Discussions! To join the discussion on features and roadmap, and be part of the VerneMQ Community Team on Github, send us your Github username for an invite! (on Twitter, Slack etc.)

Make sure to visit the new VerneMQ Forum hosted on Erlang Forums. We're happy to discuss any of your questions and ideas around VerneMQ on the Forum too!

---

VerneMQ is known to be deployed and used in: 🇺🇸 🇨🇦 🇧🇷 🇲🇽 🇩🇪 🇫🇷 🇨🇭 🇩🇰 🇳🇱 🇧🇪 🇮🇹 🇪🇸 🇷🇴 🇵🇹 🇷🇺 🇱🇹 🇨🇿 🇸🇰 🇦🇹 🇵🇱 🇳🇴 🇸🇪 🇮🇳 🇯🇵 🇮🇩 🇻🇳 🇰🇷 🇿🇦 🇰🇪 🇷🇸 🇭🇷 🇬🇷 🇬🇧 🇺🇦 🇦🇺 🇳🇿 🇨🇳 🇪🇬 🇫🇮 🇭🇺 🇮🇱 🇸🇬 🇱🇧 🇵🇭 🇵🇰 🇲🇾 🇹🇷 🇹🇼 🇮🇷 ☁️

---

VerneMQ is a high-performance, distributed MQTT message broker. It scales horizontally and vertically on commodity hardware to support a high number of concurrent publishers and consumers while maintaining low latency and fault tolerance. VerneMQ is the reliable message hub for your IoT platform or smart products.

VerneMQ is an Apache2 licensed distributed MQTT broker, developed in Erlang.

MQTT used to stand for MQ Telemetry Transport, but it no longer is an acronym. It is an extremely simple and lightweight publish/subscribe messaging protocol, that was invented at IBM and Arcom (now Eurotech) to connect restricted devices in low bandwidth, high-latency or unreliable networks.

VerneMQ implements the MQTT 3.1, 3.1.1 and 5.0 specifications. Currently the following features are implemented and delivered as part of VerneMQ:

• QoS 0, QoS 1, QoS 2
• Basic Authentication and Authorization
• Bridge Support
• $SYS Tree for monitoring and reporting
• TLS (SSL) Encryption
• Websockets Support
• Cluster Support
• Logging (Console, Files, Syslog)
• Reporting to Graphite
• Extensible Plugin architecture
• Multiple Sessions per ClientId
• Session Balancing
• Shared subscriptions
• Message load regulation
• Message load shedding (for system protection)
• Offline Message Storage (based on LevelDB)
• Queue can handle messages FIFO or LIFO style.
• MongoDB auth & integration
• Redis auth & integration
• MySQL auth & integration
• PostgreSQL auth & integration
• CockroachDB auth & integration
• Memcached integration
• HTTP Webhooks
• PROXY Protocol v2
• Administration HTTP API
• Real-time MQTT session tracing
• Full multitenancy
• Cluster status web page

The following features are also applies to MQTT 5.0 clients:

• Enhanced authentication schemes (AUTH)
• Message expiration
• Last Will and Testament delay
• Shared subscriptions
• Request/response flow
• Topic aliases
• Flow control
• Subscription flags (Retain as Published, No Local, Retain Handling)
• Subscriber identifiers
• All property types are supported: user properties, reason strings, content types etc.

Commercial Support. Binary Packages. Documentation

Below you'll find a basic introduction to building and starting VerneMQ. For more information about the binary package installation, configuration, and administration of VerneMQ, please visit our documentation at VerneMQ Documentation or checkout the product page VerneMQ if you require more information on the available commercial support options.

Community Release Schedule

Next major release: not yet scheduled.

Minor releases: At the end of March, July and November (every 4th month).

Bugfix releases: Usually a bugfix release is released between minor releases or if there's an urgent bugfix pending.

Custom release cycles and releases are available for commercial users.

Quick Start

This section assumes that you have a copy of the VerneMQ source tree. To get started, you need to first build VerneMQ.

Building VerneMQ

Note: VerneMQ requires Erlang/OTP 24-25 and libsnappy-dev installed in your system. You'll also need a C compiler for Eleveldb. (on Debian, you install build-essential, as an example).

Assuming you have a working Erlang installation, building VerneMQ should be as simple as:

$ cd $VERNEMQ
$ make rel

Starting VerneMQ

Once you've successfully built VerneMQ, you can start the server with the following commands:

$ cd $VERNEMQ/_build/default/rel/vernemq
$ bin/vernemq start

If VerneMQ is running it is possible to check the status on http://localhost:8888/status and it should look something like:

Note that the $VERNEMQ/_build/default/rel/vernemq directory is a complete, self-contained instance of VerneMQ and Erlang. It is strongly suggested that you move this directory outside the source tree if you plan to run a production instance.

Important links

• VerneMQ Documentation
• 
• 

Thank you to all our contributors!

vernemq_dev's Issues

Can't authorize a publish with postgres

I'm trying to implement auth postgres but I can't authorized publishes.

In a desperate attempt I did this:

-- import default hooks and cache logic
require "auth/auth_commons"
-- import shared database query logic
require "auth/postgres_cockroach_commons"

function auth_on_register(reg)
   return auth_on_register_common(postgres, reg)
end

function auth_on_pub(pub)
    return true
end

pool = "auth_postgres"
config = {
    pool_id = pool,
}

postgres.ensure_pool(config)
hooks = {
    auth_on_register     = auth_on_register,
    auth_on_publish      = auth_on_pub,
    auth_on_subscribe    = auth_on_pub,
    on_unsubscribe       = auth_on_pub,
    on_client_gone       = auth_on_pub,
    on_client_offline    = auth_on_pub,
    on_session_expired   = auth_on_pub,

    auth_on_register_m5  = auth_on_pub,
    auth_on_publish_m5   = auth_on_pub,
    auth_on_subscribe_m5 = auth_on_pub,
}

but still I get

2021-04-14 11:41:59.467 [error] <0.2866.0>@vmq_mqtt_fsm:auth_on_publish:739 can't auth publish [<<"user2">>,{[],<<"b8:27:eb:09:b1:d3">>},1,[<<"devices">>,<<"B184">>,<<"616">>,<<"data">>],<<219,221,204,207,120,1,1,66,20,40,246>>,false] due to not_authorized

what am I missing? auth_on_register works but the others don't.