create emqx project

JianBo He 96c9fbca07 Merge pull request #7650 from JimMoen/add-authz-cache-api 3 lat temu
.ci b49df4599a build: use latest builder images (alpine 3.15.1) 3 lat temu
.github c5d97678c5 ci(spellcheck): Treat missing descriptions as erros 3 lat temu
apps c89c00aed0 test: clean cache api for all clients or specific client 3 lat temu
bin 18cebd9be7 feat: parameterise console flavor 3 lat temu
deploy b49df4599a build: use latest builder images (alpine 3.15.1) 3 lat temu
lib-ee 164754b182 test: dashboard ct failed with lack i18n_lang 3 lat temu
rel 3c03c0cfc1 feat(bin/emqx): make possible to boot Erlang node from Elixir build 3 lat temu
scripts ce915f0bbd Merge pull request #7590 from zhongwencool/doc-i18n 3 lat temu
.editorconfig 7f12db0180 add editorconfig for emqx 7 lat temu
.formatter.exs c14e8db869 style(format): format elixir files 4 lat temu
.gitattributes 1aa9abdb4d chore: relocate tests.sh 4 lat temu
.gitignore 700c2cfb39 feat: move *i18n.conf from etc to i18n dir 3 lat temu
.tool-versions 8cac5f6b39 chore(ci): update emqx-builder image 4 lat temu
APL.txt 7f49934216 chore: add BSL.txt 4 lat temu
CONTRIBUTING.md 56e2a9741f style: ensure newline at EOF for all files 4 lat temu
LICENSE 2e94880bb6 docs: More EMQ X -> EMQX rename in descriptive strings 4 lat temu
Makefile 216fba5a03 chore: update dashboard version 3 lat temu
NOTICE 2e94880bb6 docs: More EMQ X -> EMQX rename in descriptive strings 4 lat temu
PLUGIN.md 2e94880bb6 docs: More EMQ X -> EMQX rename in descriptive strings 4 lat temu
README-CN.md 1be3eb1446 chore: rename EMQX Broker to just EMQX 4 lat temu
README-JP.md 1be3eb1446 chore: rename EMQX Broker to just EMQX 4 lat temu
README-RU.md 667d66eb1e docs(README): EMQ X -> EMQX 4 lat temu
README.md c8bcfb201b docs: add info about default dashboard user name and password to README.md file 3 lat temu
Windows.md 6dedf4875a ci(windows): build windows package on otp 24 4 lat temu
build 700c2cfb39 feat: move *i18n.conf from etc to i18n dir 3 lat temu
elvis.config 7a9ad86574 chore: increase line width to 120 3 lat temu
git-blame-ignore-revs 4db2761804 chore: update git-blame-ignore-revs 3 lat temu
mix.exs 034fa3b9be fix: update mix dep version 3 lat temu
pkg-vsn.sh bec0504f3a chore: fix pkg-vsn.sh, delete git tag prefix in the right way 3 lat temu
rebar.config e22d01d25f fix: page & limit & pool_size pos_integer; some bad spelling 3 lat temu
rebar.config.erl 868e26cabc fix: emqx_auto_subscribe emqx_slow_subs don't restart when ekka:join. 3 lat temu

README-CN.md

EMQX

GitHub Release Build Status Coverage Status Docker Pulls Slack Discord Twitter Community YouTube

最棒的物联网 MQTT 开源团队期待您的加入

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

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

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

安装

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

Windows 上编译和运行 EMQX 的详情参考:Windows.md

EMQX 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

二进制软件包安装

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

从源码构建

3.0 版本开始,构建 EMQX 需要 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

EMQX 启动,可以使用浏览器访问 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

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

问答

GitHub Discussions EMQ 中文问答社区

参与设计

如果对 EMQX 有改进建议,可以向EIP 提交 PR 和 ISSUE

插件开发

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

联系我们

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

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

MQTT 规范

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

MQTT Version 3.1.1

MQTT Version 5.0

MQTT SN

开源许可

详见 LICENSE