diff --git a/README.md b/README.md index 4deb704d..0a9add8d 100644 --- a/README.md +++ b/README.md @@ -233,6 +233,19 @@ Generate certificate to control Lutron Caseta bridge locally [:books: Lutron Certificate add-on documentation][addon-doc-lutron-cert] +### ✓ [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] + ### ✓ [Node-RED][addon-node-red] ![Latest Version][node-red-version-shield] @@ -458,6 +471,7 @@ on the correct GitHub repository matching the add-on. - [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: Lutron Certificate][lutron-cert-issue] +- [Open an issue for the add-on: MQTT Server & Web client][mqtt-issue] - [Open an issue for the add-on: Node-RED][node-red-issue] - [Open an issue for the add-on: Octobox][octobox-issue] - [Open an issue for the add-on: Pi-hole][pi-hole-issue] @@ -656,6 +670,15 @@ SOFTWARE. [lutron-cert-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [lutron-cert-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [lutron-cert-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[addon-mqtt]: https://github.com/hassio-addons/addon-mqtt/tree/v0.1.0 +[addon-doc-mqtt]: https://github.com/hassio-addons/addon-mqtt/blob/v0.1.0/README.md +[mqtt-issue]: https://github.com/hassio-addons/addon-mqtt/issues +[mqtt-version-shield]: https://img.shields.io/badge/version-v0.1.0-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-node-red]: https://github.com/hassio-addons/addon-node-red/tree/v0.7.0 [addon-doc-node-red]: https://github.com/hassio-addons/addon-node-red/blob/v0.7.0/README.md [node-red-issue]: https://github.com/hassio-addons/addon-node-red/issues diff --git a/mqtt/CHANGELOG.md b/mqtt/CHANGELOG.md new file mode 100644 index 00000000..ececd805 --- /dev/null +++ b/mqtt/CHANGELOG.md @@ -0,0 +1 @@ +🎉 Initial release! \ No newline at end of file diff --git a/mqtt/README.md b/mqtt/README.md new file mode 100644 index 00000000..e8254d44 --- /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][hivemq]'s +web-based MQTT client, and the powerful [Mosquitto][mosquitto] +broker (MQTT Server). With this, you can host your own MQTT server, +and inspect/publish messages using the built-in web client! + +[Click here for the full documentation][docs] + +![Screenshot][screenshot] + +## WARNING! THIS IS A BETA VERSION! + +This Hass.io Add-ons repository contains beta releases of add-ons. + +- 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. + +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/v0.1.0/README.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/community-hass-io-add-ons-mqtt-server-web-client/70376 +[hivemq]: https://www.hivemq.com/ +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[mosquitto]: https://mosquitto.org/ +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[release-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg +[release]: https://github.com/hassio-addons/addon-mqtt/tree/v0.1.0 +[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 00000000..cf09b600 --- /dev/null +++ b/mqtt/config.json @@ -0,0 +1,109 @@ +{ + "name": "MQTT Server & Web client", + "version": "0.1.0", + "slug": "mqtt", + "timeout": 10, + "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", + "docker_api": false, + "hassio_api": true, + "hassio_role": "default", + "homeassistant_api": false, + "host_network": false, + "host_ipc": false, + "host_dbus": false, + "host_pid": false, + "auto_uart": false, + "privileged": [], + "full_access": false, + "apparmor": false, + "audio": false, + "gpio": false, + "devicetree": false, + "stdin": false, + "legacy": 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": false, + "enable_mqtt": false, + "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 00000000..539d37bc 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 00000000..539d37bc Binary files /dev/null and b/mqtt/logo.png differ