create emqx project

JianBo He d6bbfdcd51 test(modules): test starting by default 4 tahun lalu
.ci 48cbb9c0ed chore(CI): cts support redis sentinel ssl 4 tahun lalu
.github df5dc78dff chore(ci): add coveralls finished github action step 4 tahun lalu
apps 8a6f26d170 test(mgmt): remove unused ct log 4 tahun lalu
bin 2a9a5e74d7 fix(bin/emqx): print cuttlefish error 4 tahun lalu
data e1979bf488 chore(build): Single source of EMQX_DESCRIPTION 5 tahun lalu
deploy b9c913d18f chore(CI): fix windows build error 4 tahun lalu
etc f902d880c1 fix(emqx): rename wont_clear_alarm_in to min_alarm_sustain_duration 4 tahun lalu
include 9e219ed68d chore(release): update emqx release version 4 tahun lalu
lib-ce d6bbfdcd51 test(modules): test starting by default 4 tahun lalu
lib-extra 6a07c8ef6d chore(extra-plugin): statement plugin tag 4 tahun lalu
priv f902d880c1 fix(emqx): rename wont_clear_alarm_in to min_alarm_sustain_duration 4 tahun lalu
scripts 06b4da8269 chore(script): update find apps script, delete needless "/" 4 tahun lalu
src 49b7d870e0 fix(modules): load application first for ekka_mnesia scanner 4 tahun lalu
test 16c999ed9b Start emqx-modules application by default (#4518) 4 tahun lalu
.editorconfig 7f12db0180 add editorconfig for emqx 7 tahun lalu
.gitattributes b397b56db7 chore(gitattributes): fix file classification. 4 tahun lalu
.gitignore 4373367c15 chore(script): Add a script to split emqx.conf 5 tahun lalu
.tool-versions bc29a1f9c4 chore(dev): Pin asdf erlang 23.2.2 5 tahun lalu
CONTRIBUTING.md ca47dae699 docs: format contributing 5 tahun lalu
LICENSE 94c3e69b44 Licensed under the Apache, Version 2.0 10 tahun lalu
Makefile 4116806544 chore(build): upgrade to rebar3 3.14.3-emqx-6 4 tahun lalu
README-CN.md 996fcb0d4f docs(README-CN): fix outdated compile guide 4 tahun lalu
README-JP.md 1857364523 docs(README-JP): sync jp readme 4 tahun lalu
README.md fd1b1936ad docs(README): Update README to include plugin dev 4 tahun lalu
Windows.md 96bd561790 feat(windows): Support environment variable override for windows 4 tahun lalu
build 622edcd536 chore(CI): rename arch package name 4 tahun lalu
docker.mk 862e484944 chore(CI): build workflow support enterprise repo (#4363) 4 tahun lalu
elvis.config 5b126d60ad style(elvis): force spaces around | and || 4 tahun lalu
pkg-vsn.sh 7e3b7bb0fe chore(CI): fix pkg-vsn error 4 tahun lalu
rebar.config d010830de8 chore(rebar.config): bump cuttlefish 4 tahun lalu
rebar.config.erl e2c2f39bc2 chore(build): no deterministic compile flag for non-prod profiles 4 tahun lalu

README-CN.md

EMQ X Broker

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

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

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 是跨平台的,支持 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 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_bridge_mqtt-ct

静态分析(Dialyzer)

分析所有应用程序
make dialyzer
要分析特定的应用程序,(用逗号分隔的应用程序列表)
DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer

社区

FAQ

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

问答

GitHub Discussions EMQ 中文问答社区

参与设计

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

插件开发

如果想集成或开发你自己的插件,参考 lib-extra/README.md

联系我们

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

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

MQTT 规范

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

MQTT Version 3.1.1

MQTT Version 5.0

MQTT SN

开源许可

Apache License 2.0, 详见 LICENSE