diff --git a/README.md b/README.md index 8d995bc7a..194c874e1 100644 --- a/README.md +++ b/README.md @@ -236,6 +236,19 @@ Automatically convert your existing UI to the new Lovelace UI [:books: Lovelace Migration add-on documentation][addon-doc-lovelace-migration] +### ✓ [MQTT Server & Web client][addon-mqtt] + +![Latest Version][mqtt-version-shield] +![Supports armhf Architecture][mqtt-armhf-shield] +![Supports aarch64 Architecture][mqtt-aarch64-shield] +![Supports amd64 Architecture][mqtt-amd64-shield] +![Supports i386 Architecture][mqtt-i386-shield] +![Docker Pulls][mqtt-pulls-shield] + +Mosquitto MQTT Server bundled with Hivemq's web client + +[:books: MQTT Server & Web client add-on documentation][addon-doc-mqtt] + ### ✓ [Network UPS Tools][addon-nut] ![Latest Version][nut-version-shield] @@ -466,6 +479,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: Jupyter][jupyter-issue] - [Open an issue for the add-on: Log Viewer][log-viewer-issue] - [Open an issue for the add-on: Lovelace Migration][lovelace-migration-issue] +- [Open an issue for the add-on: MQTT Server & Web client][mqtt-issue] - [Open an issue for the add-on: Network UPS Tools][nut-issue] - [Open an issue for the add-on: Node-RED][node-red-issue] - [Open an issue for the add-on: Octobox][octobox-issue] @@ -665,6 +679,15 @@ SOFTWARE. [lovelace-migration-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [lovelace-migration-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [lovelace-migration-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[addon-mqtt]: https://github.com/hassio-addons/addon-mqtt/tree/ca75625 +[addon-doc-mqtt]: https://github.com/hassio-addons/addon-mqtt/blob/ca75625/README.md +[mqtt-issue]: https://github.com/hassio-addons/addon-mqtt/issues +[mqtt-version-shield]: https://img.shields.io/badge/version-ca75625-blue.svg +[mqtt-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/mqtt.svg +[mqtt-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[mqtt-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[mqtt-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[mqtt-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-nut]: https://github.com/hassio-addons/addon-nut/tree/a49c6dd [addon-doc-nut]: https://github.com/hassio-addons/addon-nut/blob/a49c6dd/README.md [nut-issue]: https://github.com/hassio-addons/addon-nut/issues diff --git a/mqtt/CHANGELOG.md b/mqtt/CHANGELOG.md new file mode 100644 index 000000000..b61c6f3fd --- /dev/null +++ b/mqtt/CHANGELOG.md @@ -0,0 +1,3 @@ +2018/09/22 19:38 UTC - [ca75625](https://github.com/hassio-addons/addon-mqtt/commit/ca75625c00dd12438c9fdbfa81dbfa8366e32cb2) by [@ludeeus](https://github.com/ludeeus) +> 👕Fixes shellcheck warnings + diff --git a/mqtt/README.md b/mqtt/README.md new file mode 100644 index 000000000..4a775cb6c --- /dev/null +++ b/mqtt/README.md @@ -0,0 +1,51 @@ +# Community Hass.io Add-ons: MQTT Server & Web client + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +Mosquitto MQTT Server bundled with Hivemq's web client. + +## About + +This add-on combines the power of [Hivemq](https://www.hivemq.com/)'s web based MQTT client, +and the powerfull [Mosquitto](https://mosquitto.org/) broker. +With this you can host your broker, and inspect/publish messages in the Web client! + +[Click here for the full documentation][docs] + +![Screenshot][screenshot] + +## WARNING! THIS IS AN EDGE VERSION! + +This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds +add-ons are based upon the latest development version. + +- They may not work at all. +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/ludeeus +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[docs]: https://github.com/hassio-addons/addon-mqtt/blob/ca75625/README.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[release-shield]: https://img.shields.io/badge/version-ca75625-blue.svg +[release]: https://github.com/hassio-addons/addon-mqtt/tree/ca75625 +[screenshot]: https://github.com/hassio-addons/addon-mqtt/raw/master/images/image.png \ No newline at end of file diff --git a/mqtt/config.json b/mqtt/config.json new file mode 100644 index 000000000..3345b3916 --- /dev/null +++ b/mqtt/config.json @@ -0,0 +1,94 @@ +{ + "name": "MQTT Server & Web client", + "version": "ca75625", + "slug": "mqtt", + "description": "Mosquitto MQTT Server bundled with Hivemq's web client", + "url": "https://github.com/hassio-addons/addon-mqtt/tree/master/README.md", + "webui": "https://[HOST]:[PORT:5713]", + "startup": "services", + "arch": [ + "aarch64", + "amd64", + "armhf", + "i386" + ], + "boot": "auto", + "hassio_api": true, + "homeassistant_api": false, + "host_network": false, + "ports": { + "5713/tcp": 5713, + "1884/tcp": 1884, + "1883/tcp": 1883, + "4884/tcp": 4884, + "4883/tcp": 4883 + }, + "map": [ + "ssl", + "config" + ], + "options": { + "log_level": "info", + "certfile": "fullchain.pem", + "keyfile": "privkey.pem", + "web": { + "enabled": true, + "username": "", + "password": "", + "ssl": true + }, + "broker": { + "enabled": true, + "enable_ws": true, + "enable_mqtt": true, + "enable_ws_ssl": true, + "enable_mqtt_ssl": true, + "allow_anonymous": false + }, + "mqttusers": [ + { + "username": "", + "password": "", + "readonly": true, + "topics": [ + "#" + ] + } + ] + }, + "schema": { + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", + "certfile": "str", + "keyfile": "str", + "web": { + "enabled": "bool", + "username": "str", + "password": "str", + "ssl": "bool" + }, + "broker": { + "enabled": "bool", + "enable_ws": "bool", + "enable_mqtt": "bool", + "enable_ws_ssl": "bool", + "enable_mqtt_ssl": "bool", + "allow_anonymous": "bool" + }, + "mqttusers": [ + { + "username": "str", + "password": "str", + "readonly": "bool", + "topics": [ + "str" + ] + } + ], + "i_like_to_be_pwned": "bool?", + "leave_front_door_open": "bool?" + }, + "environment": { + "LOG_FORMAT": "{LEVEL}: {MESSAGE}" + }, + "image": "hassioaddons/mqtt" +} \ No newline at end of file diff --git a/mqtt/icon.png b/mqtt/icon.png new file mode 100644 index 000000000..46bed802b Binary files /dev/null and b/mqtt/icon.png differ diff --git a/mqtt/logo.png b/mqtt/logo.png new file mode 100644 index 000000000..dcc8d542e Binary files /dev/null and b/mqtt/logo.png differ