Merge pull request #1805 from omrid01/main

Configuring Node-RED dashboard 2.0 on Home Assistant

Author: Steve-Mcl

docs/.vitepress/config/config.js

@@ -32,7 +32,8 @@ export default {
                             { text: locale.sidebar['ui-template-examples'] || en.sidebar['ui-template-examples'], link: '/user/template-examples' },
                             { text: locale.sidebar['multi-tenancy'] || en.sidebar['multi-tenancy'], link: '/user/multi-tenancy' },
                             { text: locale.sidebar['subflows'] || en.sidebar['subflows'], link: '/user/subflows' },
-                            { text: locale.sidebar['installing-on-mobile'] || en.sidebar['installing-on-mobile'], link: '/user/pwa' }
+                            { text: locale.sidebar['installing-on-mobile'] || en.sidebar['installing-on-mobile'], link: '/user/pwa' },
+                            { text: locale.sidebar['installing-on-home-assistant'] || en.sidebar['installing-on-home-assistant'], link: '/user/home-assistant' }
                         ]
                     },
                     {
@@ -135,4 +136,4 @@ export default {
             }
         }
     }
-}
+}

docs/.vitepress/config/locales/en-US.json

@@ -20,6 +20,7 @@
         "multi-tenancy": "Multi-Tenancy",
         "subflows": "Subflows",
         "installing-on-mobile": "Installing on Mobile",
+        "installing-on-home-assistant": "Home Assistant",
         "nodes": "Nodes",
         "config-nodes": "Config Nodes",
         "layouts": "Layouts",

docs/assets/images/ha1-new-dashboard.png

@@ -0,0 +1,28 @@
+# Running Node-RED with Home Assistant
+
+Node-RED can be integrated with Home Assistant (**HA**) in 2 modes:
+1. Running Node-RED on an separate host, and connecting to the HA server via HTTP messaging or through the `node-red-contrib-home-assistant-websocket` node-set
+   
+2. Using the internal Node-RED add-on within HA, which comes as part of the default HA installation
+
+### Configuring FlowFuse Dashboard (Node-RED dashboard 2.0) in Home Assistant
+
+As of today, the Node-RED add-on within HA includes the Node-RED dashboard 1.0 nodes (`node-red-dashboard`), and exposes its base URL (`.../ui`). However, Node-RED Dashboard 1.0 is now deprecated and has been replaced by FlowFuse Dashboard. 
+
+Below are guidelines for installing & configuring FlowFuse Dashboard in the Node-RED add-on within HA
+
+1. Within the Node-RED add-on, install the FlowFuse Dashboard node-set (`@flowfuse/node-red-dashboard`) using the "Manage Palette" option.
+
+2. Create a new iframe container for hosting the FlowFuse Dashboard clients:
+  - In HA, go to **Settings->Dashboards->Add dashboard**, select **Webpage**
+    
+  <img src="../../assets/images/ha1-new-dashboard.png" alt="Adding a new dashboard iFrame" data-zoomable><br>*Adding a new dashboard iFrame*<br><br>
+  - Set the base URL of the dashboard, e.g. `<HA host>:1880/endpoint/dashboard`
+    
+  <img src="../../assets/images/ha2-set-dashboard-url.png" alt="Setting the base URL" data-zoomable><br>*Setting the base URL*<br><br>
+   - Set the iframe title & optional icon (which will show in the HA sidebar), and click **Create**
+     
+  <img src="../../assets/images/ha3-set-title-icon.png" alt="Setting the title & icon" data-zoomable><br>*Setting the title & icon*<br><br>
+  - You can now open the FlowFuse Dashboard from the HA sidebar, or directly via the endpoint URL defined above
+  
+  <img src="../../assets/images/ha4-show-dashboard.png" alt="Viewing the FlowFuse dashboard" data-zoomable><br>*Viewing the FlowFuse dashboard*