EMQX Dashboard is a comprehensive web interface for managing and monitoring EMQX. This intuitive tool allows users to effortlessly oversee EMQX clusters, customize features, and display data visually.
-
Data Monitoring & Management: Get a comprehensive overview of crucial data.
-
Visual Access Control Management: Pre-configured authentication and authorization.
-
Robust Data Integration Capabilities: Includes a flow editor and bi-directional data bridge.
-
Real-time Configuration Updates: Hot updates with instant configuration saving.
-
Customizable Extension Capabilities: Built-in gateways, plugins, and hooks.
-
Comprehensive Diagnostic Tools: Enables timely problem identification and resolution.
First, ensure that the latest version of EMQX is installed.
Post successful installation, access the EMQX Dashboard by opening http://localhost:18083/ in your browser (replace localhost with the actual IP if not on local machine). By default, the EMQX Dashboard listens on port 18083.
EMQX can operate without the Dashboard. The Dashboard provides a convenient visual interface for users.
-
To report issues or contribute code, see our contributing guide.
-
Stay updated with the latest news by following @EMQTech on Twitter.
-
Have a question? Check our discussion forums.
-
Join our official Discord for general discussions.
-
Subscribe to our EMQX YouTube channel for video resources.
-
Learn MQTT in PHP, Node.js, Python, Golang, and more with this collection of blog posts.
-
Browse popular MQTT client SDKs in various programming languages, complemented with code examples.
-
A versatile cross-platform MQTT 5.0 client tool offering desktop, command-line, and web interfaces.
-
Build a reliable, efficient, and industry-specific IoV platform leveraging EMQ's practical experience.
To set up for local development, follow these steps:
-
Fork the repository and clone your fork:
git clone https://github.com/your-username/emqx-dashboard5.git cd emqx-dashboard5Or, clone the original repository directly:
git clone https://github.com/emqx/emqx-dashboard5.git cd emqx-dashboard5 -
Install the dependencies:
pnpm install
-
To start the development server, run:
pnpm dev
-
For production compilation and minification:
pnpm build
-
Lint and fix files:
pnpm lint
Or, format the code with Prettier:
pnpm format
To set up for development with a cloud host:
-
Create a new
.env.development.localfile:touch .env.development.local
-
Define your cloud host address in the
.env.development.localfile:HOST_URL=http://your-cloud-host:port/
-
Start the development server:
pnpm serve
Refer to the Configuring Vite for more information.
After the completion of setup, the CI will run automatically and deploy upon successful execution.
EMQX Dashboard is licensed under the
Business Source License 1.1 (BUSL-1.1). This is a source-available
license. Each Dashboard version transitions to Apache License, Version 2.0
four years after that version's first publicly available distribution under BSL.
The date is calculated separately for each version, including patch releases,
across all maintained release series. Republishing the same version does not
restart the four-year period.
Use the Dashboard release tag and its first public distribution records to
identify the version and its publication date, rather than relying solely on
package.json. The conversion date is independent of Broker versions and their
release dates; connecting to a different Broker does not change it. Conversion
of a Dashboard version does not change the license applicable to the Broker.
Both standard and enterprise builds include the complete LICENSE in dist/
and their release archives.
The Dashboard is used in conjunction with the EMQX broker. The Additional Use Grant permits production use of the Dashboard to manage and monitor the broker when the corresponding broker use is permitted under its applicable license, including any applicable commercial agreement. This includes single-node use, educational or non-profit use, and commercially licensed cluster or hosted use to the extent permitted by the applicable broker license or agreement. No separate Dashboard production license is required for uses covered by this grant.
This license follows the licensing model of the EMQX broker, with the Licensed Work and Additional Use Grant adapted for the Dashboard. The broker remains subject to its own license; this license does not grant additional rights to use the broker. See the EMQX Licensing FAQ for background on the broker's licensing model.
Third-party code and dependencies remain subject to their respective licenses.
