emqx/nanomq

NanoMQ

Quick Reference

Official Website:

[***]

Where to get help and fire issues:

https://github.com/emqx/nanomq/issues or [] or []

Supported architectures

POSIX compatible Architecture

What is NanoMQ

Nano MQTT Broker (NanoMQ) is a lightweight and blazing-fast MQTT Broker for the IoT Edge platform. NanoMQ unifies data in motions and data in use between Edge and Cloud in an efficient manner.

Ihe cost effectiveness, performant, high compatibility and interoperability makes NanoMQ your best option of edge messaging broker and databus.

Features

• Fully MQTT 5.0 Compliant

  Fully support MQTT 5.0/3.1.1, Compatible with all standard open-source MQTT SDKs.

• MQTT Bridges

  Bridging message from edge to multiple clouds. In-line connections to Global cloud services.

• Message Persistence

  Preserve your business-critical data with built-in data persistence, and resume uploading automatically when the connection is restored.

• Rule Engine

  Unlock the flexibility of data with a SQL-based rule engine. Integrates with eKuiper to bring stream processing to the edge.

• Integrability

  Reduce the cost of integrating edge computing applications with event-driven WebHooks. Easy to maintain with EdgeOps friendly HTTP APIs.

• All-round

  Support multiple protocols such as ZeroMQ/nanomsg/NNG/WebSocket. Enabling flexible and diverse routing topology on edge with. Secure your IoT connections with TLS/SSL.

How to use this image

bash
docker pull emqx/nanomq:latest

Run specific version of NanoMQ:

bash
docker run -d -p 1883:1883 -p 8883:8883 --name nanomq emqx/nanomq:latest

There are 3 kinds of NanoMQ docker image:

Default: Take alpine as base image, minimum size but only has basic MQTT broker function.

bash
docker pull emqx/nanomq:0.14.1

Slim: Take Ubuntu as base image, moderate size with necessary features like TLS/SSL, SQLite and Rule Engine.

bash
docker pull emqx/nanomq:0.14.1-slim

Full: A comprehensive docker image with all features on board, such as QUIC bridging, ZeroMQ gateway and Bench toolkit.

bash
docker pull emqx/nanomq:0.14.1-full

NanoMQ configuration file

Docker version: Specify config file path from host:

bash
docker run -d -p 1883:1883 -v {YOU LOCAL PATH}: /etc \
          --name nanomq  emqx/nanomq:0.14.1

Recommend to use Environment variables to config NanoMQ

NanoMQ Environment Variables

• Specify a broker url. On host system:

  bash
  export NANOMQ_BROKER_URL="nmq-tcp://0.0.0.0:1883"
  export NANOMQ_TLS_ENABLE=true
  export NANOMQ_TLS_URL="tls+nmq-tcp://0.0.0.0:8883"
  

  Creating docker container:

  bash
  docker run -d -p 1883:1883 -p 8883:8883 \
             -e NANOMQ_BROKER_URL="nmq-tcp://0.0.0.0:1883" \
             -e NANOMQ_TLS_ENABLE=true \
             -e NANOMQ_TLS_URL="tls+nmq-tcp://0.0.0.0:8883" \
             --name nanomq emqx/nanomq:0.14.1-full
  

• Specify a nanomq config file path. On host system:

  bash
  export NANOMQ_CONF_PATH="/usr/local/etc/nanomq.conf"
  

  Creating docker container:

  bash
  docker run -d -p 1883:1883 -e NANOMQ_CONF_PATH="/usr/local/etc/nanomq.conf" \
              [-v {LOCAL PATH}:{CONTAINER PATH}] \
              --name nanomq emqx/nanomq:0.14.0-slim
  

Performance Tunning

In order to achieve the best performance on your platform, recommend to change following settings: