From 3ed14fbfee0fa5060ad1e2fb711ac126a66e4eaa Mon Sep 17 00:00:00 2001 From: Ivan Dyachkov Date: Thu, 22 Dec 2022 17:37:49 +0100 Subject: [PATCH 1/2] docs: update readme - remove info about unixodbc, it's relevent for enterprise only atm - remove references to 4.3 - update info about supported OTP versions --- README-RU.md | 23 ++--------------------- README.md | 25 ++----------------------- 2 files changed, 4 insertions(+), 44 deletions(-) diff --git a/README-RU.md b/README-RU.md index 76b1f0ae0..1af820ef9 100644 --- a/README-RU.md +++ b/README-RU.md @@ -82,9 +82,9 @@ docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p ## Сборка из исходного кода -Ветка `master` предназначена для последней версии 5, переключитесь на ветку `main-v4.3` для версии 4.3 и `main-v4.4` для версии 4.4. +Ветка `master` предназначена для последней версии 5, переключитесь на ветку `main-v4.4` для версии 4.4. -EMQX требует OTP 22 или 23 для версии 4.3 и OTP 24 для версий 4.4 и 5.0. +EMQX требует OTP 24 для версии 4.4. Версию 5.0 можно собирать с OTP 24 или 25. ```bash git clone https://github.com/emqx/emqx.git @@ -102,25 +102,6 @@ make _build/emqx/rel/emqx/bin/emqx console ``` -### Сборка на Apple silicon (M1, M2) - -Пакетный менеджер Homebrew, когда установлен на Apple silicon, [стал использовать другую домашнюю папку по умолчанию](https://github.com/Homebrew/brew/issues/9177), `/opt/homebrew` вместо `/usr/local`. В результате некоторые библиотеки перестали собираться автоматически. - -Касательно EMQX, сборка Erlang из исходного кода не найдёт библиотеку `unixodbc`, установленную с homebrew, без дополнительных действий: - -```bash -brew install unixodbc kerl -sudo ln -s $(realpath $(brew --prefix unixodbc)) /usr/local/odbc -export CC="/usr/bin/gcc -I$(brew --prefix unixodbc)/include" -export LDFLAGS="-L$(brew --prefix unixodbc)/lib" -kerl build 24.3 -mkdir ~/.kerl/installations -kerl install 24.3 ~/.kerl/installations/24.3 -. ~/.kerl/installations/24.3/activate -``` - -Дальше можно собирать emqx как обычно, с помощью `make`. - ## Лицензия см. [LICENSE](./LICENSE). diff --git a/README.md b/README.md index 56175e68a..44e33ba05 100644 --- a/README.md +++ b/README.md @@ -86,9 +86,9 @@ For more organised improvement proposals, you can send pull requests to [EIP](ht ## 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. +The `master` branch is for the latest version 5 release, checkout `main-v4.4` for version 4.4. -EMQX requires OTP 22 or 23 for version 4.3, and OTP 24 for 4.4 and 5.0. +EMQX requires OTP 24 for 4.4, 5.0 can be built with OTP 24 or 25. ```bash git clone https://github.com/emqx/emqx.git @@ -106,27 +106,6 @@ make _build/emqx/rel/emqx/bin/emqx console ``` -### Building on Apple silicon (M1, M2) - -Homebrew on Apple silicon [changed default location of it's home directory](https://github.com/Homebrew/brew/issues/9177) from `/usr/local` to `/opt/homebrew` and as a result a few things broke in the process. - -Concerning EMQX, when you install `unixodbc` package (one of the dependencies) via Homebrew, and build Erlang/OTP with [kerl](https://github.com/kerl/kerl), kerl will not be able to find `unixodbc`. - -Here is how to solve it: - -```bash -brew install unixodbc kerl -sudo ln -s $(realpath $(brew --prefix unixodbc)) /usr/local/odbc -export CC="/usr/bin/gcc -I$(brew --prefix unixodbc)/include" -export LDFLAGS="-L$(brew --prefix unixodbc)/lib" -kerl build 24.3 -mkdir ~/.kerl/installations -kerl install 24.3 ~/.kerl/installations/24.3 -. ~/.kerl/installations/24.3/activate -``` - -Then you can proceed with `make`. - ## License See [LICENSE](./LICENSE). From d70a6ec4770a3a760196267652c52ca75746b042 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Fri, 23 Dec 2022 09:21:49 +0100 Subject: [PATCH 2/2] docs: update README with Erlang/OTP requirements --- README-CN.md | 25 +--------- README-JP.md | 133 --------------------------------------------------- 2 files changed, 2 insertions(+), 156 deletions(-) delete mode 100644 README-JP.md diff --git a/README-CN.md b/README-CN.md index ea584c66a..22e4bf1b0 100644 --- a/README-CN.md +++ b/README-CN.md @@ -86,9 +86,9 @@ EMQX Cloud 文档：[docs.emqx.com/zh/cloud/latest/](https://docs.emqx.com/zh/cl ## 从源码构建 -`master` 分支是最新的 5 版本，`main-v4.3` 分支是 4.3 版本，`main-v4.4` 是 4.4 版本。 +`master` 分支是最新的 5 版本，`main-v4.4` 是 4.4 版本。 -EMQX 的 4.3 版本需要 OTP 22 或 23，4.4 和 5.0 版本需要 OTP 24。 +EMQX 4.4 版本需要 OTP 24；5 版本则可以使用 OTP 24 和 25 构建。 ```bash git clone https://github.com/emqx/emqx.git @@ -106,27 +106,6 @@ make _build/emqx/rel/emqx/bin/emqx console ``` -### 在 Apple 芯片（M1,M2）上编译 - -基于 Apple 芯片的 Homebrew 将[默认的 home 目录](https://github.com/Homebrew/brew/issues/9177)从 `/usr/local` 改成了 `/opt/homebrew`，这个改变导致了一些兼容性问题。 - -具体到 EMQX 来说，主要影响的是 `unixodbc`，如果使用 Homebrew 安装的 `unixodbc` 包，那么在使用 [kerl](https://github.com/kerl/kerl) 编译 Erlang/OTP 的时候，kerl 会找不到 `unixodbc`。 - -解决此问题的方法如下: - -```bash -brew install unixodbc kerl -sudo ln -s $(realpath $(brew --prefix unixodbc)) /usr/local/odbc -export CC="/usr/bin/gcc -I$(brew --prefix unixodbc)/include" -export LDFLAGS="-L$(brew --prefix unixodbc)/lib" -kerl build 24.3 -mkdir ~/.kerl/installations -kerl install 24.3 ~/.kerl/installations/24.3 -. ~/.kerl/installations/24.3/activate -``` - -然后再使用 `make` 继续编译就可以了。 - ## 开源许可 详见 [LICENSE](./LICENSE)。 diff --git a/README-JP.md b/README-JP.md deleted file mode 100644 index bf0fc9188..000000000 --- a/README-JP.md +++ /dev/null @@ -1,133 +0,0 @@ -# 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) -[![Coverage Status](https://img.shields.io/coveralls/github/emqx/emqx/master?label=Coverage)](https://coveralls.io/github/emqx/emqx?branch=master) -[![Docker Pulls](https://img.shields.io/docker/pulls/emqx/emqx?label=Docker%20Pulls)](https://hub.docker.com/r/emqx/emqx) -[![Slack](https://img.shields.io/badge/Slack-EMQ-39AE85?logo=slack)](https://slack-invite.emqx.io/) -[![Discord](https://img.shields.io/discord/931086341838622751?label=Discord&logo=discord)](https://discord.gg/xYGf3fQnES) -[![Twitter](https://img.shields.io/badge/Twitter-EMQ-1DA1F2?logo=twitter)](https://twitter.com/EMQTech) -[![YouTube](https://img.shields.io/badge/Subscribe-EMQ-FF0000?logo=youtube)](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) - -[![The best IoT MQTT open source team looks forward to your joining](https://assets.emqx.com/images/github_readme_en_bg.png)](https://www.emqx.com/en/careers) - -[English](./README.md) | [简体中文](./README-CN.md) | 日本語 | [русский](./README-RU.md) - -*EMQX* は、高い拡張性と可用性をもつ、分散型のMQTTブローカーです。数千万のクライアントを同時に処理するIoT、M2M、モバイルアプリケーション向けです。 - -version 3.0 以降、*EMQX* は MQTT V5.0 の仕様を完全にサポートしており、MQTT V3.1およびV3.1.1とも下位互換性があります。 -MQTT-SN、CoAP、LwM2M、WebSocket、STOMPなどの通信プロトコルをサポートしています。 MQTTの同時接続数は1つのクラスター上で1,000万以上にまでスケールできます。 - -- 新機能の一覧については、[EMQXリリースノート](https://github.com/emqx/emqx/releases)を参照してください。 -- 詳細はこちら[EMQX公式ウェブサイト](https://www.emqx.io/)をご覧ください。 - -## インストール - -*EMQX* はクロスプラットフォームで、Linux、Unix、macOS、Windowsをサポートしています。 -そのため、x86_64アーキテクチャサーバー、またはRaspberryPiなどのARMデバイスに *EMQX* をデプロイすることもできます。 - -Windows上における *EMQX* のビルドと実行については、[Windows.md](./Windows.md)をご参照ください。 - -#### Docker イメージによる EMQX のインストール - -``` -docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx -``` - -#### バイナリパッケージによるインストール - -それぞれのOSに対応したバイナリソフトウェアパッケージは、[EMQXのダウンロード](https://www.emqx.com/en/downloads)ページから取得できます。 - -- [シングルノードインストール](https://www.emqx.io/docs/en/latest/getting-started/install.html) -- [マルチノードインストール](https://www.emqx.io/docs/en/latest/advanced/cluster.html) - -## ソースからビルド - -version 3.0 以降の *EMQX* をビルドするには Erlang/OTP R21+ が必要です。 - -version 4.3 以降の場合： - -```bash -git clone https://github.com/emqx/emqx-rel.git -cd emqx-rel -make -_build/emqx/rel/emqx/bin/emqx console -``` - -## クイックスタート - -emqx をソースコードからビルドした場合は、 -`cd _build/emqx/rel/emqx`でリリースビルドのディレクトリに移動してください。 - -リリースパッケージからインストールした場合は、インストール先のルートディレクトリに移動してください。 - -``` -# Start emqx -./bin/emqx start - -# Check Status -./bin/emqx_ctl status - -# Stop emqx -./bin/emqx stop -``` - -*EMQX* の起動後、ブラウザで http://localhost:18083 にアクセスするとダッシュボードが表示されます。 - -## テスト - -### 全てのテストケースを実行する - -``` -make eunit ct -``` - -### common test の一部を実行する - -```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/en/latest/faq/faq.html)をご確認ください。 - -### 質問する - -質問や知識共有の場として[GitHub Discussions](https://github.com/emqx/emqx/discussions)を用意しています。 - -### 提案 - -大規模な改善のご提案がある場合は、[EIP](https://github.com/emqx/eip)にPRをどうぞ。 - -### 自作プラグイン - -プラグインを自作することができます。[PLUGIN.md](./PLUGIN.md) をご確認ください。 - - -## 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 - -See [LICENSE](./LICENSE).