{"id":13587765,"url":"https://github.com/hassio-addons/addon-mqtt","last_synced_at":"2025-04-07T22:31:33.268Z","repository":{"id":88120952,"uuid":"147407125","full_name":"hassio-addons/addon-mqtt","owner":"hassio-addons","description":"MQTT Server \u0026 Web client - Home Assistant Community Add-ons","archived":true,"fork":false,"pushed_at":"2020-02-27T13:54:35.000Z","size":383,"stargazers_count":34,"open_issues_count":0,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-17T00:09:08.083Z","etag":null,"topics":["hass","hassio","hassio-addons","hivemq","home-assistant","homeassistant","mosquitto","mqtt","web"],"latest_commit_sha":null,"homepage":"https://addons.community","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hassio-addons.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":".github/support.yml","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-04T19:57:20.000Z","updated_at":"2024-08-01T16:33:49.955Z","dependencies_parsed_at":"2023-05-18T09:15:42.364Z","dependency_job_id":null,"html_url":"https://github.com/hassio-addons/addon-mqtt","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-mqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-mqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-mqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-mqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hassio-addons","download_url":"https://codeload.github.com/hassio-addons/addon-mqtt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247740847,"owners_count":20988280,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hass","hassio","hassio-addons","hivemq","home-assistant","homeassistant","mosquitto","mqtt","web"],"created_at":"2024-08-01T15:06:21.128Z","updated_at":"2025-04-07T22:31:32.749Z","avatar_url":"https://github.com/hassio-addons.png","language":"Shell","funding_links":["https://www.buymeacoffee.com/ludeeus"],"categories":["Shell"],"sub_categories":[],"readme":"# Home Assistant Community Add-on: MQTT Server \u0026 Web client\n\n[![GitHub Release][releases-shield]][releases]\n![Project Stage][project-stage-shield]\n[![License][license-shield]](LICENSE.md)\n\n[![GitLab CI][gitlabci-shield]][gitlabci]\n![Project Maintenance][maintenance-shield]\n[![GitHub Activity][commits-shield]][commits]\n\n[![Discord][discord-shield]][discord]\n[![Community Forum][forum-shield]][forum]\n\n[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]\n\nMosquitto MQTT Server bundled with Hivemq's web client.\n\n![sample][screenshot]\n\n## Deprecation warning\n\n**This add-on is in a deprecated state!**\n\nThis add-on is now deprecated. We highly recommend on switching to the\nofficial Home Assistant Mosquitto add-on as an alternative.\n\nThis add-on will soon be removed from the add-on store.\n\n## About\n\nThis add-on combines the power of [Hivemq][hivemq]'s\nweb-based MQTT client, and the powerful [Mosquitto][mosquitto]\nbroker (MQTT Server). With this, you can host your own MQTT server,\nand inspect/publish messages using the built-in web client!\n\n## Key features\n\n- The Hivemq web service can connect to a WebSocket enabled MQTT Server,\n  it will enable you to see or post messages to specific topics easily.\n- The Mosquitto broker has multi-user support with ACL!\n  _This allows you to limit the access of an MQTT user to a specific topic._\n- With the ACL support, you can have a separate user for every\n  device that connects to your MQTT server.\n- You can also have read-only users that cannot post messages.\n\nACL = access control list.\n\n## Installation\n\nThe installation of this add-on is pretty straightforward and not different in\ncomparison to installing any other Home Assistant add-on.\n\n1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance.\n1. Install the \"MQTT Server \u0026 Web client\" add-on.\n1. Start the \"MQTT Server \u0026 Web client\" add-on\n1. Configure the \"MQTT Server \u0026 Web client\" add-on\n1. Check the logs of the \"MQTT Server \u0026 Web client\"\n  add-on to see if everything went well.\n1. Click \"OPEN WEB UI\" to open the Web client.\n1. Log in with your Home Assistant user (You can skip this if you are using ingress).\n\n**NOTE**: Starting the add-on might take a couple of minutes (especially the\nfirst time starting the add-on).\n\n**NOTE**: Do not add this repository to Hass.io, please use:\n`https://github.com/hassio-addons/repository`.\n\n## Docker status\n\n![Supports armhf Architecture][armhf-shield]\n![Supports aarch64 Architecture][aarch64-shield]\n![Supports amd64 Architecture][amd64-shield]\n![Supports i386 Architecture][i386-shield]\n\n[![Docker Layers][layers-shield]][microbadger]\n[![Docker Pulls][pulls-shield]][dockerhub]\n\n## Home Assistant configuration example\n\n### Notes\n\n_Remember to restart the add-on when the configuration is changed._\n\n_If you are moving from the official add-on to this one,\nmake sure that you change the `broker:` in your configuration\nfrom `core-mosquitto` to `a0d7b954-mqtt`._\n\n```yaml\n# Example configuration.yaml entry\nmqtt:\n  broker: a0d7b954-mqtt\n  username: !secret mqtt_username\n  password: !secret mqtt_password\n  client_id: home-assistant\n```\n\n## Add-on configuration example\n\n**Note**: _Remember to restart the add-on when the configuration is changed._\n\nExample add-on configuration:\n\n```yaml\nssl: true\ncertfile: fullchain.pem\nkeyfile: privkey.pem\nbroker: true\nallow_anonymous: false\nmqttusers:\n  - username: MarryPoppins\n    password: Supercalifragilisticexpialidocious\n    readonly: true\n    topics:\n      - cmnd/\n```\n\n**Note**: _This is just an example, don't copy and paste it! Create your own!_\n\n### Option: `log_level`\n\nThe `log_level` option controls the level of log output by the addon and can\nbe changed to be more or less verbose, which might be useful when you are\ndealing with an unknown issue. Possible values are:\n\n- `trace`: Show every detail, like all called internal functions.\n- `debug`: Shows detailed debug information.\n- `info`: Normal (usually) interesting events.\n- `warning`: Exceptional occurrences that are not errors.\n- `error`:  Runtime errors that do not require immediate action.\n- `fatal`: Something went terribly wrong. Add-on becomes unusable.\n\nPlease note that each level automatically includes log messages from a\nmore severe level, e.g., `debug` also shows `info` messages. By default,\nthe `log_level` is set to `info`, which is the recommended setting unless\nyou are troubleshooting.\n\n### Option `ssl`\n\nEnables/Disables SSL.\n\nWhen this is enabed it will:\n\n- Run the webclient over HTTPS.\n- Enable port 4883 (MQTT with SSL) on the broker.\n- Enable port 4884 (Websockets with SSL) on the broker.\n\n### Option: `certfile`\n\nThe certificate file to use for SSL.\n\n**Note**: _The file MUST be stored in `/ssl/`, which is the default_\n\n### Option: `keyfile`\n\nThe private key file to use for SSL.\n\n**Note**: _The file MUST be stored in `/ssl/`, which is the default_\n\n### Option `broker`\n\nThis will enable the mosquitto broker that ships with this addon.\n\nSetting this to `false` will disable that broker.\n\n### Option `allow_anonymous`\n\nSet this to `true` if you need to enable anonymous authentication on the broker.\n**NB!: It is NOT a good idea having this enabled**\n\n### Option group `mqttuser`\n\n---\nThe following options are for the option group: `mqttuser`, And are only\napplicable if the broker is enabled in this add-on.\n\n_if you have `allow_anonymous` set to `false` you need at least one user._\n\n#### Option `mqttuser`: `username`\n\nUsername for authenticating with the MQTT Server of this add-on.\n\nSetting a username/password can be added as an extra line of defense,\nto prevent users from using your installation for themselves.\n\nThis option is HIGHLY recommended in case you expose this add-on to the outside\nworld.\n\n**Note**: _This option support secrets, e.g., `!secret mqtt_broker_username1`._\n\n#### Option `mqttuser`: `password`\n\nPassword for authenticating with the MQTT Server of this add-on.\n\n**Note**: _This option support secrets, e.g., `!secret mqtt_broker_password1`._\n\n#### Option `mqttuser`: `readonly`\n\nA flag to set user permission to `readonly` for the specified topics.\n\n#### Option `mqttuser`: `topics`\n\nA list of topics available to the user.\nWildcards like `#` and `+` are supported.\n\n### Option: `i_like_to_be_pwned`\n\nAdding this option to the add-on configuration allows to you bypass the\nHaveIBeenPwned password requirement by setting it to `true`.\n\n**Note**: _We STRONGLY suggest picking a stronger/safer password instead of\nusing this option! USE AT YOUR OWN RISK!_\n\n### Option: `leave_front_door_open`\n\nAdding this option to the add-on configuration allows you to disable\nauthentication on the Web Terminal by setting it to `true` and leaving the\nusername and password empty.\n\n**Note**: _We STRONGLY suggest, not to use this, even if this add-on is\nonly exposed to your internal network. USE AT YOUR OWN RISK!_\n\n## Embedding into Home Assistant\n\nIt is possible to embed the web client of this add-on directly into\nHome Assistant, allowing you to access your the web client of this\nadd-on through the Home Assistant frontend.\n\nThe easiest way to enable this is by toggeling the \"Show in Sidebar\" switch.\nThis will not work if you have disabled ingress.\n\n### Embedding using `panel_iframe`\n\nThis will not work if you are using ingress.\nTo disable ingress add a port in the Network configuration\n(example 5713) to the rigth of `80/tcp` in the \"disabled\" field,\nafter adding that hit \"SAVE\" then restart.\n\nExample configuration:\n\n```yaml\npanel_iframe:\n  mqtt:\n    title: MQTT\n    icon: mdi:code-brackets\n    url: https://addres.to.your.hass.io:5713\n```\n\n## Custom configuration\n\nIf you want to add additional custom configuration to the mosquitto broker\nCreate a directory named `mqtt` in /config and put a file named `mosquitto.conf`\ninside it, add the configuration you want to that file and it will be added\nnext time you restart the addon.\n\n## Known issues\n\n```text\nnginx: [alert] detected a LuaJIT version which is not OpenResty's;\nmany optimizations will be disabled and performance will be compromised\n```\n\nThis will show in the log on every startup, this is expected and can be ignored.\n\n## Changelog \u0026 Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented\nbased on the following:\n\n- ``MAJOR``: Incompatible or major changes.\n- ``MINOR``: Backwards-compatible new features and enhancements.\n- ``PATCH``: Backwards-compatible bugfixes and package updates.\n\n## Support\n\nGot questions?\n\nYou have several options to get them answered:\n\n- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on\n  support and feature requests.\n- The [Home Assistant Discord chat server][discord-ha] for general Home\n  Assistant discussions and questions.\n- The Home Assistant [Community Forum][forum].\n- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]\n\nYou could also [open an issue here][issue] GitHub.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe have set up a separate document containing our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Authors \u0026 contributors\n\nThe original setup of this repository is by [Joakim Sørensen][ludeeus].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n## We have got some Home Assistant add-ons for you\n\nWant some more functionality to your Home Assistant instance?\n\nWe have created multiple add-ons for Home Assistant. For a full list, check out\nour [GitHub Repository][repository].\n\n## License\n\nMIT License\n\nCopyright (c) 2018-2020 Joakim Sørensen\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg\n[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg\n[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg\n[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg\n[buymeacoffee]: https://www.buymeacoffee.com/ludeeus\n[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-mqtt.svg\n[commits]: https://github.com/hassio-addons/addon-mqtt/commits/master\n[contributors]: https://github.com/hassio-addons/addon-mqtt/graphs/contributors\n[discord-ha]: https://discord.gg/c5DvZ4e\n[discord-shield]: https://img.shields.io/discord/478094546522079232.svg\n[discord]: https://discord.me/hassioaddons\n[dockerhub]: https://hub.docker.com/r/hassioaddons/mqtt\n[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg\n[forum]: https://community.home-assistant.io/t/community-hass-io-add-ons-mqtt-server-web-client/70376\n[ludeeus]: https://github.com/ludeeus\n[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-mqtt/badges/master/pipeline.svg\n[gitlabci]: https://gitlab.com/hassio-addons/addon-mqtt/pipelines\n[hivemq]: https://www.hivemq.com/\n[home-assistant]: https://home-assistant.io\n[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg\n[issue]: https://github.com/hassio-addons/addon-mqtt/issues\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[layers-shield]: https://images.microbadger.com/badges/image/hassioaddons/mqtt.svg\n[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-mqtt.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg\n[microbadger]: https://microbadger.com/images/hassioaddons/mqtt\n[mosquitto]: https://mosquitto.org/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg\n[pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/mqtt.svg\n[reddit]: https://reddit.com/r/homeassistant\n[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-mqtt.svg\n[releases]: https://github.com/hassio-addons/addon-mqtt/releases\n[repository]: https://github.com/hassio-addons/repository\n[screenshot]: https://github.com/hassio-addons/addon-mqtt/raw/master/images/image.png\n[semver]: http://semver.org/spec/v2.0.0.htm\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Faddon-mqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhassio-addons%2Faddon-mqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Faddon-mqtt/lists"}