hassio-addons/repository-beta
1
0
Fork 0
mirror of https://github.com/hassio-addons/repository-beta.git synced 2025-05-05 19:41:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

🎉 Release of add-on EMQX 0.1.1

Browse source
This commit is contained in:
Community Hass.io Add-ons Bot 2022-09-24 16:17:43 +00:00
parent 7ecaf11ef9
commit f340172f86
5 changed files with 45 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -746,10 +746,10 @@ SOFTWARE.
[bookstack-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[bookstack-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[bookstack-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[addon-emqx]: https://github.com/hassio-addons/addon-emqx/tree/v0.1.0
[addon-doc-emqx]: https://github.com/hassio-addons/addon-emqx/blob/v0.1.0/README.md
[addon-emqx]: https://github.com/hassio-addons/addon-emqx/tree/v0.1.1
[addon-doc-emqx]: https://github.com/hassio-addons/addon-emqx/blob/v0.1.1/README.md
[emqx-issue]: https://github.com/hassio-addons/addon-emqx/issues
[emqx-version-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg
[emqx-version-shield]: https://img.shields.io/badge/version-v0.1.1-blue.svg
[emqx-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[emqx-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[emqx-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg

5
emqx/CHANGELOG.md
View file

@ -1,3 +1,6 @@
## What’s changed
🎉 Initial add-on release!
## 📚 Documentation
- Add default login credentials @tjorim (#1)
- Extend documentation based on questions @frenck (#3)

32
emqx/DOCS.md
View file

@ -9,6 +9,9 @@ The [EMQX MQTT broker][emqx] is an advanced alternative to the Mosquitto MQTT
broker/add-on that is generally used in Home Assistant. It has a UI
to configure, manage, and debug your MQTT broker, clients, and traffic.
While EMQX sells their product mainly as a cloud hosted product on their
website, this add-on runs EMQX in a fully local, self-hosted environment.
## Installation
The installation of this add-on is pretty straightforward and not different in
@ -23,9 +26,29 @@ comparison to installing any other Home Assistant add-on.
1. Start the "EMQX" add-on.
1. Check the logs of the "EMQX" to see if everything went well.
1. Open the Web UI.
1. Log in with the default credentials: username `admin` and password `public`.
1. Be sure to first set up authentication in for your MQTT client, but setting
up an authentication method in the EMQX web UI under "Access Control" ->
"Authentication".
1. Read the step above again and **make sure** you have set up authetication.
_Notes:_
- When configuring Home Assistant, Zigbee2MQTT or any other MQTT application
or client on your Home Assistant machine to connect to eMQX, use
`homeassistant` or `a0d7b954-emqx` as the broker/hostname to connect to.
In some cases, just `localhost` will work as well.
- When connecting external devices to your EMQX add-on, use the IP address or
hostname of your Home Assistant instance as the broker/hostname to connect to.
## Configuration
You most likely don't need these configuration options. Almost all
configuration can be done via the web UI that is available in this add-on.
Some more advanced/complex configuration options are not available in the
web UI, but can be configured using this option (for example, when
setting up clustering of multiple instances).
**Note**: _Remember to restart the add-on when the configuration is changed._
Example add-on configuration:
@ -54,6 +77,15 @@ documentation:
## Known issues and limitations
- This add-on cannot run simultaneously with the Mosquitto add-on.
- EMQX uses ports 1883, 8083, 8084, and 8883 by default. It is possible
one of your existing add-ons conflicts with that. In such cases, either
change the ports of the other add-on or change the listner ports of EMQX.
To change the ports of EMQX, you will need to temporary stop the conflicting
add-on, as you need to access the EMQX web UI to change the listner ports.
- The WebRTC integration by AlexxIT is known to cause a port conflict on
port 8083. Temporary disabling the integration (similar as the point above
for add-ons) can be used to allow accessing the EMQX web UI to adjust the
listeners.
## Changelog & Releases

7
emqx/README.md
View file

@ -21,6 +21,9 @@ The [EMQX MQTT broker][emqx] is an advanced alternative to the Mosquitto MQTT
broker/add-on that is generally used in Home Assistant. It has a UI
to configure, manage, and debug your MQTT broker, clients, and traffic.
While EMQX sells their product mainly as a cloud hosted product on their
website, this add-on runs EMQX in a fully local, self-hosted environment.
![EMQX in the Home Assistant Frontend][screenshot]
## WARNING! THIS IS A BETA VERSION!
@ -50,6 +53,6 @@ If you are more interested in stable releases of our add-ons:
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
[patreon]: https://www.patreon.com/frenck
[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-emqx/tree/v0.1.0
[release-shield]: https://img.shields.io/badge/version-v0.1.1-blue.svg
[release]: https://github.com/hassio-addons/addon-emqx/tree/v0.1.1
[screenshot]: https://github.com/hassio-addons/addon-emqx/raw/main/images/screenshot.png

2
emqx/config.yaml
View file

@ -24,4 +24,4 @@ schema:
slug: emqx
startup: services
url: https://github.com/hassio-addons/addon-emqx
version: 0.1.0
version: 0.1.1