emqx / emqx-docs

EMQX product documentation

EMQX Documentation

English | 简体中文

---

Welcome to the repo for EMQX documentation. This is the source for https://docs.emqx.io/en/broker/latest/.

EMQX 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.

For more information about EMQX, please access EMQ website.

Contributing

If you find EMQX documentation issues, please create an Issue to let us know or directly create a Pull request to help fix or update it. Our docs are completely open-source, and we sincerely appreciate contributions from our community!

See EMQX Documentation Contributing Guide to become a contributor!

Preview

# for community
./preview.sh ce 8080

# for enterprise
./preview.sh ee 8080

Now, open http://localhost:8080/docs/en/latest/ or http://localhost:8080/en/enterprise/latest/, if dir.yaml has been updated, you can re-run the above command to update the docs.

Release a New Version

Both community and enterprise edition documents are managed in the same repo and same release-Major.Minor branch.

Opensource and Enterprise may have different content so they may release at different pace.

Cut a new release for community edition

NEW_TAG="$(./cut-release.sh ce)"
git push origin "${NEW_TAG}"

Cut a New Release for Enterprise Edition

NEW_TAG="$(./cut-release.sh ee)"
git push origin "${NEW_TAG}"

Opensource

You can reach the EMQ community and developers via the following channels.

• Slack
• Twitter
• Facebook
• Reddit
• Blog

emqx-docs's Issues

日志与追踪 · EMQ X Broker 使用文档

http://localhost:4000/using-emqx/log.html

EMQ X 消息服务器功能列表 · EMQ X Broker 使用文档

http://localhost:4000/introduction/checklist.html

常见错误 · EMQ X Broker 使用文档

http://localhost:4000/faq/error.html

FAQ 标签 · EMQ X Broker 使用文档

http://localhost:4000/faq/tags.html

安装部署 · EMQ X Broker 使用文档

http://localhost:4000/faq/deployment.html

认证 · EMQ X Broker 使用文档

http://localhost:4000/advanced/auth.html

共享订阅 · EMQ X Broker 使用文档

http://localhost:4000/advanced/shared-subscriptions.html

保留消息 · EMQ X Broker 使用文档

http://localhost:4000/advanced/retained.html

EMQ X 消息服务器简介 · EMQ X Broker 使用文档

http://localhost:4000/

启动 EMQ X · EMQ X Broker 使用文档

http://localhost:4000/getting-started/start.html

MQTT-SN Documentation

安装 · EMQ X Broker 使用文档

http://localhost:4000/getting-started/installation.html

延迟发布 · EMQ X Broker 使用文档

http://localhost:4000/advanced/dely-publish.html

插件 · EMQ X Broker 使用文档

http://localhost:4000/advanced/plugins.html

认证 · EMQ X Broker 使用文档

http://localhost:4000/tutorial/auth.html

黑名单 · EMQ X Broker 使用文档

http://localhost:4000/advanced/blacklist.html

创建规则举例 · EMQ X Broker 使用文档

http://localhost:4000/advanced/rule-examples.html

代理订阅 · EMQ X Broker 使用文档

http://localhost:4000/advanced/proxy-subscriptions.html

配置说明 · EMQ X Broker 使用文档

http://localhost:4000/using-emqx/config.html

WebHook · EMQ X Broker 使用文档

http://localhost:4000/advanced/webhook.html

集群部署时如何对接kafka

比如我部署了一个emq集群，我的backend也是一个集群，backend每个node订阅了同一个topic，如何保证一个消息只被一个node消费。如果中间加个kafka，那kafka只能订阅emq的其中一个节点，又涉及到单点问题。

目录结构 · EMQ X Broker 使用文档

http://localhost:4000/using-emqx/directory.html

相关资料 · EMQ X Broker 使用文档

http://localhost:4000/awesome/

Clustering EMQ on kubernetes (k8s)

Refer to Clustered RabbitMQ on Kubernetes: https://www.kubernetes.org.cn/1304.html

商业服务 · EMQ X Broker 使用文档

http://localhost:4000/faq/enterprise.html

发布订阅 ACL · EMQ X Broker 使用文档

http://localhost:4000/advanced/acl.html

$SYS 系统主题 · EMQ X Broker 使用文档

http://localhost:4000/advanced/system-topic.html

FAQ · EMQ X Broker 使用文档

http://localhost:4000/faq/

配置项 · EMQ X Broker 使用文档

http://localhost:4000/configuration/

Dashboard · EMQ X Broker 使用文档

http://localhost:4000/using-emqx/dashboard.html

客户端连接服务器端测试，最终只能建立32562连接

1. 服务器端和客户端都按照官网配置

2. 客户端
   
   请教下，这种情况是我的客户端测试机哪里不对吗?

`[root@lp emqtt_benchmark]# erl
Erlang/OTP 18 [erts-7.2] [source] [64-bit] [smp:16:16] [async-threads:10] [hipe] [kernel-poll:false]

Eshell V7.2 (abort with ^G)
1> `

架构设计 · EMQ X Broker 使用文档

http://localhost:4000/design/

其他资源 · EMQ X Broker 使用文档

http://localhost:4000/development/resource.html

SDK & Tools · EMQ X Broker 使用文档

http://localhost:4000/development/client.html

基本命令 · EMQ X Broker 使用文档

http://localhost:4000/using-emqx/command-line.html

CoAP Documentation

请问emqtt的开源的协议是什么？可以商用吗?

请问emqtt的开源的协议是什么？可以商用吗?

管理监控 API · EMQ X Broker 使用文档

http://localhost:4000/advanced/rest-api.html

document index page picture Kafka called 'Kafaka'

the same as en documents.
doc_url http://emqtt.com/docs/v2/index.html
pic_url http://emqtt.com/docs/v2/_images/emqtt.png

消息桥接 · EMQ X Broker 使用文档

http://localhost:4000/advanced/bridge.html

认证 · EMQ X Broker 使用文档

http://localhost:4000/advanced/auth.html

钩子 · EMQ X Broker 使用文档

http://localhost:4000/advanced/hooks.html

How to configure virtual IP on test node?

使用教程 · EMQ X Broker 使用文档

http://localhost:4000/faq/use-guide.html

主题重写 · EMQ X Broker 使用文档

http://localhost:4000/advanced/topic-rewrite.html

命令行接口 · EMQ X Broker 使用文档

http://localhost:4000/advanced/cli.html

管理监控 API · EMQ X Broker 使用文档

http://localhost:4000/advanced/http-api.html

documentation is confused...

this new released doc has something confused about coap configuration. please refer to https://github.com/emqx/emqx-coap.

this doc gives us an example to use coap_client with post to send message, but the emqx-coap doc say that does not support POST and DELETE...

can you give some more clear description about how to use coaps protocol?

规则引擎 · EMQ X Broker 使用文档

http://localhost:4000/advanced/rule-engine.html

分布集群 · EMQ X Broker 使用文档

http://localhost:4000/advanced/cluster.html