EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

ダッシュボードの設定 ​

EMQXダッシュボードは、EMQXおよび接続されたデバイスのリアルタイム管理と監視を可能にするWebベースのグラフィカルインターフェースです。

EMQXダッシュボードの設定には多数の設定項目があります。例えば、swagger_support設定を有効にしてAPI仕様エンドポイントを利用可能にしたり、EMQXダッシュボードのリスナーを設定してすべての着信接続を受け入れることができます。さらに、以下の一般的な設定項目も利用可能です：

  • listeners
  • token_expired_time
  • password_expired_time
  • password_login
  • hwmark_expire_time
  • cors
  • default_password
  • unsuccessful_login_max_attempts
  • unsuccessful_login_duration
  • unsuccessful_login_interval
  • sso

以下はダッシュボード設定のサンプルです：

json
dashboard {
  listeners {
    http {
      # 'bind = 0' に設定するとこのリスナーは無効になります
      bind = "0.0.0.0:18083"
      max_connections = 512
    }
    https {
      # 'bind = 0' に設定するとこのリスナーは無効になります
      bind = "0.0.0.0:18084"
      ssl_options {
        certfile = "${EMQX_ETC_DIR}/certs/cert.pem"
        keyfile = "${EMQX_ETC_DIR}/certs/key.pem"
      }
    }
  }
  token_expired_time = 60m
  password_expired_time = 0
  password_login = both
  cors = false
  swagger_support = true
  default_password = jEdOgGS6vzQ
  unsuccessful_login_max_attempts = 5
  unsuccessful_login_lock_duration = 10m
  unsuccessful_login_interval = 5m
  sso = {
    # 通常、`ldap`、`oidc`、`saml`のうち一つのみが有効になります。以下は説明用の例です。
    ldap = {
      enable = true
      backend = "ldap"
      query_timeout = "5s"
      server = "localhost:389"
      pool_size = 8
      username = "cn=admin,dc=example,dc=com"
      password = "secret"
      base_dn = "dc=example,dc=com"
      filter = "(& (objectClass=person) (uid=${username}))"
      request_timeout = "10s"
    }
    oidc = {
      enable = true
      backend = oidc
      issuer = "https://issuer.example.com"
      clientid = "your-client-id"
      secret = "your-client-secret"
      scopes = [
        "openid"
      ]
      name_var = "${sub}"
      dashboard_addr = "http://127.0.0.1:18083"
      session_expiry = "30s"
      require_pkce = false
      preferred_auth_methods = [
        "client_secret_post",
        "client_secret_basic",
        "none"
      ]
      provider = generic
      fallback_methods = [
        "RS256"
      ]
    }
    saml = {
      enable = true
      backend = "saml"
      dashboard_addr = "https://127.0.0.1:18083"
      idp_metadata_url = "https://idp.example.com"
      sp_sign_request = false
      sp_public_key = "Pub Key"
      sp_private_key = "SP Private Key"
    }
  }
}

