diff --git a/README-CN.md b/README-CN.md index 09b282158..8e2a2d70f 100644 --- a/README-CN.md +++ b/README-CN.md @@ -10,45 +10,87 @@ [![Community](https://img.shields.io/badge/Community-EMQ%20X-yellow)](https://askemq.com) [![YouTube](https://img.shields.io/badge/Subscribe-EMQ%20中文-FF0000?logo=youtube)](https://www.youtube.com/channel/UCir_r04HIsLjf2qqyZ4A8Cg) -[![最棒的物联网 MQTT 开源团队期待您的加入](https://assets.emqx.com/images/github_readme_cn_bg.png)](https://careers.emqx.com/zh) + [English](./README.md) | 简体中文 | [日本語](./README-JP.md) | [русский](./README-RU.md) -*EMQX* 是一款完全开源，高度可伸缩，高可用的分布式 MQTT 消息服务器，适用于 IoT、M2M 和移动应用程序，可处理千万级别的并发客户端。 +EMQX 是一款全球下载量超千万的大规模分布式物联网 MQTT 服务器，单集群支持 1 亿物联网设备连接，消息分发时延低于 1 毫秒。为高可靠、高性能的物联网实时数据移动、处理和集成提供动力，助力企业构建关键业务的 IoT 平台与应用。 -从 3.0 版本开始，*EMQX* 完整支持 MQTT V5.0 协议规范，向下兼容 MQTT V3.1 和 V3.1.1，并支持 MQTT-SN、CoAP、LwM2M、WebSocket 和 STOMP 等通信协议。EMQX 3.0 单集群可支持千万级别的 MQTT 并发连接。 +EMQX 自 2013 年在 GitHub 发布开源版本以来，获得了来自 50 多个国家和地区的 20000 余家企业用户的广泛认可，累计连接物联网关键设备超过 1 亿台。 -- 新功能的完整列表，请参阅 [EMQX Release Notes](https://github.com/emqx/emqx/releases)。 -- 获取更多信息，请访问 [EMQX 官网](https://www.emqx.io/zh)。 +更多信息请访问 [EMQX 官网](https://www.emqx.io/zh)。 -## 安装 +## 快速开始 -*EMQX* 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 *EMQX* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。 +#### EMQX Cloud -Windows 上编译和运行 *EMQX* 的详情参考：[Windows.md](./Windows.md) +使用 EMQX 最简单的方式是在 EMQX Cloud 上创建完全托管的 MQTT 服务。[免费试用 EMQX Cloud](https://www.emqx.com/zh/signup?continue=https%3A%2F%2Fcloud.emqx.com%2Fconsole%2F)，无需绑定信用卡。 -#### EMQX Docker 镜像安装 +#### 使用 Docker 运行 EMQX ``` -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 +docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:latest ``` -#### 二进制软件包安装 +或直接试用 EMQX 企业版（已内置 10 个并发连接的永不过期 License） -需从 [EMQX 下载](https://www.emqx.com/zh/downloads) 页面获取相应操作系统的二进制软件包。 +``` +docker run -d --name emqx-ee -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx-ee:latest +``` -- [单节点安装文档](https://www.emqx.io/docs/zh/latest/getting-started/install.html) -- [集群配置文档](https://www.emqx.io/docs/zh/latest/advanced/cluster.html) +接下来请参考 [入门指南](https://www.emqx.io/docs/zh/v5.0/getting-started/getting-started.html#启动-emqx) 开启您的 EMQX 之旅。 -#### 在 Kubernetes 上通过 EMQX Operator 部署 +#### 更多安装方式 -详情请参考[使用文档](https://github.com/emqx/emqx-operator/blob/main/docs/zh_CN/getting-started/getting-started.md) +您可以从 [www.emqx.io/zh/downloads](https://www.emqx.io/zh/downloads) 下载不同格式的 EMQX 安装包进行手动安装。 + +也可以直接访问 [EMQX 安装文档](https://www.emqx.io/docs/zh/v5.0/deploy/install.html) 查看不同安装方式的操作步骤。 + +## 文档 + +EMQX 开源版文档：[www.emqx.io/docs/zh/latest/](https://www.emqx.io/docs/en/latest/)。 + +EMQX 企业版文档：[docs.emqx.com/zh/enterprise/latest/](https://docs.emqx.com/zh/enterprise/latest/)。 + +EMQX Cloud 文档：[docs.emqx.com/zh/cloud/latest/](https://docs.emqx.com/zh/cloud/latest/)。 + +## 贡献 + +请参考我们的 [贡献者指南](./CONTRIBUTING.md)。 + +如果对 EMQX 有改进建议，可以向 [EIP](https://github.com/emqx/eip) 提交 PR 和 ISSUE。 + +## 社区 + +- 访问 [EMQ 问答社区](https://askemq.com/) 以获取帮助，也可以分享您的想法或项目。 +- 添加小助手微信号 `emqmkt`，加入 EMQ 微信技术交流群。 +- 加入我们的 [Discord](https://discord.gg/xYGf3fQnES)，参于实时讨论。 +- 关注我们的 [bilibili](https://space.bilibili.com/522222081)，获取最新物联网技术分享。 +- 关注我们的 [微博](https://weibo.com/emqtt) 或 [Twitter](https://twitter.com/EMQTech)，获取 EMQ 最新资讯。 + +## 相关资源 + +- [MQTT 入门及进阶](https://www.emqx.com/zh/mqtt) + + EMQ 提供了通俗易懂的技术文章及简单易用的客户端工具，帮助您学习 MQTT 并快速入门 MQTT 客户端编程。 + +- [MQTT SDKs](https://www.emqx.com/zh/mqtt-client-sdk) + + 我们选取了各个编程语言中热门的 MQTT 客户端 SDK，并提供代码示例，帮助您快速掌握 MQTT 客户端库的使用。 + +- [MQTT X](https://mqttx.app/zh) + + 优雅的跨平台 MQTT 5.0 客户端工具，提供了桌面端、命令行、Web 三种版本，帮助您更快的开发和调试 MQTT 服务和应用。 + +- [车联网平台搭建从入门到精通 ](https://www.emqx.com/zh/blog/category/internet-of-vehicles) + + 结合 EMQ 在车联网领域的实践经验，从协议选择等理论知识，到平台架构设计等实战操作，分享如何搭建一个可靠、高效、符合行业场景需求的车联网平台。 ## 从源码构建 -3.0 版本开始，构建 *EMQX* 需要 Erlang/OTP R21+。 +`master` 分支是最新的 5 版本，`main-v4.3` 分支是 4.3 版本，`main-v4.4` 是 4.4 版本。 -4.3 及以后的版本： +EMQX 的 4.3 版本需要 OTP 22 或 23，4.4 和 5.0 版本需要 OTP 24。 ```bash git clone https://github.com/emqx/emqx.git @@ -57,7 +99,7 @@ make _build/emqx/rel/emqx/bin/emqx console ``` -对于 4.3 之前的版本，通过另外一个仓库构建： +对于 4.2 或更早的版本，需要从另一个仓库构建。 ```bash git clone https://github.com/emqx/emqx-rel.git @@ -66,91 +108,6 @@ 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 - -```bash -make apps/emqx_retainer-ct -``` - -### 静态分析(Dialyzer) -##### 分析所有应用程序 -``` -make dialyzer -``` - -##### 要分析特定的应用程序，（用逗号分隔的应用程序列表） -``` -DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer -``` - -## 社区 - -### FAQ - -访问 [EMQX FAQ](https://www.emqx.io/docs/zh/latest/faq/faq.html) 以获取常见问题的帮助。 - -### 问答 - -[GitHub Discussions](https://github.com/emqx/emqx/discussions) -[EMQ 中文问答社区](https://askemq.com) - -### 参与设计 - -如果对 EMQX 有改进建议，可以向[EIP](https://github.com/emqx/eip) 提交 PR 和 ISSUE - -### 插件开发 - -如果想集成或开发你自己的插件，参考 [PLUGIN.md](./PLUGIN.md) - -### 联系我们 - -你可通过以下途径与 EMQ 社区及开发者联系: - -- [Slack](https://slack-invite.emqx.io) -- [Twitter](https://twitter.com/EMQTech) -- [Facebook](https://www.facebook.com/emqxmqtt) -- [Reddit](https://www.reddit.com/r/emqx/) -- [Weibo](https://weibo.com/emqtt) -- [Blog](https://www.emqx.com/zh/blog) - -欢迎你将任何 bug、问题和功能请求提交到 [emqx/emqx](https://github.com/emqx/emqx/issues)。 - -## MQTT 规范 - -你可以通过以下链接了解与查阅 MQTT 协议: - -[MQTT Version 3.1.1](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) - -[MQTT Version 5.0](https://docs.oasis-open.org/mqtt/mqtt/v5.0/cs02/mqtt-v5.0-cs02.html) - -[MQTT SN](https://www.oasis-open.org/committees/download.php/66091/MQTT-SN_spec_v1.2.pdf) - ## 开源许可 详见 [LICENSE](./LICENSE)。 diff --git a/README.md b/README.md index 1f0f5a3f0..0b335cb85 100644 --- a/README.md +++ b/README.md @@ -68,22 +68,22 @@ For more organised improvement proposals, you can send pull requests to [EIP](ht ## Resources -- [EMQX FAQ](https://www.emqx.io/docs/en/latest/faq/faq.html) - - Visiting EMQX FAQ to get help of common problems. - - [MQTT client programming](https://www.emqx.com/en/blog/tag/mqtt-client-programming) A series of blogs to help developers get started quickly with MQTT in PHP, Node.js, Python, Golang, and other programming languages. -- [Internet of Vehicles](https://www.emqx.com/en/blog/category/internet-of-vehicles) - - Build a reliable, efficient, and industry-specific IoV platform based on EMQ's practical experience, from theoretical knowledge such as protocol selection to practical operations like platform architecture design. - - [MQTT SDKs](https://www.emqx.com/en/mqtt-client-sdk) We have selected popular MQTT client SDKs in various programming languages and provided code examples to help you quickly understand the use of MQTT clients. +- [MQTT X](https://mqttx.app/) + + An elegant cross-platform MQTT 5.0 client tool that provides desktop, command line, and web to help you develop and debug MQTT services and applications faster. + +- [Internet of Vehicles](https://www.emqx.com/en/blog/category/internet-of-vehicles) + + Build a reliable, efficient, and industry-specific IoV platform based on EMQ's practical experience, from theoretical knowledge such as protocol selection to practical operations like platform architecture design. + ## Build From Source The `master` branch is for the latest version 5 release, checkout branch `main-v4.3` for version 4.3 and `main-v4.4` for version 4.4.