emqx/emqx-dashboard5

The management console used to monitor and manage EMQX clusters.

EMQX 5.0 Dashboard

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.

🎯 Key Features

• 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.

🚀 Getting Started

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.

🤝 Get Involved

• 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.

📘 Useful Resources

• MQTT client programming

  Learn MQTT in PHP, Node.js, Python, Golang, and more with this collection of blog posts.

• MQTT SDKs

  Browse popular MQTT client SDKs in various programming languages, complemented with code examples.

• MQTTX

  A versatile cross-platform MQTT 5.0 client tool offering desktop, command-line, and web interfaces.

• Internet of Vehicles

  Build a reliable, efficient, and industry-specific IoV platform leveraging EMQ's practical experience.

💻 Local Development

To set up 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

   Or, clone the original repository directly:

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

2. Install the dependencies:

   yarn

3. To start the development server, run:

   yarn serve

4. For production compilation and minification:

   yarn build

5. Lint and fix files:

   yarn lint

   Or, format the code with Prettier:

   yarn format

☁️ Development with Cloud Host

To set up for development with a cloud host:

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

   touch .env.development.local

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

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

3. Start the development server:

   yarn serve

⚙️ Vue.js Customize Configuration

Refer to the Configuration Reference for more information.

After the completion of setup, the CI will run automatically and deploy upon successful execution.

emqx-dashboard5's Issues

Allow disabling the requirements of default password changes via environment variables

Now dashboard forces make an ask for password change when a user logs in with the default password, which is so good but not developer friendly, perhaps we could allow this to be disabled via an environment variable?

Dashboard in subpath

Hi,

I need to serve the dashboard under an url subpath.
I have searched the options, but found none.
Is there a way to achieve this goal?

I also want to serve the dashboard behind a reverse proxy (traefik).

I have done some tries, but nothing worked...
any help please?

PS: I am using the docker official image of EMQX, in a local docker environment.

Thank you,
regards

Disconnected clients. Delete all button.

What would you like to be added or enhanced?

Hi, it would be very useful to have a button to delete all clients that are disconnected from the 'Connections' page of the dashboard.

The procedure could be : select status -> disconnected (as already is) and bring up a 'delete all' button.

Thx.

Luca

Why is this needed?

Greater readability of clients, if in the past there have been hundreds of clients that no longer exist, the dashboard continues to show them, making it difficult to read. In addition, a disconnected client today can only be deleted by clicking on its client_id and without the possibility of multiple delete selections.

Feature request: OIDC login

I really like to use emqx but what's missing for my setup is openid connect / oauth capability for the dashboard. I would otherwise use oauth2-proxy but there doesn't seem to be a way to disable login on emqx side, so it would end up as double login.