Go to file
Zaiming Shi a7b7bb19f7 refactor(Makefile): Pin rebar3 binary 2020-11-02 20:54:35 +01:00
.github Merge pull request #3546 from emqx/develop 2020-06-21 14:14:52 +08:00
apps/emqx_management refactor(emqx_management): Move it under the umbrella 2020-10-29 22:51:13 +01:00
etc fix(config): enable force_shutdown_policy by default 2020-09-30 11:36:30 +08:00
include feature(alarm): new design for alarm 2020-07-31 18:07:20 +08:00
priv fix(config): enable force_shutdown_policy by default 2020-09-30 11:36:30 +08:00
scripts Move test/run_emqx.escript -> scripts/run_emqx.escript 2019-08-03 14:08:20 +08:00
src fix(json): fix decoding/encoding empty object error 2020-10-24 15:49:15 +08:00
test fix(json): fix decoding/encoding empty object error 2020-10-24 15:49:15 +08:00
.editorconfig add editorconfig for emqx 2018-09-03 14:03:20 +08:00
.gitignore Optimize develop workflow and support make run and code hot swapping (#2644) 2019-06-21 20:52:27 +08:00
LICENSE Licensed under the Apache, Version 2.0 2016-02-05 14:26:17 +08:00
Makefile refactor(Makefile): Pin rebar3 binary 2020-11-02 20:54:35 +01:00
README-CN.md Update README 2020-05-26 16:09:28 +08:00
README.md Update README 2020-05-26 16:09:28 +08:00
rebar.config refactor(emqx_management): Move it under the umbrella 2020-10-29 22:51:13 +01:00
rebar.config.script Change travis-ci to github action 2020-03-21 13:40:16 +08:00
rebar3 refactor(Makefile): Pin rebar3 binary 2020-11-02 20:54:35 +01:00
vars Restore app.confg rule in makefile for debug and test 2019-05-08 21:18:24 +08:00

README.md

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.