Go to file
William Yang f49be0e3a3 chore: disable auto assignee for github issues.
save tigercl
2021-07-01 11:16:46 +02:00
.ci chore(connector): update connector ssl schema 2021-06-29 18:22:44 +08:00
.github chore: disable auto assignee for github issues. 2021-07-01 11:16:46 +02:00
apps feat(bridge-mqtt): Update the configuration file to hocon (#5142) 2021-07-01 10:51:59 +08:00
bin chore(bin/emqx): print env override when generating config 2021-06-28 11:43:31 +08:00
data feat(bridge-mqtt): Update the configuration file to hocon (#5142) 2021-07-01 10:51:59 +08:00
deploy chore: delete internal acl code 2021-06-28 11:44:01 +08:00
lib-extra chore(extra-plugin): statement plugin tag 2021-04-09 09:21:42 +08:00
scripts chore(plugins): rm emqx-pks-file plugin 2021-06-28 15:57:19 +08:00
.editorconfig add editorconfig for emqx 2018-09-03 14:03:20 +08:00
.gitattributes chore(gitattributes): fix file classification. 2021-03-18 21:15:33 +01:00
.gitignore feat(rlog): Add RLOG to EMQX 2021-06-14 15:05:36 +02:00
.tool-versions build: pin otp 24 for dev 2021-05-24 15:15:37 +02:00
CONTRIBUTING.md docs: format contributing 2021-02-22 15:32:14 +08:00
LICENSE Licensed under the Apache, Version 2.0 2016-02-05 14:26:17 +08:00
Makefile build: upgrade to rebar3 version 3.14.3-emqx-8 2021-06-04 16:58:01 +02:00
README-CN.md build: delete needless auth plugins 2021-06-28 11:44:01 +08:00
README-JP.md build: delete needless auth plugins 2021-06-28 11:44:01 +08:00
README-RU.md build: delete needless auth plugins 2021-06-28 11:44:01 +08:00
README.md build: delete needless auth plugins 2021-06-28 11:44:01 +08:00
Windows.md feat(windows): Support environment variable override for windows 2021-03-16 11:26:17 +01:00
build build: do not allow user override PKG_VSN 2021-06-28 11:43:48 +08:00
docker.mk build: pin otp 23.2.7.2-emqx-2 2021-05-06 21:05:39 +02:00
elvis.config chore: move lib-ce to apps 2021-06-15 17:31:54 +08:00
pkg-vsn.sh chore: move root level src, test, include, priv and etc to apps/emqx 2021-06-07 09:09:28 +02:00
rebar.config build(rlog): Add xref check for forbidden mnesia APIs 2021-06-29 00:27:53 +02:00
rebar.config.erl feat(bridge-mqtt): Update the configuration file to hocon (#5142) 2021-07-01 10:51:59 +08:00

README.md

EMQ X Broker

GitHub Release Build Status Coverage Status Docker Pulls Slack Invite Twitter YouTube

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.

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

Installing via EMQ X 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 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/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

Test

To test everything in one go

make eunit ct

To run subset of the common tests

Examples

make apps/emqx_bridge_mqtt-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 EMQ X FAQ to get help of common problems.

Questions

GitHub Discussions is where you can ask questions, and share ideas.

Proposals

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

Plugin development

To develop your own plugins, see lib-extra/README.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

Apache License 2.0, see LICENSE.