emqx/emqx

By emqx

Updated 9 days ago

The most scalable and reliable MQTT broker for AI, IoT, IIoT and connected vehicles

Image
Internet of things
219

10M+

emqx/emqx repository overview

EMQX Overview

Official Docker image for EMQX. Website | Docs | GitHub | Slack | Discord

Supported architectures: amd64, arm64v8

Overview

EMQX is the world's most scalable and reliable MQTT platform, designed for high-performance, reliable, and secure IoT data infrastructure. It supports MQTT 5.0, 3.1.1, and 3.1, as well as other protocols like MQTT-SN, CoAP, LwM2M, and MQTT over QUIC. EMQX enables you to connect millions of IoT devices, process and route messages in real time, and integrate with a wide range of backend data systems. It's ideal for applications in AI, IoT, Industrial IoT (IIoT), connected vehicles, smart cities, and beyond.

Unified Features & New License (v5.9.0+)

Starting from version 5.9.0, EMQX has unified its features and adopted the Business Source License (BSL) 1.1. This means all features, including powerful data integrations, flow designer, advanced observability, and enterprise-grade security, are now available in this single Docker image.

Learn More about License change:

IMPORTANT: License Required for Clustering (v5.9.0+) !

Under BSL 1.1, deploying an EMQX cluster (more than 1 node) requires a license key to be loaded, even for free/development use cases permitted by the BSL. Please see the License FAQ and License Documentation for details on obtaining and applying your license.

Key Features

EMQX delivers a powerful set of capabilities for modern connected systems:

Comprehensive Protocol Support
  • Full MQTT v5.0, v3.1.1, and v3.1 support.
  • MQTT over QUIC: Leverage the benefits of QUIC for faster connection establishment, reduced head-of-line blocking, and seamless connection migration.
  • Support for other IoT protocols like LwM2M, CoAP, MQTT-SN, and more through gateways.
Massive Scalability & High Availability
Powerful Rule Engine & Data Integration
Flow Designer
  • Drag‑and‑drop canvas to orchestrate real‑time data pipelines with zero code, using nodes for rules, integrations, and AI tasks.
Smart Data Hub
AI Processing & Integration:
  • Native AI processing capabilities for IoT data streams.
  • Integration with popular AI services.
  • Support for AI-driven decision making at the edge or in the cloud.
Robust Security
Advanced Observability & Management:
Extensibility
  • Plugin architecture for extending functionality.
  • Hooks for customizing behavior at various points in the message lifecycle.
Unified Experience:
  • With the BSL 1.1 license (from v5.9.0), all features, including those previously exclusive to the enterprise edition, are available to all developers.

Quick Start

Run a single EMQX node:

docker run -d --name emqx \
  -p 1883:1883 -p 8083:8083 -p 8084:8084 \
  -p 8883:8883 -p 18083:18083 \
  emqx/emqx:latest

The EMQX broker runs as Linux user emqx in the docker container.

Configuration

All EMQX Configuration in etc/emqx.conf can be configured via environment variables. By default, the environment variables with EMQX_ prefix are mapped to key-value pairs in configuration files.

Example:

# EMQX_LISTENERS_TCP_DEFAULT_BIND <-> listeners.tcp.default.bind
# EMQX_LISTENERS_SSL_DEFAULT_ACCEPTORS <-> listeners.ssl.default.acceptors
# EMQX_ZONES_DEFAULT_MQTT_MAX_PACKET_SIZE <--> zones.default.mqtt.max_packet_size

# Prefix EMQX_ is removed
# All upper case letters is replaced with lower case letters
# _ is replaced with .

# here we set MQTT TCP port to 1884
docker run -d --name emqx \
    -e EMQX_LISTENERS_TCP_DEFAULT_BIND=1884 \
    -p 18083:18083 \
    -p 1884:1884 \
    emqx/emqx:latest

Please read more about EMQX configuration in the official documentation.

EMQX node name configuration
OptionsDefaultMappedDescription
EMQX_NAMEcontainer namenoneEMQX node short name
EMQX_HOSTcontainer IPnoneEMQX node host, IP or FQDN

