diff --git a/README.md b/README.md index 7df77e9b..18027fb0 100644 --- a/README.md +++ b/README.md @@ -895,10 +895,10 @@ SOFTWARE. [lutron-cert-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [lutron-cert-armv7-shield]: https://img.shields.io/badge/armv7-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/v1.0.1 -[addon-doc-mqtt]: https://github.com/hassio-addons/addon-mqtt/blob/v1.0.1/README.md +[addon-mqtt]: https://github.com/hassio-addons/addon-mqtt/tree/v1.1.0 +[addon-doc-mqtt]: https://github.com/hassio-addons/addon-mqtt/blob/v1.1.0/README.md [mqtt-issue]: https://github.com/hassio-addons/addon-mqtt/issues -[mqtt-version-shield]: https://img.shields.io/badge/version-v1.0.1-blue.svg +[mqtt-version-shield]: https://img.shields.io/badge/version-v1.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 diff --git a/mqtt/CHANGELOG.md b/mqtt/CHANGELOG.md index 4cfea2ad..808a04fe 100644 --- a/mqtt/CHANGELOG.md +++ b/mqtt/CHANGELOG.md @@ -1,15 +1,60 @@ -## Changes - -- 0745b9b 🚑 Fix issues with user creations -- df56330 📝 Cleanup logs -- 4d9dd7a 🚑 Fix quoting issues -- fafe0ef 🔨 Utilize bashio for user creation - -[Full Changelog][changelog] - -*** - -This release was created with [reporeleaser][reporeleaser] :tada: - -[reporeleaser]: https://pypi.org/project/reporeleaser/ -[changelog]: https://github.com/hassio-addons/addon-mqtt/compare/v1.0.0...v1.0.1 \ No newline at end of file +# PSA + +- **BEFORE** you upgrade, make sure you read _EVERYTHING_ in this release. +- **BIG** shoutout to @frenck for a _major_ refactor of this addon! :heart: +- You need to have version `0.92.0` of Home Assistant (or newer) to install this update. +- A link to the web client can be added to the sidebar by toggling "Add to sidebar" + +# Ingress + +This release adds ingress support for the web client, this is enabled as **default**. + +What this means is that if you have bookmarks, iframes, panels, proxy entries, port forwarding or anything else that uses the URL _with_ port number to access the web client those will no longer work with the default configuration. + +There **is** some good news! :) + +By using ingress, there is no need for a separate login, you don't need to forward ports, it just works! + +### Disable ingress + +If you do **not** want to use these new features, you **can** _disable_ ingress. + +To disable ingress add a port in the Network configuration (example 5713) to the right of 80/tcp in the "disabled" field, after adding that hit "SAVE" then restart the addon. + +# Configuration + +The structure of the configuration for this addon has been changed. +Make sure you control all settings and look in the addon log for clues if something fails. + +- You can no longer disable the web client. +- The `ssl` option is now "global", meaning that it will enable: + - HTTPS for the web client. + - Port 4883 (MQTT with SSL) on the broker. + - Port 4884 (Websockets with SSL) on the broker. + +# Changes + +_Now that the important changes are taken care of, let's list the "boring" stuff._ + +## New functionality + +- Ingress support +- "Add to sidebar" support +- Get the hostname from your browser automatically. + + +## Version updates + +What | From | To +-- | -- | -- +`mosquitto` | `1.5.8` | `1.6.2` +`nginx` | `1.14.2-r0` | `1.14.2-r1` +`lua-resty-http` | `0.12-r1` | `0.13-r0` +`nginx-mod-http-lua` | `1.14.2-r0` | `1.14.2-r1` +`base image` | `3.0.1` | `3.1.0` + +[Full changelog](https://github.com/hassio-addons/addon-mqtt/compare/v1.0.1...v1.1.0) + +# One last thing + +Thanks again to @frenck for adding/changing most of what is in this release! \ No newline at end of file diff --git a/mqtt/README.md b/mqtt/README.md index 10f966fc..140ffafb 100644 --- a/mqtt/README.md +++ b/mqtt/README.md @@ -39,13 +39,13 @@ If you are more interested in stable releases of our add-ons: [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/v1.0.1/README.md +[docs]: https://github.com/hassio-addons/addon-mqtt/blob/v1.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/2019.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-v1.0.1-blue.svg -[release]: https://github.com/hassio-addons/addon-mqtt/tree/v1.0.1 +[release-shield]: https://img.shields.io/badge/version-v1.1.0-blue.svg +[release]: https://github.com/hassio-addons/addon-mqtt/tree/v1.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 index 28132a6e..f0e9c299 100644 --- a/mqtt/config.json +++ b/mqtt/config.json @@ -1,43 +1,40 @@ { "name": "MQTT Server & Web client", - "version": "1.0.1", + "version": "1.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]", + "webui": "https://[HOST]:[PORT:80]", + "ingress": true, + "ingress_port": 1337, + "homeassistant": "0.92.0", + "panel_icon": "mdi:code-brackets", + "panel_title": "MQTT", "startup": "services", "arch": [ "aarch64", "amd64", "armhf", + "armv7", "i386" ], "boot": "auto", "auth_api": true, - "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": true, - "audio": false, - "gpio": false, - "devicetree": false, - "stdin": false, - "legacy": false, "ports": { - "5713/tcp": 5713, - "1884/tcp": 1884, + "80/tcp": null, "1883/tcp": 1883, - "4884/tcp": 4884, - "4883/tcp": 4883 + "1884/tcp": 1884, + "4883/tcp": 4883, + "4884/tcp": 4884 + }, + "ports_description": { + "80/tcp": "HiveMQ web interface (Not required for Hass.io Ingress)", + "1883/tcp": "Standard MQTT port (without SSL)", + "1884/tcp": "Standard WebSocket port (without SSL)", + "4883/tcp": "Secure MQTT port (with SSL)", + "4884/tcp": "Secure WebSocket port (with SSL)" }, "map": [ "share", @@ -45,21 +42,11 @@ "config" ], "options": { - "log_level": "info", + "ssl": true, "certfile": "fullchain.pem", "keyfile": "privkey.pem", - "web": { - "enabled": true, - "ssl": true - }, - "broker": { - "enabled": true, - "enable_ws": false, - "enable_mqtt": false, - "enable_ws_ssl": true, - "enable_mqtt_ssl": true, - "allow_anonymous": false - }, + "broker": true, + "allow_anonymous": false, "mqttusers": [ { "username": "", @@ -72,21 +59,12 @@ ] }, "schema": { - "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)?", + "ssl": "bool", "certfile": "str", "keyfile": "str", - "web": { - "enabled": "bool", - "ssl": "bool" - }, - "broker": { - "enabled": "bool", - "enable_ws": "bool", - "enable_mqtt": "bool", - "enable_ws_ssl": "bool", - "enable_mqtt_ssl": "bool", - "allow_anonymous": "bool" - }, + "broker": "bool", + "allow_anonymous": "bool", "mqttusers": [ { "username": "str", @@ -100,8 +78,5 @@ "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