create emqx project

Rory Z 545abe2d52 Merge pull request #7006 from Rory-Z/ci/update-target-event 4 年之前
.ci 2df43f8b5f ci: add more time to allow stop 4 年之前
.github 545abe2d52 Merge pull request #7006 from Rory-Z/ci/update-target-event 4 年之前
apps a5f6e94467 docs: EMQ X -> EMQX 4 年之前
bin d2840a8aa1 docs: change EMQ X to EMQX in more descriptive info 4 年之前
data 3aba50605a chore(nodetool): ensure correct lib dirs 4 年之前
deploy 149fe7bcdf Merge pull request #7010 from Rory-Z/build/add-new-script 4 年之前
etc d2840a8aa1 docs: change EMQ X to EMQX in more descriptive info 4 年之前
include b09a38d53f chore: update release to 4.3.12 4 年之前
lib-ce e09e5673eb docs(README): EMQ X -> EMQX 4 年之前
lib-extra e09e5673eb docs(README): EMQ X -> EMQX 4 年之前
priv 579905b92a fix(watermark): hight watermark should greater than low watermark. 4 年之前
scripts 149fe7bcdf Merge pull request #7010 from Rory-Z/build/add-new-script 4 年之前
src 3f31df2297 docs: add comment explaining application and release vsn discrepancy 4 年之前
test 8302cac329 fix(channel): wrong case clause when alias is inexistent 4 年之前
.editorconfig 7f12db0180 add editorconfig for emqx 7 年之前
.gitattributes b397b56db7 chore(gitattributes): fix file classification. 4 年之前
.gitignore f2cfde7421 fix(mgmt): fix subscription info format 4 年之前
.tool-versions e34055b6ef chore: pin OTP-23.2.7.2-emqx-3 4 年之前
CHANGES-4.3.md a5f6e94467 docs: EMQ X -> EMQX 4 年之前
CONTRIBUTING.md ca47dae699 docs: format contributing 5 年之前
LICENSE 94c3e69b44 Licensed under the Apache, Version 2.0 10 年之前
Makefile 091398d863 build(relup): add new script for download relup base packages 4 年之前
NOTICE d2840a8aa1 docs: change EMQ X to EMQX in more descriptive info 4 年之前
README-CN.md e09e5673eb docs(README): EMQ X -> EMQX 4 年之前
README-JP.md e09e5673eb docs(README): EMQ X -> EMQX 4 年之前
README-RU.md e09e5673eb docs(README): EMQ X -> EMQX 4 年之前
README.md e09e5673eb docs(README): EMQ X -> EMQX 4 年之前
Windows.md a5f6e94467 docs: EMQ X -> EMQX 4 年之前
build 091398d863 build(relup): add new script for download relup base packages 4 年之前
elvis.config 5b126d60ad style(elvis): force spaces around | and || 4 年之前
pkg-vsn.sh 0971567cff build: ensure git tag matches release version 4 年之前
rebar.config 12fbcc1330 chore: upgrade to ekka 0.8.1.8 4 年之前
rebar.config.erl 9832a2ed00 build: show linux distro in BUILT_ON info 4 年之前

README-CN.md

EMQX Broker

GitHub Release Build Status Coverage Status Docker Pulls Slack Invite 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 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_bridge_mqtt-ct

静态分析(Dialyzer)

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

社区

FAQ

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

问答

GitHub Discussions EMQ 中文问答社区

参与设计

如果对 EMQX 有改进建议,可以向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