Go to file
Thales Macedo Garitezi 015f534774 attempt: use only replica if rlog
there seems to be race conditions related to some tests with sessions
hitting the core and the replicant alternately and rlog.

for intance, if there is some delay in this replication, a new
connection made to the replica with a just-created session in the core
may not have been replicated to the replicant, resulting in a test
failure if it expects the session to be present.

since such replication lags are inherent to the core-replicant
topology, we can try to target only the replicant to avoid seeing this
inconsistent view of the system during the tests.
2021-11-07 21:15:07 -03:00
.ci attempt: use only replica if rlog 2021-11-07 21:15:07 -03:00
.github attempt: use only replica if rlog 2021-11-07 21:15:07 -03:00
apps Merge pull request #6064 from zmstone/style-check-newline-at-eof 2021-11-04 18:01:45 +01:00
bin emqx_conf (#5939) 2021-10-21 18:08:51 +08:00
data feat(conf): merge all conf to emqx.conf 2021-07-02 17:01:16 +08:00
deploy style: ensure newline at EOF for all files 2021-11-04 14:40:14 +01:00
lib-extra chore(extra-plugin): statement plugin tag 2021-04-09 09:21:42 +08:00
scripts ci: fix job syntax 2021-11-04 18:32:03 +01:00
.editorconfig add editorconfig for emqx 2018-09-03 14:03:20 +08:00
.gitattributes chore: fix Windows compilation process 2021-09-27 21:24:10 +08:00
.gitignore chore(editor): ignore editor files 2021-10-15 01:04:47 +08:00
.tool-versions test: add debug print 2021-08-09 22:09:11 +02:00
CONTRIBUTING.md style: ensure newline at EOF for all files 2021-11-04 14:40:14 +01:00
LICENSE Licensed under the Apache, Version 2.0 2016-02-05 14:26:17 +08:00
Makefile Merge pull request #5875 from emqx/extend-persistent-sessions 2021-10-27 09:12:13 +02:00
NOTICE chore: add notice files 2021-07-23 11:47:04 +02:00
README-CN.md fix(README): fix command to run in build instructions 2021-09-20 14:01:21 +03:00
README-JP.md fix(README): update docs for running ct on single app 2021-09-10 11:43:03 +08:00
README-RU.md fix(README): fix command to run in build instructions 2021-09-20 14:01:21 +03:00
README.md chore(readme): Fix typo 2021-09-26 11:40:49 +02:00
Windows.md feat(windows): Support environment variable override for windows 2021-03-16 11:26:17 +01:00
build chore(CI): rename image 2021-10-22 13:40:01 +08:00
elvis.config chore(for editor): Add comments for Emacs major mode. 2021-09-16 15:43:30 +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 fix(config): pin hocon 0.20.6 2021-11-03 11:15:35 +01:00
rebar.config.erl emqx_conf (#5939) 2021-10-21 18:08:51 +08:00

README.md

EMQ X Broker

GitHub Release Build Status Coverage Status Docker Pulls Slack 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 scale 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/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

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 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.