EMQX

English | 简体中文 | 日本語 | русский

EMQX broker is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and Mobile applications that can handle tens of millions of concurrent clients.

Starting from 3.0 release, EMQX broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the EMQX broker can scale to 10+ million concurrent MQTT connections on one cluster.

• For full list of new features, please read EMQX Release Notes.
• For more information, please visit EMQX homepage.

Installation

The EMQX broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means EMQX can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.

See more details for building and running EMQX on Windows in Windows.md

Installing via EMQX Docker Image

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

Installing via Binary Package

Get the binary package of the corresponding OS from EMQX Download page.

• Single Node Install
• Multi Node Install

Running on Kubernetes by EMQX Operator

Please jump to getting-started for more details.

Build From Source

The EMQX broker requires Erlang/OTP R21+ to build since 3.0 release.

For 4.3 and later versions.

git clone https://github.com/emqx/emqx.git
cd emqx
make
_build/emqx/rel/emqx/bin/emqx console

For earlier versions, release has to be built from another repo.

git clone https://github.com/emqx/emqx-rel.git
cd emqx-rel
make
_build/emqx/rel/emqx/bin/emqx console

Quick Start

If emqx is built from source, cd _build/emqx/rel/emqx. Or change to the installation root directory if emqx is installed from a release package.

# Start emqx
./bin/emqx start

# Check Status
./bin/emqx_ctl status

# Stop emqx
./bin/emqx stop

To view the dashboard after running, use your browser to open: http://localhost:18083 (default user/password = admin/public)

Test

To test everything in one go

make eunit ct

To run subset of the common tests

Examples

make apps/emqx_retainer-ct

Dialyzer

To Analyze all the apps

make dialyzer

To Analyse specific apps, (list of comma separated apps)

DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer

Community

FAQ

Visiting EMQX FAQ to get help of common problems.

Questions

• GitHub Discussions is where you can ask questions, and share ideas.
• Slack is where you can ask and discuss questions or contact our teams directly.
• Discord is where you can get help and upcoming events related to IoT technologies.

Proposals

For more organised improvement proposals, you can send pull requests to EIP.

Plugin development

See PLUGIN.md

MQTT Specifications

You can read the mqtt protocol via the following links:

MQTT Version 3.1.1

MQTT Version 5.0

MQTT SN

License

See LICENSE.