# MQTT Explorer

MQTT Explorer is a comprehensive MQTT client that gives a structured overview of your topics and makes working with devices and services on your broker simple. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/725/mqtt-explorer

## Description

MQTT Explorer is a comprehensive MQTT client that gives a structured overview of your topics and makes working with devices and services on your broker simple. It lets you visualize topic activity, search and filter topics, publish messages, delete retained topics recursively, compare the current and previous received messages, plot numeric topics, and retain a history of each topic.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

16/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (last commit 1155 days ago)
- Popular: 37 (70 GitHub stars)
- Easy to install: 20 (1 install platform, Docker image)

## Links

- Official website: https://mqtt-explorer.com
- Docker Hub: https://hub.docker.com/r/smeagolworms4/mqtt-explorer
- GitHub: https://github.com/Smeagolworms4/MQTT-Explorer
- Unraid: https://ca.unraid.net/apps/mqttexplorer-1sl3gyk122yqog?q=MQTTExplorer

## Common questions

### How do I deploy the Docker version?

Pull the smeagolworms4/mqtt-explorer image and run it as a container. The repository includes a Docker command for starting it.

### Can I change the HTTP port?

Set the HTTP_PORT environment variable to choose the port. The default shown is 4000.

### How can I protect access to the web app?

Set HTTP_USER and HTTP_PASSWORD to add credentials. You can also set SSL_KEY_PATH and SSL_CERT_PATH to provide TLS key and certificate paths.

### Where is the configuration stored?

Configuration is read from CONFIG_PATH, which defaults to /mqtt-explorer/config. You can also provide INITIAL_CONFIG with an initial JSON configuration for startup.

### What should I check if the app cannot connect to an MQTT broker?

Check hostnames, ports, authentication, TLS, WebSockets, firewalls, and broker ACLs.

---
Source: Our Local Host (https://ourlocalhost.com/app/725/mqtt-explorer), the self-hosted and open-source app directory.