Go to file
Zaiming Shi 86895ddc24 chore(sync-apps): sync emqx_auth_mnesia e4.2.3 2021-01-18 20:05:08 +01:00
.github Merge pull request #3546 from emqx/develop 2020-06-21 14:14:52 +08:00
apps chore(sync-apps): sync emqx_auth_mnesia e4.2.3 2021-01-18 20:05:08 +01:00
bin fix(rel): rel_vsn renamed to release_version 2020-12-08 22:28:46 +01:00
data fix(rel): rel_vsn renamed to release_version 2020-12-08 22:28:46 +01:00
etc Merge branch 'dev/v4.3.0' into e422_to_v430 2020-12-09 11:28:36 +08:00
include feature(alarm): new design for alarm 2020-07-31 18:07:20 +08:00
mods fix(build): remove trailing line-break in version 2020-12-01 21:23:39 +01:00
priv feature(tcp): alarm when tcp connection congested 2020-12-07 14:35:38 +08:00
src Merge branch 'dev/v4.3.0' into e422_to_v430 2020-12-09 11:28:36 +08:00
test Merge branch 'dev/v4.3.0' into e422_to_v430 2020-12-09 11:28:36 +08:00
vars feature(project): change to rebar3 umbrella project 2020-10-31 11:07:25 +08:00
.editorconfig add editorconfig for emqx 2018-09-03 14:03:20 +08:00
.gitignore Merge branch 'dev/v4.3.0' into e422_to_v430 2020-12-10 20:42:15 +08:00
LICENSE Licensed under the Apache, Version 2.0 2016-02-05 14:26:17 +08:00
Makefile fix(mgmt): remove schema_registry calls from opensource code 2020-12-10 16:30:48 +08:00
README-CN.md Update README 2020-05-26 16:09:28 +08:00
README.md docs(README): update build from source methods 2020-12-09 23:25:39 +01:00
docker.mk feature(project): change to rebar3 umbrella project 2020-10-31 11:07:25 +08:00
ensure-rebar3.sh refactor(script): Use sh not bash 2020-12-07 21:21:17 +01:00
packages.mk refactor(build): Delete _checkouts 2020-12-05 19:48:44 +01:00
rebar.config fix(ekka): update ekka version to fix oom (#3871) 2020-12-10 15:04:19 +08:00
rebar.config.erl chore(build): remove emqtt deps from test profile 2020-12-10 15:02:19 +08:00
sync-apps.sh chore(sync-apps): sync emqx_auth_mnesia e4.2.3 2021-01-18 20:05:08 +01: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.

For 4.3 and later versions.

git clone https://github.com/emqx/emqx.git
cd emqx
make
_build/emqx/rel/emqx/bin 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 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.