各項目の説明は以下の通りです。

  • bind = "0.0.0.0:18083"

    リスナーがバインドするIPアドレスとポート番号です。この例では、リスナーはすべての利用可能なネットワークインターフェース（0.0.0.0）のポート18083にバインドします。ポート番号を0に設定すると、このリスナーは無効になります。

    EMQX 6.3.0以降では、dashboard.listeners.http.bindにポート番号のみ（例：18083）を指定した場合、EMQXはnode.default_listener_addressを使用して各ノードのアドレスを選択します。この設定がない場合、HTTPリスナーはlegacyセキュリティプロファイルではすべてのネットワークインターフェースにバインドし、hardenedではループバックにバインドします。上記の例のようにbindに明示的なIPアドレスが指定されている場合はそれが優先されます。

    このデフォルトアドレス設定はダッシュボードのHTTPSリスナーには適用されません。対応する値、再起動要件、DockerのデフォルトについてはDefault Listener Addressを参照してください。

  • max_connections = 512

    リスナーが受け入れる最大同時接続数です。この例では最大接続数は512に設定されています。

  • ssl_options.certfile

    PEM形式の証明書チェーンファイルのパスです。サーバー証明書を最初に、その発行者の証明書、さらにその上位発行者の証明書と続きます。ルートCA証明書は任意です。パスのプレフィックス（先頭部分）のみ環境変数を使用可能です。

  • ssl_options.keyfile

    PEM形式の秘密鍵ファイルのパスです。

  • token_expired_time

    JWTトークンの有効期限です。ブラウザセッションの有効期限に相当します。ユーザーがログインすると、EMQXはJWTトークンとリフレッシュトークンを生成します。セッションは有効期限前に自動更新されます。デフォルト値は60mです。

  • hwmark_expire_time

    最高ウォーターマークの有効期限の時間窓です。デフォルト値は7dです。有効期限切れ後、ダッシュボードは有効期限時刻から現在までの間で新しい最高ウォーターマークを検索します。

  • password_expired_time

    ダッシュボードログインに使用するユーザーのパスワードの有効期限を設定します（例：1h）。この時間を過ぎると、ユーザーはダッシュボードにログインする際にパスワードの変更が必要になります。デフォルト値0はパスワードが期限切れにならないことを意味します。

  • password_login

    EMQX 6.3.1以降、このオプションはローカルダッシュボードユーザーの認証方法を制御します。サポートされる値は以下の通りです：

    • both: SCRAM-SHA-256チャレンジレスポンスログインとパスワードベースのPOST /api/v5/loginリクエストの両方を受け入れます。これはデフォルト値であり、リクエストボディにパスワードを送信するスクリプトやクライアントとの互換性を維持します。
    • scram_only: SCRAM-SHA-256チャレンジレスポンスログインのみを受け入れます。このモードでは、POST /api/v5/loginはHTTP 403を返し、エラーコードPASSWORD_LOGIN_DISABLEDとなります。ローカルダッシュボードユーザー資格情報でベアラートークンを取得するスクリプトやサードパーティクライアントはSCRAMエンドポイントを使用する必要があります。EMQX管理REST APIのみを呼び出すプログラムはAPIキーを使用できます。

    このオプションをscram_onlyに設定する前に、ローカルダッシュボードユーザー資格情報でサインインするすべてのEMQXノードとクライアントをSCRAMをサポートするバージョンにアップグレードしてください。パスワード移行、ブラウザアクセス、ログイン方法についてはローカルダッシュボードユーザーの認証方法の設定を参照してください。

  • cors

    クロスオリジンリソースシェアリング（CORS）をサポートします。ダッシュボードAPIを他ドメイン（例：カスタムフロントエンド）からアクセス可能にしたい場合は、これをtrueに設定します。

  • swagger_support = true

    /api-spec.html、/api-spec.md、/api-spec.json、および完全なOpenAPI仕様の/api-docs/swagger.jsonを含むAPIドキュメントエンドポイントを有効にします。後方互換性のため、/api-docsおよび/api-docs/index.htmlは/api-spec.htmlにリダイレクトされます。このオプションをfalseに設定するとすべてのAPIドキュメントエンドポイントが無効になります。

    EMQX 6.3.0以降、これらのエンドポイントを通じたAPI仕様コンテンツへのアクセスには認証が必要です。サポートされる認証方法および認証なしの応答動作についてはAPI仕様エンドポイントへのアクセスを参照してください。

  • default_password

    adminユーザーのデータベースレコードを初期化する際に使用されるパスワードです。注意：EMQXが初回起動後にこの設定を変更しても効果はありません。初期化後は、インストール時に付属するデフォルトパスワードpublicをダッシュボードまたはCLIから変更する必要があります。

  • unsuccessful_login_max_attempts

    一定期間内に許容される最大のログイン失敗回数を指定します。この制限を超えると、アカウントは一時的にロックされます。デフォルト値は5です。

  • unsuccessful_login_duration

    最大ログイン失敗回数に達した後、アカウントがロックされる期間（分単位）を設定します。デフォルト値は10分です。

  • unsuccessful_login_interval

    ログイン失敗回数をカウントする時間窓を定義します。例えば5に設定すると、5分間の間に失敗したログイン回数を追跡します。デフォルト値は5分です。

  • sso

    シングルサインオン（SSO）の設定を行います。ldap、oidc、samlのうち一つのみが同時に有効にできます。詳細な設定説明は設定マニュアルのSSOセクションを参照してください。

TIP

EMQXはよりカスタマイズされたニーズに対応するために多くの設定項目を提供しています。詳細はEMQX Enterprise設定マニュアルをご覧ください。