Control Center Configuration
The HiveMQ Control Center works out of the box without any additional installation or configuration. However, we highly recommend that you fine-tune your control center configuration to match your individual use case.
The following information shows you how to enable access to the HiveMQ Control Center and how to securely configure this access.
The default login has the name admin and the password hivemq. This login only is active, if no custom user is configured.
|Please manually configure a user, if you configured the HiveMQ Control Center to listen on a public network interface.|
The HiveMQ Control Center can be configured with multiple users.
The users are configured inside the
<users> tag. Each user is configured inside a
<user> tag therein.
<?xml version="1.0"?> <hivemq xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> ... <control-center> ... <users> <user> <name>yourUserName</name> <password>yourPassword</password> </user> </users> ... </control-center> ... </hivemq>
The name of the user.
The password of the user as a SHA256 hash without iterations and with the user name as prepended salt. See Generate SHA256 Password, here
This is the default configuration:
SHA256 of adminhivemq = a68fc32fc49fc4d04c63724a1f6d0c90442209c46dba6975774cde5e5149caf8
On Linux or OS X based system, generating a correctly salted and hashed password can be easily achieved via the use of the command line.
First choose a username and a password in plain text.
Then type the following into your command line.
echo -n testabc123 | shasum -a 256
echo -n testabc123 | sha256sum
The resulting prompt will look like the following.
Then configure your user in the
<?xml version="1.0"?> <hivemq xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> ... <control-center> ... <users> <user> <name>test</name> <password>9e2ee742214c2940b9e21149d4e1749d98d8d74e2b0f7453d190b1a7d73308b9</password> </user> </users> ... </control-center> ... </hivemq>
The automatic default user that is used when no custom user is specified, can be disabled for security reasons.
<default-user-enabled> configuration defines if the default user is enabled or disabled.
<?xml version="1.0"?> <hivemq xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> ... <control-center> ... <default-user-enabled>false</default-user-enabled> ... </control-center> ... </hivemq>
The HiveMQ Enterprise Edition supports Role Based Access Control (RBAC) for Control Center users. RBAC allows you to restrict user permissions and precisely control which users can view, access, and modify data. Use RBAC to create fine-grained access management for your HiveMQ system.
In environments with multiple administrators, legal reasons can require you to disable Control Center functionality for some or all users. For example, prevent the display of IP addresses. The HiveMQ Enterprise Edition allows you to restrict user access according to corporate compliance policies while providing best-in class monitoring and debug capabilities for production environments.
To support RBAC functionality for the Control Center, the HiveMQ Enterprise Security Extension enables the use of permissions that are stored in data sources such as SQL databases.
The HiveMQ Control Center is accessible via the use of a web browser. In order to allow that access HiveMQ opens up an
HTTP or HTTPS listener.
Similar to other HiveMQ Listener Configuration Options, the regular configuration is complete by providing a port and bind address.
The configuration of a secure, TLS encrypted listener additionally requires
<tls> configuration options.
|Read this chapter when planning on using the HiveMQ Control Center with a load balancer.|
By default, HiveMQ opens the HTTP listener on port 8080 and binds it to the local interface on
If you want the Control Center to be externally reachable, you can bind the listener to another interface. If you use port 8080 for other purposes, it is also possible to change the listener port.
<?xml version="1.0"?> <hivemq> ... <control-center> <enabled>true</enabled> <listeners> <http> <port>8080</port> <bind-address>localhost</bind-address> </http> </listeners> ... </control-center> ... </hivemq>
|For local testing purposes, no configuration of the HiveMQ Control Center is necessary. It will be reachable at http://localhost:8080, using the default user credentials.|
HiveMQ offers the possibility to use a secure, TLS encrypted HTTPS listener for connection establishment with the Control Center. In case TLS encryption is a requirement you have to meet, configure an HTTPS listeners as listed below.
<?xml version="1.0"?> <hivemq> ... <control-center> <enabled>true</enabled> <listeners> <https> <port>8443</port> <bind-address>0.0.0.0</bind-address> <tls> <keystore> <path>/path/to/key/store/store.jks</path> <password>changeme</password> <private-key-password>changeme</private-key-password> </keystore> </tls> </https> </listeners> ... </control-center> ... </hivemq>
To simplify the analysis and monitoring of your MQTT client behavior, HiveMQ provides access to the event history of each client. The detailed event history can provide valuable insights into the performance of your system. For example, to review the effect of overload protection on client connection or diagnose client behavior during topology changes. It is also possible to access the events in the client history through an extension API to trigger event-based actions or export event data to a third-party-system for futher analysis.
By default, the client event history is enabled and records the previous seven days of events for each client. You can adjust the time period as desired to suit your use case.
<?xml version="1.0"?> <hivemq> ... <control-center> ... <client-event-history> <enabled>true</enabled> <lifetime>604800</lifetime> <!-- 7 days --> </client-event-history> ... </control-center> ... </hivemq>
For more information, see Event History.