These environment variables are used during container startup phase only in docker-entrypoint.sh. If EMQX_NAME and EMQX_HOST are set, and EMQX_NODE_NAME is not set, EMQX_NODE_NAME=$EMQX_NAME@$EMQX_HOST. Otherwise EMQX_NODE_NAME is taken verbatim.

Clustering

Note: Deploying an EMQX cluster (more than 1 node) requires a license key to be loaded.

EMQX supports a variety of clustering methods, see our documentation for details.

Let's create a static node list cluster from docker compose.

  • Create docker-compose.yaml:
services:
  emqx1:
    image: emqx/emqx:latest
    environment:
      - "EMQX_NAME=emqx"
      - "EMQX_HOST=node1.emqx.io"
      - "EMQX_CLUSTER_DISCOVERY_STRATEGY=static"
      - "EMQX_CLUSTER_STATIC_SEEDS=[[email protected], [email protected]]"
      - "EMQX_LICENSE_KEY=<your license key>"
    networks:
      emqx-bridge:
        aliases:
          - node1.emqx.io

  emqx2:
    image: emqx/emqx:latest
    environment:
      - "EMQX_NAME=emqx"
      - "EMQX_HOST=node2.emqx.io"
      - "EMQX_CLUSTER_DISCOVERY_STRATEGY=static"
      - "EMQX_CLUSTER_STATIC_SEEDS=[[email protected], [email protected]]"
      - "EMQX_LICENSE_KEY=<your license key>"
    networks:
      emqx-bridge:
        aliases:
          - node2.emqx.io

networks:
  emqx-bridge:
    driver: bridge
  • Start the docker compose cluster:
docker compose -p my_emqx up -d
  • View cluster:
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
Cluster status: #[running_nodes => ['[email protected]','[email protected]'],
                  stopped_nodes => []}

Persistence

If you want to persist the EMQX docker container, you need to keep the following directories:

  • /opt/emqx/data
  • /opt/emqx/log

Since data in these folders are partially stored under the /opt/emqx/data/mnesia/${node_name}, the user also needs to reuse the same node name to see the previous state. In detail, one needs to specify the two environment variables: EMQX_NAME and EMQX_HOST; EMQX_HOST set as 127.0.0.1 or network alias would be useful.

If you use docker compose, the configuration would look something like this:

volumes:
  vol-emqx-data:
    name: foo-emqx-data
  vol-emqx-log:
    name: foo-emqx-log

services:
  emqx:
    image: emqx/emqx:latest
    restart: always
    environment:
      EMQX_NAME: foo_emqx
      EMQX_HOST: 127.0.0.1
    volumes:
      - vol-emqx-data:/opt/emqx/data
      - vol-emqx-log:/opt/emqx/log

Kernel Tuning

Under Linux host machine, the easiest way is Tuning guide. If you want to tune Linux kernel by docker, you must ensure your docker is latest version (>=1.12).

docker run -d --name emqx -p 18083:18083 -p 1883:1883 \
  --sysctl fs.file-max=2097152 \
  --sysctl fs.nr_open=2097152 \
  --sysctl net.core.somaxconn=32768 \
  --sysctl net.ipv4.tcp_max_syn_backlog=16384 \
  --sysctl net.core.netdev_max_backlog=16384 \
  --sysctl net.ipv4.ip_local_port_range="1000 65535" \
  --sysctl net.core.rmem_default=262144 \
  --sysctl net.core.wmem_default=262144 \
  --sysctl net.core.rmem_max=16777216 \
  --sysctl net.core.wmem_max=16777216 \
  --sysctl net.core.optmem_max=16777216 \
  --sysctl net.ipv4.tcp_rmem="1024 4096 16777216" \
  --sysctl net.ipv4.tcp_wmem="1024 4096 16777216" \
  --sysctl net.ipv4.tcp_max_tw_buckets=1048576 \
  --sysctl net.ipv4.tcp_fin_timeout=15 \
  emqx/emqx:latest

REMEMBER: DO NOT RUN EMQX DOCKER PRIVILEGED OR MOUNT SYSTEM PROC IN CONTAINER TO TUNE LINUX KERNEL, IT IS UNSAFE.

Thanks

Tag summary

Content type

Image

Digest

sha256:145090fb6

Size

147 MB

Last updated

9 days ago

docker pull emqx/emqx:6.3.0-beta.2