Git Product home page Git Product logo

mqtt-dashboard's Introduction

Mqtt Dashboard

This Mqtt project should help to visualize the actual traffic and other data on a Mqtt Broker. Initially was this project thought for Mosquitto as broker and a RaspberryPi as host.

Screenshot Mqtt-Dashboard

How to run it

This project is set up to be usable on ARM and AMD x64 architectures with Docker. To save and visualize some data we need a storage. In this case I choose Redis. In my setup Redis is running in memory only, because I don't need the statistics in case of a reboot of my Raspberry Pi.

docker run --name redis -p 6379:6379 -d redis

After that start and configure the Mqtt-Dashboard:

docker run --name mqtt-dashboard -p 3333:3333 secanis/mqtt-dashboard

To configure the Mqtt-Dashboard you can set several ENV variables:

ENV default description
REDIS_HOST localhost Redis host
REDIS_PORT 6379 Redis port
MQTT_HOST localhost Mqtt Hostname/Host
MQTT_PORT 1883 Mqtt Port
MQTT_USERNAME - Mqtt Username
MQTT_PASSWORD - Mqtt Password
MQTT_PROTOCOL mqtt Mqtt Protocol
MQTT_PROTOCOL_VERSION 5 Mqtt Protocol Version

Protocol can be 'ws' || 'wss' || 'mqtt' || 'mqtts'

Full Example:

docker run --name mqtt-dashboard -p 3333:3333 -e MQTT_HOST=192.160.0.110 -e MQTT_USERNAME=mqtt -e MQTT_PASSWORD=admin secanis/mqtt-dashboard

Development

This project uses:

  • Backend
    • NestJS
  • Frontend
    • Angular
    • Socket
    • EChart
    • MomentJS
  • Redis
# start a local redis
docker run --name redis -p 6379:6379 -d redis

# to start the NestJS dev server
npm run start api

# to start the Angular dev server
npm run start

Contribution

It would be very nice, when you give us a feedback or when you create issues if you detect problems or bugs. If you want to fix it yourself or you have an idea for something new, please create a PR, that would help us a lot.

Happy Coding <3 ...

mqtt-dashboard's People

Contributors

dependabot[bot] avatar matthiasbaldi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.