インストールとマイグレーション
本章では、EMQXの基本的なインストール手順、最低限のハードウェア仕様、および将来の設定やメンテナンス作業を容易にするためのファイルおよびディレクトリの場所について説明します。また、EMQX Enterpriseのライセンス設定方法とEMQX 4.4からEMQX 5.1へのマイグレーション方法についても解説します。
対応オペレーティングシステム
以下の表は、EMQXがサポートするオペレーティングシステムとそのバージョンを示しています。
| オペレーティングシステム | サポートされているバージョン | x86_64/amd64 | arm64 |
|---|---|---|---|
| Ubuntu | Ubuntu 22.04 Ubuntu 24.04 | Yes | Yes |
| Debian | Debian 11 Debian 12 Debian 13 | Yes | Yes |
| CentOS/RHEL | Rocky Linux 8 Rocky Linux 9 | Yes | Yes |
| Amazon Linux | Amazon Linux 2023 | Yes | Yes |
| macOS 14+ | macOS 14 macOS 15 | No | Yes |
インストール環境
EMQXを動作させるErlang VMは、ファイル名や対話型Erlangシェルの端末IOなどの機能におけるUnicodeサポートを有効にするために、システムのロケール設定に依存しています。
Linux OSを使用する場合は、EMQXを起動する前にシステム環境でUTF-8ロケールが有効になっていることを確認することを推奨します。以下のタブから各プラットフォームでのUTF-8ロケールの有効化方法をご覧ください。
ポートの使用状況
EMQXはデフォルトで以下のポートを使用します。これらのポートが他のアプリケーションによって使用されていないことを確認し、必要に応じてファイアウォールを開放してEMQXが正常に動作するようにしてください。
| ポート | プロトコル | 説明 |
|---|---|---|
| 1883 | TCP | TCP上のMQTTリスナーポート。主に暗号化されていないMQTT接続に使用されます。 |
| 8883 | TCP | SSL/TLS上のMQTTリスナーポート。暗号化されたMQTT接続に使用されます。 |
| 8083 | TCP | WebSocket上のMQTTリスナーポート。WebSocket経由のMQTT通信に使用されます。 |
| 8084 | TCP | WSS（SSL上のWebSocket）リスナーポート。暗号化されたWebSocket接続に使用されます。 |
| 18083 | HTTP | EMQXダッシュボードおよびREST APIの管理コンソールとAPIインターフェース用ポート。 |
| 4370 | TCP | Erlang分散ポート。実際のポートはノード名に応じてBasePort (4370) + Offsetとなります。 |
| 5370 | TCP | クラスターRPCポート（Docker環境では5369）。実際のポートはノード名に応じてBasePort (5370) + Offsetとなります。 |
注意
クラスターを形成していなくても、EMQXはポート4370および5370をリッスンします。これらの2つのポートは固定で変更できません。Offsetはノード名のName部分（Name@Host）の数値サフィックスによって決まります。数値サフィックスがない場合はデフォルトで0となります。詳細はポートマッピングを参照してください。
ファイルとディレクトリ
インストール後、EMQXは実行ファイルや設定ファイル、データ、ログを格納するためのいくつかのディレクトリを作成します。以下の表は、インストール方法ごとに作成されるディレクトリとそのパスを示しています。
| ディレクトリ | 説明 | tar.gzでインストールした場合 | RPM/DEBでインストールした場合 |
|---|---|---|---|
etc | 静的設定ファイル | ./etc | /etc/emqx |
data | データベースおよび設定 | ./data | /var/lib/emqx |
log | ログファイル | ./log | /var/log/emqx |
releases | 起動指示ファイル | ./releases | /usr/lib/emqx/releases |
bin | 実行ファイル | ./bin | /usr/lib/emqx/bin |
lib | Erlangコード | ./lib | /usr/lib/emqx/lib |
erts-* | Erlangランタイム | ./erts-* | /usr/lib/emqx/erts-* |
plugins | プラグイン | ./plugins | /usr/lib/emqx/plugins |
TIP
- 圧縮パッケージでインストールした場合、ディレクトリはソフトウェアをインストールしたディレクトリを基準とした相対パスです。
- Dockerコンテナでインストールした場合、EMQXは
/opt/emqxディレクトリにインストールされます。 data、log、pluginsディレクトリは設定ファイルで変更可能です。パフォーマンス向上のため、dataディレクトリは高速ディスクにマウントすることを推奨します。同一クラスターに属するノードでは、dataディレクトリの設定を統一してください。クラスターの詳細はクラスターを参照してください。
以下の表は、一部ディレクトリのファイルやサブフォルダの説明です。
| ディレクトリ | 説明 | 権限 | ファイル |
|---|---|---|---|
| bin | 実行ファイル | 読み取り | emqx および emqx.cmd: EMQXの実行ファイル。詳細はコマンドラインインターフェースを参照してください。 |
| etc | 設定ファイル | 読み取り | base.hocon: ランタイム設定変更で上書き可能なベース設定。emqx.conf: 上書き不可の静的設定。emqx-example-en.conf: EMQXの全設定項目を含むデモ設定ファイル。acl.conf: デフォルトのACLルール。vm.args: Erlang仮想マシンの動作パラメータ。certs/: EMQXのSSLリスナー用X.509鍵および証明書ファイル。外部システムとのSSL/TLS接続時にも使用される場合があります。 |
| data | 運用データ | 書き込み | authz: REST APIまたはダッシュボードからアップロードされたファイル認可ルールを格納します。詳細は認可 - ファイルを参照してください。certs: REST APIまたはダッシュボードからアップロードされた証明書ファイルを格納します。configs: 起動時に生成された設定ファイルやAPI・CLIからの設定上書きを格納します。mnesia: EMQXの運用データを格納する組み込みデータベースで、アラーム記録、クライアントの認証・認可情報、ダッシュボードユーザー情報などを含みます。このディレクトリを削除すると、これらの運用データはすべて失われます。— ノードごとに名前を付けたサブディレクトリ（例： emqx@127.0.0.1）を含む場合があります。ノード名変更時は対応するサブディレクトリも削除または移動してください。— 組み込みデータベースの照会には emqx ctl mnesiaコマンドを使用します。詳細は管理コマンドCLIを参照してください。patches: EMQXがホットパッチとしてロードする.beamファイルを格納します。迅速な修正に使用可能です。trace: オンライントレースログファイル。本番環境では、データの安全性確保のため、 traceフォルダを除くdataディレクトリの定期的なバックアップを推奨します。 |
| log | 運用ログ | 読み取り | emqx.log.*: EMQXの運用ログ。詳細はログを参照してください。 |
TIP
EMQXは設定情報をdata/configsおよびetcディレクトリに保存します。etcディレクトリは読み取り専用の設定ファイルを格納し、ダッシュボードやREST APIからの設定更新はdata/configsに保存され、ランタイムでのホットリロードをサポートします。
etc/base.hocon: ランタイム設定変更で上書き可能なベース設定。etc/emqx.conf: 上書き不可の静的設定。data/configs/cluster.hocon: ランタイム設定の上書き。
EMQXはこれらのファイルから設定項目を読み込み、Erlangネイティブの設定ファイル形式に変換してランタイムに適用します。