yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(README): EMQ X -> EMQX

This commit is contained in:
Zaiming (Stone) Shi 2022-02-15 16:19:26 +01:00
parent df4f528381
commit 667d66eb1e
21 changed files with 86 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README-CN.md
View File

@ -1,4 +1,4 @@
# EMQ X Broker
# EMQX Broker
[![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases)
[![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx)
@ -14,20 +14,20 @@
[English](./README.md) | 简体中文 | [日本語](./README-JP.md) | [русский](./README-RU.md)
*EMQ X* 是一款完全开源，高度可伸缩，高可用的分布式 MQTT 消息服务器，适用于 IoT、M2M 和移动应用程序，可处理千万级别的并发客户端。
*EMQX* 是一款完全开源，高度可伸缩，高可用的分布式 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 并发连接。
从 3.0 版本开始，*EMQX* 完整支持 MQTT V5.0 协议规范，向下兼容 MQTT V3.1 和 V3.1.1，并支持 MQTT-SN、CoAP、LwM2M、WebSocket 和 STOMP 等通信协议。EMQX 3.0 单集群可支持千万级别的 MQTT 并发连接。
- 新功能的完整列表，请参阅 [EMQ X Release Notes](https://github.com/emqx/emqx/releases)。
- 获取更多信息，请访问 [EMQ X 官网](https://www.emqx.io/zh)。
- 新功能的完整列表，请参阅 [EMQX Release Notes](https://github.com/emqx/emqx/releases)。
- 获取更多信息，请访问 [EMQX 官网](https://www.emqx.io/zh)。
## 安装
*EMQ X* 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 *EMQ X* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。
*EMQX* 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 *EMQX* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。
Windows 上编译和运行 *EMQ X* 的详情参考：[Windows.md](./Windows.md)
Windows 上编译和运行 *EMQX* 的详情参考：[Windows.md](./Windows.md)
#### EMQ X Docker 镜像安装
#### 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
@ -35,14 +35,14 @@ docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p
#### 二进制软件包安装
需从 [EMQ X 下载](https://www.emqx.com/zh/downloads) 页面获取相应操作系统的二进制软件包。
需从 [EMQX 下载](https://www.emqx.com/zh/downloads) 页面获取相应操作系统的二进制软件包。
- [单节点安装文档](https://docs.emqx.cn/broker/latest/getting-started/install.html)
- [集群配置文档](https://docs.emqx.cn/broker/latest/advanced/cluster.html)
## 从源码构建
3.0 版本开始，构建 *EMQ X* 需要 Erlang/OTP R21+。
3.0 版本开始，构建 *EMQX* 需要 Erlang/OTP R21+。
4.3 及以后的版本：
@ -78,7 +78,7 @@ _build/emqx/rel/emqx/bin/emqx console
./bin/emqx stop
```
*EMQ X* 启动，可以使用浏览器访问 http://localhost:18083 来查看 Dashboard。
*EMQX* 启动，可以使用浏览器访问 http://localhost:18083 来查看 Dashboard。
## 测试
@ -109,7 +109,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer
### FAQ
访问 [EMQ X FAQ](https://docs.emqx.cn/broker/latest/faq/faq.html) 以获取常见问题的帮助。
访问 [EMQX FAQ](https://docs.emqx.cn/broker/latest/faq/faq.html) 以获取常见问题的帮助。
### 问答
@ -118,7 +118,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer
### 参与设计
如果对 EMQ X 有改进建议，可以向[EIP](https://github.com/emqx/eip) 提交 PR 和 ISSUE
如果对 EMQX 有改进建议，可以向[EIP](https://github.com/emqx/eip) 提交 PR 和 ISSUE
### 插件开发

26
README-JP.md
View File

@ -1,4 +1,4 @@
# EMQ X Broker
# EMQX Broker
[![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases)
[![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx)
@ -13,22 +13,22 @@
[English](./README.md) | [简体中文](./README-CN.md) | 日本語 | [русский](./README-RU.md)
*EMQ X* は、高い拡張性と可用性をもつ、分散型のMQTTブローカーです。数千万のクライアントを同時に処理するIoT、M2M、モバイルアプリケーション向けです。
*EMQX* は、高い拡張性と可用性をもつ、分散型のMQTTブローカーです。数千万のクライアントを同時に処理するIoT、M2M、モバイルアプリケーション向けです。
version 3.0 以降、*EMQ X* は MQTT V5.0 の仕様を完全にサポートしており、MQTT V3.1およびV3.1.1とも下位互換性があります。
version 3.0 以降、*EMQX* は MQTT V5.0 の仕様を完全にサポートしており、MQTT V3.1およびV3.1.1とも下位互換性があります。
MQTT-SN、CoAP、LwM2M、WebSocket、STOMPなどの通信プロトコルをサポートしています。 MQTTの同時接続数は1つのクラスター上で1,000万以上にまでスケールできます。
- 新機能の一覧については、[EMQ Xリリースノート](https://github.com/emqx/emqx/releases)を参照してください。
- 詳細はこちら[EMQ X公式ウェブサイト](https://www.emqx.io/)をご覧ください。
- 新機能の一覧については、[EMQXリリースノート](https://github.com/emqx/emqx/releases)を参照してください。
- 詳細はこちら[EMQX公式ウェブサイト](https://www.emqx.io/)をご覧ください。
## インストール
*EMQ X* はクロスプラットフォームで、Linux、Unix、macOS、Windowsをサポートしています。
そのため、x86_64アーキテクチャサーバー、またはRaspberryPiなどのARMデバイスに *EMQ X* をデプロイすることもできます。
*EMQX* はクロスプラットフォームで、Linux、Unix、macOS、Windowsをサポートしています。
そのため、x86_64アーキテクチャサーバー、またはRaspberryPiなどのARMデバイスに *EMQX* をデプロイすることもできます。
Windows上における *EMQ X* のビルドと実行については、[Windows.md](./Windows.md)をご参照ください。
Windows上における *EMQX* のビルドと実行については、[Windows.md](./Windows.md)をご参照ください。
#### Docker イメージによる EMQ X のインストール
#### Docker イメージによる EMQX のインストール
```
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx
@ -36,14 +36,14 @@ docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p
#### バイナリパッケージによるインストール
それぞれのOSに対応したバイナリソフトウェアパッケージは、[EMQ Xのダウンロード](https://www.emqx.com/en/downloads)ページから取得できます。
それぞれのOSに対応したバイナリソフトウェアパッケージは、[EMQXのダウンロード](https://www.emqx.com/en/downloads)ページから取得できます。
- [シングルノードインストール](https://docs.emqx.io/broker/latest/en/getting-started/installation.html)
- [マルチノードインストール](https://docs.emqx.io/broker/latest/en/advanced/cluster.html)
## ソースからビルド
version 3.0 以降の *EMQ X* をビルドするには Erlang/OTP R21+ が必要です。
version 3.0 以降の *EMQX* をビルドするには Erlang/OTP R21+ が必要です。
version 4.3 以降の場合：
@ -72,7 +72,7 @@ emqx をソースコードからビルドした場合は、
./bin/emqx stop
```
*EMQ X* の起動後、ブラウザで http://localhost:18083 にアクセスするとダッシュボードが表示されます。
*EMQX* の起動後、ブラウザで http://localhost:18083 にアクセスするとダッシュボードが表示されます。
## テスト
@ -103,7 +103,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer
### FAQ
よくある質問については、[EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html)をご確認ください。
よくある質問については、[EMQX FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html)をご確認ください。
### 質問する

18
README-RU.md
View File

@ -1,4 +1,4 @@
# Брокер EMQ X
# Брокер EMQX
[![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases)
[![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx)
@ -14,20 +14,20 @@
[English](./README.md) | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | русский
*EMQ X* — это масштабируемый, высоко доступный, распределённый MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений, который поддерживает миллионы одновременных подключений.
*EMQX* — это масштабируемый, высоко доступный, распределённый MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений, который поддерживает миллионы одновременных подключений.
Начиная с релиза 3.0, брокер *EMQ X* полностью поддерживает протокол MQTT версии 5.0, и обратно совместим с версиями 3.1 и 3.1.1, а также протоколами MQTT-SN, CoAP, LwM2M, WebSocket и STOMP. Начиная с релиза 3.0, брокер *EMQ X* может масштабироваться до более чем 10 миллионов одновременных MQTT соединений на один кластер.
Начиная с релиза 3.0, брокер *EMQX* полностью поддерживает протокол MQTT версии 5.0, и обратно совместим с версиями 3.1 и 3.1.1, а также протоколами MQTT-SN, CoAP, LwM2M, WebSocket и STOMP. Начиная с релиза 3.0, брокер *EMQX* может масштабироваться до более чем 10 миллионов одновременных MQTT соединений на один кластер.
- Полный список возможностей доступен по ссылке: [EMQ X Release Notes](https://github.com/emqx/emqx/releases).
- Более подробная информация доступна на нашем сайте: [EMQ X homepage](https://www.emqx.io/).
- Полный список возможностей доступен по ссылке: [EMQX Release Notes](https://github.com/emqx/emqx/releases).
- Более подробная информация доступна на нашем сайте: [EMQX homepage](https://www.emqx.io/).
## Установка
Брокер *EMQ X* кросплатформенный, и поддерживает Linux, Unix, macOS и Windows. Он может работать на серверах с архитектурой x86_64 и устройствах на архитектуре ARM, таких как Raspberry Pi.
Брокер *EMQX* кросплатформенный, и поддерживает Linux, Unix, macOS и Windows. Он может работать на серверах с архитектурой x86_64 и устройствах на архитектуре ARM, таких как Raspberry Pi.
Более подробная информация о запуске на Windows по ссылке: [Windows.md](./Windows.md)
#### Установка EMQ X с помощью Docker-образа
#### Установка 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
@ -35,7 +35,7 @@ docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p
#### Установка бинарного пакета
Сборки для различных операционных систем: [Загрузить EMQ X](https://www.emqx.com/en/downloads).
Сборки для различных операционных систем: [Загрузить EMQX](https://www.emqx.com/en/downloads).
- [Установка на одном сервере](https://docs.emqx.io/en/broker/latest/getting-started/install.html)
- [Установка на кластере](https://docs.emqx.io/en/broker/latest/advanced/cluster.html)
@ -112,7 +112,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer
### FAQ
Наиболее частые проблемы разобраны в [EMQ X FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html).
Наиболее частые проблемы разобраны в [EMQX FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html).
### Вопросы

22
README.md
View File

@ -1,4 +1,4 @@
# EMQ X Broker
# EMQX Broker
[![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen&label=Release)](https://github.com/emqx/emqx/releases)
[![Build Status](https://img.shields.io/travis/emqx/emqx?label=Build)](https://travis-ci.org/emqx/emqx)
@ -13,20 +13,20 @@
English | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | [русский](./README-RU.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.
*EMQX* 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 scale to 10+ million concurrent MQTT connections on one cluster.
Starting from 3.0 release, *EMQX* 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 *EMQX* broker can scale 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://www.emqx.io/).
- For full list of new features, please read [EMQX Release Notes](https://github.com/emqx/emqx/releases).
- For more information, please visit [EMQX homepage](https://www.emqx.io/).
## Installation
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.
The *EMQX* broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means *EMQX* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.
See more details for building and running *EMQ X* on Windows in [Windows.md](./Windows.md)
See more details for building and running *EMQX* on Windows in [Windows.md](./Windows.md)
#### Installing via EMQ X Docker Image
#### Installing via EMQX Docker Image
```
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
@ -34,7 +34,7 @@ docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p
#### Installing via Binary Package
Get the binary package of the corresponding OS from [EMQ X Download](https://www.emqx.com/en/downloads) page.
Get the binary package of the corresponding OS from [EMQX Download](https://www.emqx.com/en/downloads) page.
- [Single Node Install](https://docs.emqx.io/en/broker/latest/getting-started/install.html)
- [Multi Node Install](https://docs.emqx.io/en/broker/latest/advanced/cluster.html)
@ -42,7 +42,7 @@ Get the binary package of the corresponding OS from [EMQ X Download](https://www
## Build From Source
The *EMQ X* broker requires Erlang/OTP R21+ to build since 3.0 release.
The *EMQX* broker requires Erlang/OTP R21+ to build since 3.0 release.
For 4.3 and later versions.
@ -111,7 +111,7 @@ DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_authz make dialyzer
### FAQ
Visiting [EMQ X FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html) to get help of common problems.
Visiting [EMQX FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html) to get help of common problems.
### Questions

2
apps/emqx_bridge/README.md
View File

@ -1,6 +1,6 @@
# emqx_bridge
EMQ X Data Bridge is an application that managing the resources (see emqx_resource) used by emqx
EMQX Data Bridge is an application that managing the resources (see emqx_resource) used by emqx
rule engine.
It provides CRUD HTTP APIs of the resources, and is also responsible for loading the resources at

2
apps/emqx_dashboard/README.md
View File

@ -2,7 +2,7 @@
emqx-dashboard
==============
Dashboard for the EMQ X Broker.
Dashboard for the EMQX Broker.
REST API
--------

4
apps/emqx_exhook/README.md
View File

@ -1,6 +1,6 @@
# emqx_exhook
The `emqx_exhook` extremely enhance the extensibility for EMQ X. It allow using an others programming language to mount the hooks instead of erlang.
The `emqx_exhook` extremely enhance the extensibility for EMQX. It allow using an others programming language to mount the hooks instead of erlang.
## Feature
@ -10,7 +10,7 @@ The `emqx_exhook` extremely enhance the extensibility for EMQ X. It allow using
## Architecture
```
EMQ X Third-party Runtime
EMQX Third-party Runtime
+========================+ +========+==========+
| ExHook | | | |
| +----------------+ | gRPC | gRPC | User's |

8
apps/emqx_gateway/README.md
View File

@ -1,10 +1,10 @@
# emqx_gateway
***This is a very early prototype application*** for Gateway in EMQ X Broker 5.0
***This is a very early prototype application*** for Gateway in EMQX Broker 5.0
## Concept
EMQ X Gateway Management
EMQX Gateway Management
- Gateway-Registry (or Gateway Type)
- *Load
- *UnLoad
@ -49,7 +49,7 @@ Gateway v1.0: "Best practices for each type of protocol"
- MQTT-SN
- LwM2M
### Compatible with EMQ X
### Compatible with EMQX
> Why we need to compatible
@ -323,7 +323,7 @@ emqx_ctl gateway-metrics [<GatewayId>]
### Develop your protocol gateway
There are 3 way to create your protocol gateway for EMQ X 5.0:
There are 3 way to create your protocol gateway for EMQX 5.0:
1. Use Erlang to create a new emqx plugin to handle all of protocol packets (same as v5.0 before)

6
apps/emqx_gateway/src/coap/README.md
View File

@ -17,7 +17,7 @@
# EMQX 5.0 CoAP Gateway
emqx-coap is a CoAP Gateway for EMQ X Broker. It translates CoAP messages into MQTT messages and make it possible to communiate between CoAP clients and MQTT clients.
emqx-coap is a CoAP Gateway for EMQX Broker. It translates CoAP messages into MQTT messages and make it possible to communiate between CoAP clients and MQTT clients.
<a id="orgeddbc94"></a>
@ -100,11 +100,11 @@ emqx-coap is a CoAP Gateway for EMQ X Broker. It translates CoAP messages into M
Establishing a connection is optional. If the CoAP client needs to use connection-based operations, it must first establish a connection.
At the same time, the connectionless mode and the connected mode cannot be mixed.
In connection mode, the Publish/Subscribe/UnSubscribe sent by the client must be has Token and ClientId in query string.
If the Token and Clientid is wrong/miss, EMQ X will reset the request.
If the Token and Clientid is wrong/miss, EMQX will reset the request.
The communication token is the data carried in the response payload after the client successfully establishes a connection.
After obtaining the token, the client's subsequent request must attach "token=Token" to the Query String
ClientId is necessary when there is a connection, and is a unique identifier defined by the client.
The server manages the client through the ClientId. If the ClientId is wrong, EMQ X will reset the request.
The server manages the client through the ClientId. If the ClientId is wrong, EMQX will reset the request.
1. Create a Connection

4
apps/emqx_gateway/src/exproto/README.md
View File

@ -1,6 +1,6 @@
# emqx-exproto
The `emqx_exproto` extremely enhance the extensibility for EMQ X. It allow using an others programming language to **replace the protocol handling layer in EMQ X Broker**.
The `emqx_exproto` extremely enhance the extensibility for EMQX. It allow using an others programming language to **replace the protocol handling layer in EMQX Broker**.
## Feature
@ -9,7 +9,7 @@ The `emqx_exproto` extremely enhance the extensibility for EMQ X. It allow using
## Architecture
![EMQ X ExProto Arch](./docs/images/exproto-arch.jpg)
![EMQX ExProto Arch](./docs/images/exproto-arch.jpg)
## Usage

4
apps/emqx_gateway/src/lwm2m/README.md
View File

@ -1,5 +1,5 @@
# LwM2M Gateway for the EMQ X Broker.
# LwM2M Gateway for the EMQX Broker.
[The LwM2M Specifications](http://www.openmobilealliance.org/release/LightweightM2M) is a Lightweight Machine to Machine protocol.
@ -354,4 +354,4 @@ Apache License Version 2.0
## Author
EMQ X-Men Team.
EMQX-Men Team.

4
apps/emqx_gateway/src/mqttsn/README.md
View File

@ -1,6 +1,6 @@
# MQTT-SN Gateway
EMQ X MQTT-SN Gateway.
EMQX MQTT-SN Gateway.
## Configure Plugin
@ -107,4 +107,4 @@ Apache License Version 2.0
## Author
EMQ X Team.
EMQX Team.

4
apps/emqx_gateway/src/stomp/README.md
View File

@ -2,7 +2,7 @@
# emqx-stomp
The plugin adds STOMP 1.0/1.1/1.2 protocol supports to the EMQ X broker.
The plugin adds STOMP 1.0/1.1/1.2 protocol supports to the EMQX broker.
The STOMP clients could PubSub to the MQTT clients.
@ -69,5 +69,5 @@ Apache License Version 2.0
## Author
EMQ X Team.
EMQX Team.

2
apps/emqx_management/README.md
View File

@ -1,7 +1,7 @@
# emqx-management
EMQ X Management API
EMQX Management API
## How to Design RESTful API?

6
apps/emqx_prometheus/README.md
View File

@ -1,6 +1,6 @@
# emqx-prometheus
EMQ X Prometheus Agent
EMQX Prometheus Agent
## push emqx stats/metrics to prometheus PushGateway
@ -48,7 +48,7 @@ json data
```
## Before EMQ X v4.0.0
## Before EMQX v4.0.0
The prometheus data simple is:
@ -279,5 +279,5 @@ Apache License Version 2.0
Author
------
EMQ X Team.
EMQX Team.

4
apps/emqx_retainer/README.md
View File

@ -1,5 +1,5 @@
EMQ X Retainer
EMQX Retainer
==============
The retainer plugin is responsible for storing retained MQTT messages.
@ -54,4 +54,4 @@ Apache License Version 2.0
Author
------
EMQ X Team
EMQX Team

2
apps/emqx_rule_engine/README.md
View File

@ -1,7 +1,7 @@
# emqx-rule-engine
IoT Rule Engine for EMQ X Broker.
IoT Rule Engine for EMQX Broker.
## Concept

4
deploy/charts/emqx/README.md
View File

@ -34,14 +34,14 @@ The following table lists the configurable parameters of the emqx chart and thei
| Parameter | Description | Default Value |
| --- | --- | --- |
| `replicaCount` | It is recommended to have odd number of nodes in a cluster, otherwise the emqx cluster cannot be automatically healed in case of net-split. |3|
| `image.repository` | EMQ X Image name |emqx/emqx|
| `image.repository` | EMQX Image name |emqx/emqx|
| `image.pullPolicy` | The image pull policy |IfNotPresent|
| `image.pullSecrets ` | The image pull secrets |`[]` (does not add image pull secrets to deployed pods)|
| `envFromSecret` | The name pull a secret in the same kubernetes namespace which contains values that will be added to the environment | nil |
| `recreatePods` | Forces the recreation of pods during upgrades, which can be useful to always apply the most recent configuration. | false |
| `persistence.enabled` | Enable EMQX persistence using PVC |false|
| `persistence.storageClass` | Storage class of backing PVC |`nil` (uses alpha storage class annotation)|
| `persistence.existingClaim` | EMQ X data Persistent Volume existing claim name, evaluated as a template |""|
| `persistence.existingClaim` | EMQX data Persistent Volume existing claim name, evaluated as a template |""|
| `persistence.accessMode` | PVC Access Mode for EMQX volume |ReadWriteOnce|
| `persistence.size` | PVC Storage Request for EMQX volume |20Mi|
| `initContainers` | Containers that run before the creation of EMQX containers. They can contain utilities or setup scripts. |`{}`|

20
deploy/docker/README.md
View File

@ -17,11 +17,11 @@
[the latest release](https://github.com/docker/docker-ce/releases/latest)
# What is EMQ X
# What is EMQX
[EMQ X MQTT broker](https://emqx.io/products/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.
[EMQX MQTT broker](https://emqx.io/products/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.
Starting from 3.0 release, *EMQX* 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 *EMQX* broker can scaled to 10+ million concurrent MQTT connections on one cluster.
# How to use this image
@ -39,7 +39,7 @@ The emqx broker runs as linux user `emqx` in the docker container.
### Configuration
Use the environment variable to configure the EMQ X docker container.
Use the environment variable to configure the EMQX docker container.
By default, the environment variables with ``EMQX_`` prefix are mapped to key-value pairs in configuration files.
@ -72,9 +72,9 @@ EMQX_HOST
These environment variables will ignore for configuration file.
#### EMQ X Configuration
#### EMQX Configuration
> NOTE: All EMQ X Configuration in [etc/emqx.conf](https://github.com/emqx/emqx/blob/master/etc/emqx.conf) could config by environment. The following list is just an example, not a complete configuration.
> NOTE: All EMQX Configuration in [etc/emqx.conf](https://github.com/emqx/emqx/blob/master/etc/emqx.conf) could config by environment. The following list is just an example, not a complete configuration.
| Options | Default | Mapped | Description |
| ---------------------------| ------------------ | ------------------------- | ------------------------------------- |
@ -147,7 +147,7 @@ EMQX_LOADED_PLUGINS="emqx_retainer emqx_rule_engine"
EMQX_LOADED_PLUGINS="emqx_retainer | emqx_rule_engine"
```
#### EMQ X Plugins Configuration
#### EMQX Plugins Configuration
The environment variables which with ``EMQX_`` prefix are mapped to all emqx plugins' configuration file, ``.`` get replaced by ``__``.
@ -198,7 +198,7 @@ docker run -d --name emqx -p 18083:18083 -p 1883:1883 -p 4369:4369 \
### Cluster
EMQ X supports a variety of clustering methods, see our [documentation](https://docs.emqx.io/broker/latest/en/advanced/cluster.html#emqx-service-discovery) for details.
EMQX supports a variety of clustering methods, see our [documentation](https://docs.emqx.io/broker/latest/en/advanced/cluster.html#emqx-service-discovery) for details.
Let's create a static node list cluster from docker-compose.
@ -254,7 +254,7 @@ Let's create a static node list cluster from docker-compose.
### Persistence
If you want to persist the EMQ X docker container, you need to keep the following directories:
If you want to persist the EMQX docker container, you need to keep the following directories:
+ `/opt/emqx/data`
+ `/opt/emqx/etc`
@ -314,7 +314,7 @@ docker run -d --name emqx -p 18083:18083 -p 1883:1883 -p 4369:4369 \
```
> REMEMBER: DO NOT RUN EMQ X DOCKER PRIVILEGED OR MOUNT SYSTEM PROC IN CONTAINER TO TUNE LINUX KERNEL, IT IS UNSAFE.
> REMEMBER: DO NOT RUN EMQX DOCKER PRIVILEGED OR MOUNT SYSTEM PROC IN CONTAINER TO TUNE LINUX KERNEL, IT IS UNSAFE.
### Thanks

2
lib-ee/emqx_enterprise_conf/README.md
View File

@ -1,3 +1,3 @@
# emqx_enterprise_conf
EMQ X Enterprise configuration schema
EMQX Enterprise configuration schema

2
lib-ee/emqx_license/README.md
View File

@ -1,3 +1,3 @@
# emqx_license
EMQ X 5.0 License Manager.
EMQX 5.0 License Manager.