diff --git a/README.md b/README.md index 6eecc5dd..c8ffad9d 100644 --- a/README.md +++ b/README.md @@ -945,10 +945,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.1.0 -[addon-doc-mqtt]: https://github.com/hassio-addons/addon-mqtt/blob/v1.1.0/README.md +[addon-mqtt]: https://github.com/hassio-addons/addon-mqtt/tree/v1.2.0 +[addon-doc-mqtt]: https://github.com/hassio-addons/addon-mqtt/blob/v1.2.0/README.md [mqtt-issue]: https://github.com/hassio-addons/addon-mqtt/issues -[mqtt-version-shield]: https://img.shields.io/badge/version-v1.1.0-blue.svg +[mqtt-version-shield]: https://img.shields.io/badge/version-v1.2.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 808a04fe..1708ba27 100644 --- a/mqtt/CHANGELOG.md +++ b/mqtt/CHANGELOG.md @@ -1,60 +1,26 @@ -# PSA +## ⚠️ Deprecation notice! -- **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" +This is the final and last release of this add-on, which is now deprecated. -# Ingress +We strongly advise you to upgrade/migrate to using the Mosquitto add-on, as provided by the Home Assistant project. -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. +This add-on will be removed from the add-on store soon. -## Version updates +## Changes -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` +- :pencil2: Maintaince -> Maintenance +- :ambulance: Fixes path handling for SSL certificates +- :hammer: Updates HA Auth URL in NGinx LUA script +- :hammer: Use Hass.io DNS as NGinx resolver +- :fireworks: Updates maintenance/license year to 2020 +- :books: Update add-on documentation to use new YAML configuration format +- :hammer: Re-branding +- :pencil2: Fixes some typos +- :hammer: Update add-on config with new password & list features +- :arrow_up: Upgrades add-on base image to v7.0.2 +- :warning: Adds deprecation notices -[Full changelog](https://github.com/hassio-addons/addon-mqtt/compare/v1.0.1...v1.1.0) +[Full Changelog][changelog] -# One last thing - -Thanks again to @frenck for adding/changing most of what is in this release! \ No newline at end of file +[changelog]: https://github.com/hassio-addons/addon-mqtt/compare/v1.1.0...v1.2.0 \ No newline at end of file diff --git a/mqtt/README.md b/mqtt/README.md index 041cfd85..08fbf911 100644 --- a/mqtt/README.md +++ b/mqtt/README.md @@ -1,4 +1,4 @@ -# Community Hass.io Add-ons: MQTT Server & Web client +# Home Assistant Community Add-on: MQTT Server & Web client [![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] @@ -8,6 +8,15 @@ Mosquitto MQTT Server bundled with Hivemq's web client. +## Deprecation warning + +**This add-on is in a deprecated state!** + +This add-on is now deprecated. We highly recommend on switching to the +official Home Assistant Mosquitto add-on as an alternative. + +This add-on will soon be removed from the add-on store. + ## About This add-on combines the power of [Hivemq][hivemq]'s @@ -23,13 +32,13 @@ and inspect/publish messages using the built-in web client! [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.1.0/README.md +[docs]: https://github.com/hassio-addons/addon-mqtt/blob/v1.2.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 +[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.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.1.0-blue.svg -[release]: https://github.com/hassio-addons/addon-mqtt/tree/v1.1.0 +[project-stage-shield]: https://img.shields.io/badge/project%20stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg +[release-shield]: https://img.shields.io/badge/version-v1.2.0-blue.svg +[release]: https://github.com/hassio-addons/addon-mqtt/tree/v1.2.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 f0e9c299..0a2b763d 100644 --- a/mqtt/config.json +++ b/mqtt/config.json @@ -1,6 +1,6 @@ { "name": "MQTT Server & Web client", - "version": "1.1.0", + "version": "1.2.0", "slug": "mqtt", "description": "Mosquitto MQTT Server bundled with Hivemq's web client", "url": "https://github.com/hassio-addons/addon-mqtt/tree/master/README.md", @@ -30,7 +30,7 @@ "4884/tcp": 4884 }, "ports_description": { - "80/tcp": "HiveMQ web interface (Not required for Hass.io Ingress)", + "80/tcp": "HiveMQ web interface (Not required for Ingress)", "1883/tcp": "Standard MQTT port (without SSL)", "1884/tcp": "Standard WebSocket port (without SSL)", "4883/tcp": "Secure MQTT port (with SSL)", @@ -59,7 +59,7 @@ ] }, "schema": { - "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)?", + "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", "ssl": "bool", "certfile": "str", "keyfile": "str", @@ -68,7 +68,7 @@ "mqttusers": [ { "username": "str", - "password": "str", + "password": "password", "readonly": "bool", "topics": [ "str"