Skip to content

Latest commit

 

History

History
 
 

web

MQTTX Logo

MQTTX Web

GitHub Release platforms build packages

GitHub Downloads Docker Web Pulls Docker CLI Pulls

Community Slack Discord YouTube Twitter Follows


MQTTX Web is an open source MQTT 5.0 browser client and an online MQTT WebSocket client tool. Use WebSocket to connect to MQTT in your browser to help you develop and debug your MQTT services and applications faster without having to download and install MQTTX locally.

MQTT stands for MQ Telemetry Transport. It is a publish/subscribe, extremely simple and lightweight messaging protocol, designed for constrained devices and low-bandwidth, high-latency or unreliable networks.

Preview

mqttx-preview

Documentation

For introduction, and usage, please refer to the MQTTX Web Documentation.

Usage

Visit MQTT WebSocket Client (MQTTX Web): https://mqttx.app/web-client

Deploy from Docker Image

docker pull emqx/mqttx-web:latest

docker run -d --name mqttx-web -p 80:80 emqx/mqttx-web:latest

Manual compilation and deployment

If you need to make some personalized settings, such as changing the default connection path, deployment path, etc., you can achieve these modifications by editing the .env configuration file and compiling manually. For information on how to compile the project and package docker images, you can refer to the development section.

Better Together with EMQX

MQTTX is designed to connect to test MQTT Brokers such as EMQX, The one-click connection and simple graphical interface make it easy to connect to EMQX or EMQX Cloud to debug and explore functional features.

Sign up EMQX Cloud for 14 days free trial

Download EMQX locally right now

Get Involved

Develop

Recommended version for Node environment:

  • v18.*.*
# Clone the repository
git clone [email protected]:emqx/MQTTX.git

# Install dependencies
cd MQTTX/web
yarn install

# Compiles and hot-reloads for development
yarn run serve

# Compiles and minifies for production
yarn run build

# Compiles for production & serve generated files of site locally
yarn run start

# Compiles and prepares for Docker containerization
yarn run build:docker

# Build Docker image
docker build -t mqttx-web .

# Run Docker image
docker run -p 80:80 mqttx-web

Contributing

Please make sure to read the Contributing Guide before making a pull request.

Technology Stack

License

Apache License 2.0, see LICENSE.