|
|
@@ -7,8 +7,7 @@
|
|
|
[](https://slack-invite.emqx.io)
|
|
|
[](https://twitter.com/emqtt)
|
|
|
|
|
|
-
|
|
|
-[](https://www.emqx.io/careers)
|
|
|
+[](https://www.emqx.io/careers)
|
|
|
|
|
|
English | [简体中文](./README-CN.md)
|
|
|
|
|
|
@@ -17,22 +16,24 @@ English | [简体中文](./README-CN.md)
|
|
|
Starting from 3.0 release, *EMQ X* broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the *EMQ X* broker can scaled to 10+ million concurrent MQTT connections on one cluster.
|
|
|
|
|
|
- For full list of new features, please read [EMQ X Release Notes](https://github.com/emqx/emqx/releases).
|
|
|
-- For more information, please visit [EMQ X homepage](https://emqx.io).
|
|
|
+- For more information, please visit [EMQ X homepage](https://www.emqx.io).
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
-The *EMQ X* broker is cross-platform, which supports Linux, Unix, Mac OS and Windows. It means *EMQ X* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.
|
|
|
+The *EMQ X* broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means *EMQ X* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.
|
|
|
|
|
|
-**Installing via EMQ X Docker Image**
|
|
|
+#### Installing via EMQ X Docker Image
|
|
|
|
|
|
```
|
|
|
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx
|
|
|
```
|
|
|
|
|
|
-**Or download the binary package for your platform from [here](https://emqx.io/downloads).**
|
|
|
+#### Installing via Binary Package
|
|
|
+
|
|
|
+Get the binary package of the corresponding OS from [EMQ X Download](https://www.emqx.io/downloads) page.
|
|
|
|
|
|
-- [Single Node Install](https://docs.emqx.io/broker/v3/en/install.html)
|
|
|
-- [Multi Node Install](https://docs.emqx.io/broker/v3/en/cluster.html)
|
|
|
+- [Single Node Install](https://docs.emqx.io/broker/latest/en/getting-started/installation.html)
|
|
|
+- [Multi Node Install](https://docs.emqx.io/broker/latest/en/advanced/cluster.html)
|
|
|
|
|
|
|
|
|
## Build From Source
|
|
|
@@ -65,7 +66,7 @@ To view the dashboard after running, use your browser to open: http://localhost:
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
-Visiting [FAQ](https://docs.emqx.io/tutorial/v3/en/faq/faq.html) to get help of common problems.
|
|
|
+Visiting [EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html) to get help of common problems.
|
|
|
|
|
|
## Roadmap
|
|
|
|
|
|
@@ -74,11 +75,12 @@ The [EMQ X Roadmap uses Github milestones](https://github.com/emqx/emqx/mileston
|
|
|
## Community, discussion, contribution, and support
|
|
|
|
|
|
You can reach the EMQ community and developers via the following channels:
|
|
|
-- [EMQX Slack](https://slack-invite.emqx.io/)
|
|
|
+- [Slack](https://slack-invite.emqx.io/)
|
|
|
- [Twitter](https://twitter.com/emqtt)
|
|
|
+- [Facebook](https://www.facebook.com/emqxmqtt)
|
|
|
+- [Reddit](https://www.reddit.com/r/emqx/)
|
|
|
- [Forum](https://groups.google.com/d/forum/emqtt)
|
|
|
- [Blog](https://medium.com/@emqtt)
|
|
|
-- [Reddit](https://www.reddit.com/r/emqx/)
|
|
|
|
|
|
Please submit any bugs, issues, and feature requests to [emqx/emqx](https://github.com/emqx/emqx/issues).
|
|
|
|