create emqx project

Thales Macedo Garitezi 6dd11665bb ci(mix): build emqx packages with elixir		4 years ago
.ci	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
.github	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
apps	5ed27f92b7 Merge pull request #6855 from savonarola/ph-interpolation	4 years ago
bin	1abac892c9 refactor: install_upgrade script no need to re-pack	4 years ago
deploy	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
lib	34d6dbca61 chore(mix): simplify build by using rebar3 for umbrella apps	4 years ago
lib-ee	7f49934216 chore: add BSL.txt	4 years ago
rel	a04c834d05 chore: relocate some release files from data/ to rel/	4 years ago
scripts	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
.editorconfig	7f12db0180 add editorconfig for emqx	7 years ago
.formatter.exs	c14e8db869 style(format): format elixir files	4 years ago
.gitattributes	39d60121d1 chore: ensure lf but not crlf for build scripts	4 years ago
.gitignore	d78e9429f3 ci(mix): rm mix.lock from repo	4 years ago
.tool-versions	54a6674715 fix: undo tool-versions change	4 years ago
APL.txt	7f49934216 chore: add BSL.txt	4 years ago
CONTRIBUTING.md	56e2a9741f style: ensure newline at EOF for all files	4 years ago
LICENSE	7f49934216 chore: add BSL.txt	4 years ago
Makefile	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
NOTICE	9f7b513a3f chore: fix copyright update script to include more files	4 years ago
PLUGIN.md	4d9b4cb828 refactor: delete lib-extra	4 years ago
README-CN.md	fa08722447 chore(README): modify some badges	4 years ago
README-JP.md	fa08722447 chore(README): modify some badges	4 years ago
README-RU.md	fa08722447 chore(README): modify some badges	4 years ago
README.md	62957bea9d Update README.md	4 years ago
Windows.md	8a92b9dafa docs: update Windows build instructions	4 years ago
build	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
elvis.config	071c2c99e8 refactor(authn resources): add `emqx_resource` and `emqx_authn` tests	4 years ago
mix.exs	6dd11665bb ci(mix): build emqx packages with elixir	4 years ago
pkg-vsn.sh	391e480824 build: parameterise package version	4 years ago
rebar.config	e2ba0fc4ae fix(minirest): app version to 1.2.10 support string desc in api spec	4 years ago
rebar.config.erl	b9e507110c build: add EMQX_ENTERPRISE compile flag	4 years ago

EMQ X Broker

English | 简体中文 | 日本語 | русский

EMQ X 是一款完全开源，高度可伸缩，高可用的分布式 MQTT 消息服务器，适用于 IoT、M2M 和移动应用程序，可处理千万级别的并发客户端。

从 3.0 版本开始，EMQ X 完整支持 MQTT V5.0 协议规范，向下兼容 MQTT V3.1 和 V3.1.1，并支持 MQTT-SN、CoAP、LwM2M、WebSocket 和 STOMP 等通信协议。EMQ X 3.0 单集群可支持千万级别的 MQTT 并发连接。

新功能的完整列表，请参阅 EMQ X Release Notes。
获取更多信息，请访问 EMQ X 官网。

安装

EMQ X 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 EMQ X 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。

Windows 上编译和运行 EMQ X 的详情参考：Windows.md

EMQ X Docker 镜像安装

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

二进制软件包安装

需从 EMQ X 下载页面获取相应操作系统的二进制软件包。

从源码构建

3.0 版本开始，构建 EMQ X 需要 Erlang/OTP R21+。

4.3 及以后的版本：

git clone https://github.com/emqx/emqx.git
cd emqx
make
_build/emqx/rel/emqx/bin/emqx console

对于 4.3 之前的版本，通过另外一个仓库构建：

git clone https://github.com/emqx/emqx-rel.git
cd emqx-rel
make
_build/emqx/rel/emqx/bin/emqx console

快速入门

如果 emqx 从源码编译，cd _build/emqx/rel/emqx。如果 emqx 通过 zip 包安装，则切换到 emqx 的根目录。

# Start emqx
./bin/emqx start

# Check Status
./bin/emqx_ctl status

# Stop emqx
./bin/emqx stop

EMQ X 启动，可以使用浏览器访问 http://localhost:18083 来查看 Dashboard。

测试

执行所有测试

make eunit ct

执行部分应用的 common tests

make apps/emqx_retainer-ct

静态分析(Dialyzer)

分析所有应用程序

make dialyzer

要分析特定的应用程序，（用逗号分隔的应用程序列表）

DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer

社区

FAQ

访问 EMQ X FAQ 以获取常见问题的帮助。

问答

GitHub Discussions EMQ 中文问答社区

参与设计

如果对 EMQ X 有改进建议，可以向EIP 提交 PR 和 ISSUE

插件开发

如果想集成或开发你自己的插件，参考 PLUGIN.md

联系我们

你可通过以下途径与 EMQ 社区及开发者联系:

欢迎你将任何 bug、问题和功能请求提交到 emqx/emqx。

MQTT 规范

你可以通过以下链接了解与查阅 MQTT 协议:

MQTT Version 3.1.1

MQTT Version 5.0

MQTT SN

开源许可

详见 LICENSE。

README-CN.md