Skip to content

Latest commit

 

History

History
99 lines (60 loc) · 3.8 KB

README.md

File metadata and controls

99 lines (60 loc) · 3.8 KB

EMQ X Broker

GitHub Release Build Status Coverage Status Docker Pulls Slack Invite Twitter

The best IoT MQTT open source team looks forward to your joining

English | 简体中文 | 日本語

EMQ X 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, EMQ X 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 EMQ X broker can scaled to 10+ million concurrent MQTT connections on one cluster.

Installation

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

Installing via EMQ X Docker Image

docker run -d --name emqx -p 1883:1883 -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 EMQ X Download page.

Build From Source

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

git clone -b v4.0.0 https://github.com/emqx/emqx-rel.git

cd emqx-rel && make

cd _build/emqx/rel/emqx && ./bin/emqx console

Quick Start

# 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

FAQ

Visiting EMQ X FAQ to get help of common problems.

Roadmap

The EMQ X Roadmap uses Github milestones to track the progress of the project.

Community, discussion, contribution, and support

You can reach the EMQ community and developers via the following channels:

Please submit any bugs, issues, and feature requests to emqx/emqx.

MQTT Specifications

You can read the mqtt protocol via the following links:

MQTT Version 3.1.1

MQTT Version 5.0

MQTT SN

License

Apache License 2.0, see LICENSE.