tigercl
GitHub
parent
d8bcb1b26f
commit
73af0e40bf
|
|
@ -0,0 +1,87 @@
|
|||
# EMQ X Broker
|
||||
|
||||
[](https://github.com/emqx/emqx/releases)
|
||||
[](https://travis-ci.org/emqx/emqx)
|
||||
[](https://coveralls.io/github/emqx/emqx)
|
||||
[](https://hub.docker.com/r/emqx/emqx)
|
||||
[](https://emqx.slack.com)
|
||||
[](https://twitter.com/emqtt)
|
||||
|
||||
[English](./README.md) | 简体中文
|
||||
|
||||
*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 Release Notes](https://github.com/emqx/emqx/releases)。
|
||||
- 获取更多信息，请访问 [EMQ X](https://emqx.io)。
|
||||
|
||||
## 安装
|
||||
|
||||
*EMQ X* 是跨平台的，支持 Linux、Unix、Mac OS 以及 Windows。这意味着 *EMQ X* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。
|
||||
|
||||
获取适合你的二进制软件包，[点此下载](https://emqx.io/downloads)。
|
||||
|
||||
- [单节点安装](https://developer.emqx.io/docs/emq/v3/en/install.html)
|
||||
- [集群安装](https://developer.emqx.io/docs/emq/v3/en/cluster.html)
|
||||
|
||||
## 从源码构建
|
||||
|
||||
3.0 版本开始，构建 *EMQ X* 需要 Erlang/OTP R21+。
|
||||
|
||||
```
|
||||
git clone https://github.com/emqx/emqx-rel.git
|
||||
|
||||
cd emqx-rel && make
|
||||
|
||||
cd _rel/emqx && ./bin/emqx console
|
||||
```
|
||||
|
||||
## 快速入门
|
||||
|
||||
```
|
||||
# Start emqx
|
||||
./bin/emqx start
|
||||
|
||||
# Check Status
|
||||
./bin/emqx_ctl status
|
||||
|
||||
# Stop emqx
|
||||
./bin/emqx stop
|
||||
```
|
||||
|
||||
*EMQ X* 启动，可以使用浏览器访问 http://localhost:18083 来查看 Dashboard。
|
||||
|
||||
## FAQ
|
||||
|
||||
访问 [FAQ](https://developer.emqx.io/docs/tutorial/zh/faq/faq.html) 以获取常见问题的帮助。
|
||||
|
||||
## 产品路线
|
||||
|
||||
通过 [EMQ X Roadmap uses Github milestones](https://github.com/emqx/emqx/milestones) 参与跟踪项目进度。
|
||||
|
||||
## 社区、讨论、贡献和支持
|
||||
|
||||
你可通过以下途径与 EMQ 社区及开发者联系:
|
||||
|
||||
- [EMQX Slack](http://emqx.slack.com)
|
||||
- [Mailing Lists](<emqtt@googlegroups.com>)
|
||||
- [Twitter](https://twitter.com/emqtt)
|
||||
- [Forum](https://groups.google.com/d/forum/emqtt)
|
||||
- [Blog](https://medium.com/@emqtt)
|
||||
|
||||
欢迎你将任何 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](http://mqtt.org/new/wp-content/uploads/2009/06/MQTT-SN_spec_v1.2.pdf)
|
||||
|
||||
## 开源许可
|
||||
|
||||
Apache License 2.0, 详见 [LICENSE](./LICENSE)。
|
||||
35
README.md
35
README.md
|
|
@ -1,19 +1,26 @@
|
|||
# EMQ X Broker
|
||||
|
||||
[](https://github.com/emqx/emqx/releases)
|
||||
[](https://travis-ci.org/emqx/emqx)
|
||||
[](https://coveralls.io/github/emqx/emqx)
|
||||
[](https://hub.docker.com/r/emqx/emqx)
|
||||
[](https://emqx.slack.com)
|
||||
[](https://twitter.com/emqtt)
|
||||
|
||||
English | [简体中文](./README-CN.md)
|
||||
|
||||
*EMQ X* broker 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.
|
||||
|
||||
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* broker 3.0 [release notes](https://github.com/emqx/emqx/releases/).
|
||||
- For more information, please visit [EMQ X homepage](http://emqx.io).
|
||||
|
||||
- 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).
|
||||
|
||||
## Installation
|
||||
|
||||
The *EMQ X* broker is cross-platform, which can be deployed on Linux, Unix, Mac, Windows and even Raspberry Pi.
|
||||
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.
|
||||
|
||||
Download the binary package for your platform from [here](http://emqx.io/downloads).
|
||||
Download the binary package for your platform from [here](https://emqx.io/downloads).
|
||||
|
||||
- [Single Node Install](https://developer.emqx.io/docs/emq/v3/en/install.html)
|
||||
- [Multi Node Install](https://developer.emqx.io/docs/emq/v3/en/cluster.html)
|
||||
|
|
@ -34,6 +41,7 @@ cd _rel/emqx && ./bin/emqx console
|
|||
|
||||
## Quick Start
|
||||
|
||||
```
|
||||
# Start emqx
|
||||
./bin/emqx start
|
||||
|
||||
|
|
@ -42,9 +50,13 @@ cd _rel/emqx && ./bin/emqx console
|
|||
|
||||
# Stop emqx
|
||||
./bin/emqx stop
|
||||
```
|
||||
|
||||
To view the dashboard after running, use your browser to open: http://localhost:18083
|
||||
|
||||
## FAQ
|
||||
|
||||
Visiting [FAQ](https://developer.emqx.io/docs/tutorial/en/faq/faq.html) to get help of common problems.
|
||||
|
||||
## Roadmap
|
||||
|
||||
|
|
@ -54,8 +66,6 @@ The [EMQ X Roadmap uses Github milestones](https://github.com/emqx/emqx/mileston
|
|||
|
||||
You can reach the EMQ community and developers via the following channels:
|
||||
- [EMQX Slack](http://emqx.slack.com)
|
||||
-[#emqx-users](https://emqx.slack.com/messages/CBUF2TTB8/)
|
||||
-[#emqx-devs](https://emqx.slack.com/messages/CBSL57DUH/)
|
||||
- [Mailing Lists](<emqtt@googlegroups.com>)
|
||||
- [Twitter](https://twitter.com/emqtt)
|
||||
- [Forum](https://groups.google.com/d/forum/emqtt)
|
||||
|
|
@ -75,11 +85,4 @@ You can read the mqtt protocol via the following links:
|
|||
|
||||
## License
|
||||
|
||||
Copyright (c) 2013-2019 [EMQ Technologies Co., Ltd](http://emqx.io). All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at
|
||||
|
||||
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and limitations under the License.
|
||||
Apache License 2.0, see [LICENSE](./LICENSE).
|
||||
Loading…
Reference in New Issue