Add Home Assistant MQTT and Node-Red documentation #272
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduced a new documentation page for Homeassistant within the sandbox apps section of the docs. The page outlines the purpose of Homeassistant, provides important links such as project home, docs, GitHub, and Docker, and details steps for installation and accessing the web interface. It advises on the complexity of remote server setup and informs that the role isn't protected by default Authelia/SSO middleware.
Extended the documentation navigation to include a new section on Home Automation--specifically, the addition of Home Assistant. This update makes it easier for users to find information on integrating Home Automation solutions with our platform.
Added documentation links for MQTT and Node-Red to the Home Automation subsection in the navigation of the project's MkDocs configuration. This update ensures users have access to a wider range of resources for setting up and managing their home automation systems.
Standardized the capitalization of 'Homeassistant' to 'homeassistant' for consistency across our documentation. Also introduced documentation links for MQTT and Node-RED to the sandbox apps index, expanding our coverage of supported applications.
Enhanced the MQTT installation instructions with corrected code block formatting for better readability. Added setup instructions to the Node-RED documentation to include a palette for integration with Home Assistant, facilitating easier connection setups for users.
- Clarified that Home Assistant has its own authentication system and added a new section for Home Assistant Community Store (HACS) addons. - Removed redundant setup instructions in MQTT documentation and added a note regarding the lack of a web interface. - Corrected Node Red description to reflect its actual use as a visual programming tool. Adjusted warning to reflect that Node Red is now protected by Authelia/SSO middleware and reorganized setup instructions for clearer readability.
Added a note to the Home Assistant documentation clarifying that while Nabu Casa is not necessary for remote access, it is an available paid service that supports the project. Further emphasized that the current setup is prepared for use with a reverse proxy as an alternative to Nabu Casa for remote access.
Updated the documentation to reflect the accurate URLs and project information for MQTT (Eclipse Mosquitto) and Node-Red. Enhanced the MQTT section with clearer setup instructions, including security best practices, and corrected links to MQTT's official resources. For Node-Red, clarified the installation and setup guide, and provided updated URLs to Node-Red's home, documentation, and Docker hub. These changes ensure users have the latest information and a more secure, streamlined setup process for both applications.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added basic instructions for each role. Added setup instructions to the Node-RED documentation to include a palette for integration with Home Assistant, facilitating easier connection setups for users.
Added Home Assistant, MQTT, and Node-Red to both
index.mdandmkdocs.yml. Added a Home Automation section under "Utilities" to fit them in.