emqx/emqx-enterprise

EMQX Enterprise Overview

Official Docker image for EMQX. Website | Docs | https://github.com/emqx/emqx | https://slack-invite.emqx.io/ | ***

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:

• News: EMQX Adopts BSL
• Blog: Why We Adopted BSL
• License FAQ

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

• Connect 100M+ of concurrent MQTT clients with a single cluster.
• Process millions of messages per second with sub-millisecond latency.
• Masterless clustering for high availability and fault tolerance.
• Seamless global communication with EMQX Cluster Linking.

Powerful Rule Engine & Data Integration

• SQL-based Rule Engine to process, transform, enrich, and filter in-flight data.
• Seamless data bridging and integration with 50+ cloud services and enterprise systems, including:
  • Message Queues: Kafka, RabbitMQ, Pulsar, RocketMQ, etc.
  • Databases: PostgreSQL, MySQL, MongoDB, Redis, ClickHouse, InfluxDB, etc.
  • Cloud Services: AWS Kinesis, GCP Pub/Sub, Azure Event, Confluent Cloud, and more.
• Webhook support for easy integration with custom services.

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

• Schema Registry: Define, store, and manage data schemas to ensure consistency.
• Schema Validation: Validate incoming data against registered schemas to maintain data integrity.
• Message Transformation: Convert data between different formats and structures to facilitate seamless integration.

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

• Secure connections with TLS/SSL and WSS.
• Flexible authentication mechanisms: username/password, JWT, PSK, X.509 certificates, etc.
• Granular access control with ACLs.
• Integration with external authentication databases (LDAP, SQL, Redis).

Advanced Observability & Management:

• Comprehensive monitoring with Prometheus, https://grafana.com/grafana/dashboards/***-emqx/, Datadog, and OpenTelemetry.
• Detailed logging and tracing capabilities.
• User-friendly Dashboard for cluster overview and management.
• Rich HTTP API for automation and third-party integration.

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:

bash
docker run -d --name emqx \
  -p 1883:1883 -p 8083:8083 -p 8084:8084 \
  -p 8883:8883 -p 18083:18083 \
  emqx/emqx-enterprise: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:

bash
# 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-enterprise:latest

Please read more about EMQX configuration in the official documentation.

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:

yaml
services:
  emqx1:
    image: emqx/emqx-enterprise:latest
    ports:
      - "18083:18083"
    environment:
      - "EMQX_NODE__NAME=emqx@node1.emqx.com"
      - "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
      - "EMQX_CLUSTER__STATIC__SEEDS=[emqx@node1.emqx.com, emqx@node2.emqx.com]"
      - "EMQX_LICENSE__KEY=<your license key>"
    networks:
      emqx-bridge:
        aliases:
          - node1.emqx.com

  emqx2:
    image: emqx/emqx-enterprise:latest
    environment:
      - "EMQX_NODE__NAME=emqx@node2.emqx.com"
      - "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
      - "EMQX_CLUSTER__STATIC__SEEDS=[emqx@node1.emqx.com, emqx@node2.emqx.com]"
      - "EMQX_LICENSE__KEY=<your license key>"
    networks:
      emqx-bridge:
        aliases:
          - node2.emqx.com

networks:
  emqx-bridge:
    driver: bridge

• Start the docker compose cluster:

bash
docker compose -p my_emqx up -d

• View cluster:

bash
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
Cluster status: #[running_nodes => ['emqx@node1.emqx.com','emqx@node2.emqx.com'],
                  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

EMQX employs the data/mnesia/<node_name> directory for data storage. It's crucial to choose a stable identifier, such as a hostname or Fully Qualified Domain Name (FQDN), to serve as the node name. This practice avoids data loss caused by node name changes.

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

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

services:
  emqx:
    image: emqx/emqx-enterprise:latest
    hostname: node.emqx.com
    restart: always
    environment:
      EMQX_NODE__NAME: "emqx@node.emqx.com"
    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).

bash
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-enterprise:latest

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

Thanks

• https://github.com/emqx/emqx-docker/issues/2
• https://github.com/emqx/emqx-docker/pull/91
• https://github.com/emqx/emqx/issues/3427