MQTT Broker

The MQTT Broker settings configure the Intelligence Hub’s built-in MQTT broker, including authentication and endpoint configuration.

MQTT Broker Settings

SettingJSON PropertyDescription
Enabledsettings.hbMqttBroker.enabledEnables the Intelligence Hub MQTT Broker.
Allow Anonymoussettings.hbMqttBroker.allowAnonymousWhen false MQTT clients are required to specify a username and password to authenticate with the broker. In order for a user to access the broker the following claims are required:
  • broker:subscribe: Allows the MQTT client subscribe access to all topics.
  • broker:publish: Allows the MQTT client publish access to all topics.
  • broker:*: Allows the MQTT client subscribe and publish access to all topics.

The default administrator user is not supported. See Create a User for details on creating a user with broker access.
Endpointssettings.hbMqttBroker.endpointsAn array of one or more endpoints hosted by the broker. The endpoints have the following settings.
Hostnamesettings.hbMqttBroker.endpoints[].hostnameThe hostname the endpoint binds to. By default this is 0.0.0.0, which binds to all endpoints.
Portsettings.hbMqttBroker.endpoints[].portThe port the endpoint binds to. By default this is 1885.
Use SSLsettings.hbMqttBroker.endpoints[].useSSLEnables secure communication (SSL) for the endpoint.
Certificate Key Aliassettings.hbMqttBroker.endpoints[].certificateKeyAliasWhen SSL is enabled, this specifies the alias name for the key in the keystore to use for encryption. The public key must be trusted by the MQTT client.
Protocolsettings.hbMqttBroker.endpoints[].protocolThe protocol used by the endpoint. The following options are available.
  • mqtt.tcp – TCP connection
  • mqtt.ws – Websocket connection