Skip to content

Latest commit

 

History

History
128 lines (77 loc) · 3.89 KB

README.md

File metadata and controls

128 lines (77 loc) · 3.89 KB
Raw

Dashboard for EMQX 5.0

EMQX Dashboard is a built-in management console for EMQX. It enables users to effortlessly manage and monitor EMQX clusters, configure required features, and visualize data through a web interface.

image

Key Features

  • Data monitoring and management: clear overview of important data

  • Visual access control management: out-of-the-box authentication and authorization

  • Robust data integration capabilities: flow editor and bi-directional data bridge

  • Real-time configuration updates: hot updates with immediate configuration saving

  • Customizable extension capabilities: built-in gateways, plugins, and Hooks

  • Comprehensive diagnostic tools: timely problem identification and resolution

Running

First, install the latest version of EMQX.

Upon successful EMQX installation, access and use the EMQX Dashboard by opening http://localhost:18083/ (replace localhost with the actual IP address if deployed on a non-local machine) in your browser. By default, EMQX Dashboard listens on port 18083 as a web application.

"Note that EMQX can still function without the Dashboard enabled. The Dashboard merely offers a visual interface for users".

Get Involved

Resources

  • MQTT client programming

    A collection of blog posts to help developers quickly learn MQTT in PHP, Node.js, Python, Golang, and other programming languages.

  • MQTT SDKs

    Explore popular MQTT client SDKs in various programming languages, complete with code examples to facilitate a better understanding of MQTT clients.

  • MQTT X

    An elegant cross-platform MQTT 5.0 client tool that provides desktop, command line, and web to help you develop and debug MQTT services and applications faster.

  • Internet of Vehicles

    Build a reliable, efficient, and industry-specific IoV platform based on EMQ's practical experience, from protocol selection to platform architecture design.

Local Development

To set up the project for local development, follow these steps:

  1. Fork the repository and clone your fork:

    git clone https://github.com/your-username/emqx-dashboard5.git
cd emqx-dashboard5

    Alternatively, you can clone the original repository directly:

    git clone https://github.com/emqx/emqx-dashboard5.git
cd emqx-dashboard5

  2. Install the dependencies:

    yarn

  3. Run the following command to start the development server:

    yarn serve

  4. Compile and minify for production:

    yarn build

  5. Lint and fix files:

    yarn lint

    or Format code with Prettier:

    yarn format

Development with Cloud Host

To compile and hot-reload for development with a cloud host, follow these steps:

  1. Create a new file named .env.development.local

    touch .env.development.local

  2. Define your cloud host address in the .env.development.local file in the root directory:

    HOST_URL=http://your-cloud-host:port/

  3. Run the following command to start the development server:

    yarn serve

Customize configuration

See Configuration Reference.

The CI will then run automatically, and it will be released after the run is complete.