8342b3711d
Port of #6480 . * Make the script regex-aware This change makes the `update_appup.escript` check whether the new version of an application (the _current_ one) is already contained in entries in the _new_ .appup file for that application if such .appup file contains regexes. * Do not use `load_module` instructions if `restart_application` is present Since the appup instruction `restart_application` already loads all modules of a given application, there is no need to introduce those instructions if a restart is already present. * Do not force `.appup.src` render if contents are the same To avoid losing comments and/or manual indentation in appup files that are already up to date, we now check whether the contents have the exact same terms as those we are about to write to an existint .appup file. * Insert `load_module`s after `application:stop`, if present If there is already any `application:stop(Application)` call in the appup instructions, we prefer to add `load_module` instructions after it, so we can be sure that the load is replaced safely. * Add expected versions check For apps inside emqx umbrella, we try to bump only the patch part of their version numbers, and use only 3-part version numbers (`Major.Minor.Patch`). With those assumptions, we may infer all versions that need to be covered in a given upgrade, and check if those are covered in regexes. |
||
|---|---|---|
| .ci | ||
| .github | ||
| apps | ||
| bin | ||
| data | ||
| deploy | ||
| lib-ee | ||
| scripts | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .tool-versions | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| NOTICE | ||
| PLUGIN.md | ||
| README-CN.md | ||
| README-JP.md | ||
| README-RU.md | ||
| README.md | ||
| Windows.md | ||
| build | ||
| elvis.config | ||
| pkg-vsn.sh | ||
| rebar.config | ||
| rebar.config.erl | ||
README.md
EMQ X Broker
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.
- For full list of new features, please read EMQ X Release Notes.
- For more information, please visit EMQ X homepage.
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
See PLUGIN.md
MQTT Specifications
You can read the mqtt protocol via the following links:
License
Apache License 2.0, see LICENSE.