diff --git a/README.md b/README.md index 60b0b186d..6735cbd38 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,19 @@ Simple & Free Wiki Software [:books: Bookstack add-on documentation][addon-doc-bookstack] +### ✓ [EMQX][addon-emqx] + +![Latest Version][emqx-version-shield] +![Supports armhf Architecture][emqx-armhf-shield] +![Supports armv7 Architecture][emqx-armv7-shield] +![Supports aarch64 Architecture][emqx-aarch64-shield] +![Supports amd64 Architecture][emqx-amd64-shield] +![Supports i386 Architecture][emqx-i386-shield] + +The most scalable open-source MQTT broker for IoT. An alternative for the Mosquitto add-on + +[:books: EMQX add-on documentation][addon-doc-emqx] + ### ✓ [Example][addon-example] ![Latest Version][example-version-shield] @@ -638,6 +651,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: AirSonos][airsonos-issue] - [Open an issue for the add-on: AppDaemon][appdaemon-issue] - [Open an issue for the add-on: Bookstack][bookstack-issue] +- [Open an issue for the add-on: EMQX][emqx-issue] - [Open an issue for the add-on: Example][example-issue] - [Open an issue for the add-on: FTP][ftp-issue] - [Open an issue for the add-on: Folding@home][foldingathome-issue] @@ -769,6 +783,15 @@ 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/5469236 +[addon-doc-emqx]: https://github.com/hassio-addons/addon-emqx/blob/5469236/README.md +[emqx-issue]: https://github.com/hassio-addons/addon-emqx/issues +[emqx-version-shield]: https://img.shields.io/badge/version-5469236-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 +[emqx-armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg +[emqx-i386-shield]: https://img.shields.io/badge/i386-no-red.svg [addon-example]: https://github.com/hassio-addons/addon-example/tree/ab2aaf9 [addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/ab2aaf9/README.md [example-issue]: https://github.com/hassio-addons/addon-example/issues diff --git a/emqx/CHANGELOG.md b/emqx/CHANGELOG.md new file mode 100644 index 000000000..66a6a9f1f --- /dev/null +++ b/emqx/CHANGELOG.md @@ -0,0 +1 @@ +- Remove unsupported architecture from build configuration diff --git a/emqx/DOCS.md b/emqx/DOCS.md new file mode 100644 index 000000000..4edc3b8f7 --- /dev/null +++ b/emqx/DOCS.md @@ -0,0 +1,130 @@ +# Home Assistant Community Add-on: EMQX + +[EMQX][emqx] is an Open-source MQTT broker with a high-performance real-time +message processing engine, powering event streaming for IoT devices at massive +scale. As the most scalable MQTT broker, EMQX can help you connect any device, +at any scale (including your home). + +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. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Click the Home Assistant My button below to open the add-on on your Home + Assistant instance. + + [![Open this add-on in your Home Assistant instance.][addon-badge]][addon] + +1. Click the "Install" button to install the 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. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +env_vars: + - name: EMQX_NODE__NAME + value: "something@else.local" +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `env_vars` + +This option allows you to tweak every aspect of EMQX by setting +configuration options using environment variables. See the example at the +start of this chapter to get an idea of how the configuration looks. + +For more information about using these variables, see the official EMQX +documentation: + + + +**Note**: _Only environment variables starting with `EMQX_` are accepted.\_ + +## Known issues and limitations + +- This add-on cannot run simultaneously with the Mosquitto add-on. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. + +Releases are based on [Semantic Versioning][semver], and use the format +of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented +based on the following: + +- `MAJOR`: Incompatible or major changes. +- `MINOR`: Backwards-compatible new features and enhancements. +- `PATCH`: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2022 Franck Nijhof + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg +[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_emqx&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository +[contributors]: https://github.com/hassio-addons/addon-emqx/graphs/contributors +[create-db]: https://github.com/hassio-addons/addon-influxdb/blob/main/influxdb/DOCS.md#integrating-into-home-assistant +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[emqx]: https://www.emqx.io/ +[forum]: https://community.home-assistant.io/?u=frenck +[frenck]: https://github.com/frenck +[influxdb-addon]: https://github.com/hassio-addons/addon-influxdb +[issue]: https://github.com/hassio-addons/addon-emqx/issues +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-emqx/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/emqx/README.md b/emqx/README.md new file mode 100644 index 000000000..d76e8a156 --- /dev/null +++ b/emqx/README.md @@ -0,0 +1,58 @@ +# Home Assistant Community Add-on: EMQX + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors] + +[![Support Frenck on Patreon][patreon-shield]][patreon] + +The most scalable open-source MQTT broker for IoT, IIoT, and connected vehicles. + +## About + +[EMQX][emqx] is an Open-source MQTT broker with a high-performance real-time +message processing engine, powering event streaming for IoT devices at massive +scale. As the most scalable MQTT broker, EMQX can help you connect any device, +at any scale (including your home). + +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. + +![EMQX in the Home Assistant Frontend][screenshot] + +## WARNING! THIS IS AN EDGE VERSION! + +This Home Assistant Add-ons repository contains edge builds of add-ons. +Edge builds add-ons are based upon the latest development version. + +- They may not work at all. +- 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. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[emqx]: https://www.emqx.io/ +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/?u=frenck +[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png +[github-sponsors]: https://github.com/sponsors/frenck +[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg +[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-production%20ready-brightgreen.svg +[release-shield]: https://img.shields.io/badge/version-5469236-blue.svg +[release]: https://github.com/hassio-addons/addon-emqx/tree/5469236 +[screenshot]: https://github.com/hassio-addons/addon-emqx/raw/main/images/screenshot.png \ No newline at end of file diff --git a/emqx/config.yaml b/emqx/config.yaml new file mode 100644 index 000000000..9f95e44aa --- /dev/null +++ b/emqx/config.yaml @@ -0,0 +1,27 @@ +arch: +- aarch64 +- amd64 +codenotary: codenotary@frenck.dev +description: The most scalable open-source MQTT broker for IoT. An alternative for + the Mosquitto add-on +host_network: true +image: ghcr.io/hassio-addons/emqx/{arch} +ingress: true +ingress_port: 18083 +ingress_stream: true +init: false +map: +- ssl +name: EMQX +options: + env_vars: [] +panel_icon: mdi:pipe +panel_title: EMQX +schema: + env_vars: + - name: match(^EMQX_([A-Z0-9_])+$) + value: str +slug: emqx +startup: services +url: https://github.com/hassio-addons/addon-emqx +version: '5469236' diff --git a/emqx/icon.png b/emqx/icon.png new file mode 100644 index 000000000..420a912f5 Binary files /dev/null and b/emqx/icon.png differ diff --git a/emqx/logo.png b/emqx/logo.png new file mode 100644 index 000000000..1294aefb5 Binary files /dev/null and b/emqx/logo.png differ