Merge remote-tracking branch 'upstream/main' into fix/missing-loading-state

Author: harshrajeevsingh

.github/workflows/branch-deploy.yaml

@@ -252,7 +252,7 @@ jobs:
           mask-password: true
 
       - name: Login to GHCR
-        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1 # v3.5.0
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}

.github/workflows/docs.yml

@@ -49,7 +49,7 @@ jobs:
           path: 'blueprint-library'
           token: ${{ steps.generate_token.outputs.token }}
       - name: Cache image pipeline output
-        uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
+        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
         with:
           key: img-pipeline-cache
           path: website/_site/img         

.github/workflows/release-publish.yml

@@ -18,6 +18,6 @@ jobs:
       - run: npm ci
       - run: npm run build
       # - run: npm run test
-      - uses: JS-DevTools/npm-publish@ad693561f8a5b5d4c76f14407da60aa15cb10f90 # v4.0.1
+      - uses: JS-DevTools/npm-publish@7f8fe47b3bea1be0c3aec2b717c5ec1f3e03410b # v4.1.1
         with:
           token: ${{ secrets.NPM_PUBLISH_TOKEN }}

CHANGELOG.md

@@ -1,3 +1,26 @@
+#### 2.22.0: Release
+
+ - docs: Rearrange Device Agent documentation (#5977)
+ - Expose SAML SSO groups to Dashboard (#6041) @hardillb
+ - Update device local auth docs (#6047) @hardillb
+ - Bump JS-DevTools/npm-publish from 4.0.0 to 4.0.1 (#6048) @app/dependabot
+ - Add @flowfuse-nodes scope to Certified Nodes (#6045) @hardillb
+ - Team broker schema agent (#6003) @hardillb
+ - Revised snapshot descriptions (#6014) @cstns
+ - Standardize right drawer header (#6013) @cstns
+ - Modularize drawer logic by extracting them into a dedicated vuex module (#6004) @cstns
+ - Docs: Adds clarification of data retention for FlowFuse Assistant (#6030) @joepavitt
+ - Docs: Modernise the FlowFuse Assistant documentation (#6026) @joepavitt
+ - fix: close search overlay when tabbing out of search control (#6024) @harshrajeevsingh
+ - Adds support for closing the right drawer when pressing the Escape key (#6010) @cstns
+ - Bump vite from 6.3.5 to 6.3.6 (#6000) @app/dependabot
+ - Bump JS-DevTools/npm-publish from 3.1.1 to 4.0.0 (#6023) @app/dependabot
+ - Bump axios from 1.8.3 to 1.12.1 (#6020) @app/dependabot
+ - Fix owner id in snapshot AI request (#6016) @Steve-Mcl
+ - Replace the permissions mixin with it's composable counterpart (#5993) @cstns
+ - Add api to generate remote instance snapshot description (#5966) @cstns
+ - Fix UI lock up when binding tables values with non utf encodings (#5986) @cstns
+
 #### 2.21.2: Release
 
  - Bump aws-actions/configure-aws-credentials from 4.3.1 to 5.0.0 (#5994)

docs/device-agent/images/device_local_access.png

@@ -27,6 +27,10 @@ The FlowFuse Device Agent Installer is the easiest way to get the FlowFuse Devic
 - Internet connection for downloading dependencies
 - Administrator/root privileges for system service installation
 
+### Networking requirements
+
+Please see [Networking requirements](./overview.md#networking-requirements).
+
 ## Use the FlowFuse Device Agent Installer to install or update the FlowFuse Device Agent
 
 ### One-line install
@@ -135,7 +139,9 @@ To update the Device Agent package, use the `--update-agent` flag, optionally sp
 
 Specifying `--update-agent` without the `--agent-version` flag will update to the latest available version.
 
-## Managing
+## Troubleshooting
+
+### Managing the Device Agent service
 
 Services are named per-port, for example `flowfuse-device-agent-1880`. On macOS, the launchd label is `com.flowfuse.device-agent-1880`.
 
@@ -145,7 +151,6 @@ Services are named per-port, for example `flowfuse-device-agent-1880`. On macOS,
 sudo systemctl start flowfuse-device-agent-<port>
 sudo systemctl stop flowfuse-device-agent-<port>
 sudo systemctl restart flowfuse-device-agent-<port>
-sudo systemctl status flowfuse-device-agent-<port>
 ```
 
 #### Linux (SysVinit)
@@ -154,7 +159,6 @@ sudo systemctl status flowfuse-device-agent-<port>
 sudo service flowfuse-device-agent-<port> start
 sudo service flowfuse-device-agent-<port> stop
 sudo service flowfuse-device-agent-<port> restart
-sudo service flowfuse-device-agent-<port> status
 ```
 
 #### Linux (OpenRC)
@@ -163,7 +167,6 @@ sudo service flowfuse-device-agent-<port> status
 sudo rc-service flowfuse-device-agent-<port> start
 sudo rc-service flowfuse-device-agent-<port> stop
 sudo rc-service flowfuse-device-agent-<port> restart
-sudo rc-service flowfuse-device-agent-<port> status
 ```
 
 #### macOS (launchd)
@@ -172,18 +175,52 @@ sudo rc-service flowfuse-device-agent-<port> status
 sudo launchctl start com.flowfuse.device-agent-<port>
 sudo launchctl stop com.flowfuse.device-agent-<port>
 sudo launchctl kickstart -k system/com.flowfuse.device-agent-<port>
-sudo launchctl print system/com.flowfuse.device-agent-<port>
 ```
 
 #### Windows (Service Control)
 
 ```bash
 sc.exe start flowfuse-device-agent-<port>
 sc.exe stop flowfuse-device-agent-<port>
+```
+
+
+### Check the Device Agent service status
+
+You can check the status of the Device Agent service to verify if it is running correctly or to diagnose any issues. 
+The status command provides information about the current state of the service, including whether it is active, inactive, or failed.
+
+#### Linux (systemd)
+
+```bash
+sudo systemctl status flowfuse-device-agent-<port>
+```
+
+#### Linux (SysVinit)
+
+```bash
+sudo service flowfuse-device-agent-<port> status
+```
+
+#### Linux (OpenRC)
+
+```bash
+sudo rc-service flowfuse-device-agent-<port> status
+```
+
+#### macOS (launchd)
+
+```bash
+sudo launchctl print system/com.flowfuse.device-agent-<port>
+```
+
+#### Windows (Service Control)
+
+```bash
 sc.exe query flowfuse-device-agent-<port>
 ```
 
-## Viewing Device Agent log files
+### Viewing Device Agent log files
 
 Adjust the path if custom directory has been specified during installation.
 
@@ -203,6 +240,35 @@ journalctl -f -u 'flowfuse-device-agent-<port>'
 Get-Content -Path 'C:\opt\flowfuse-device\flowfuse-device-agent.log' -Wait
 ```
 
+### Error: Disk space check failed
+
+> [ERROR] Disk space check failed: insufficient disk space in temporary directory (/tmp): need at least 500.0 MB, available 490.4 MB
+
+##### Cause:
+The `Disk space check failed` error indicates that the installer has detected insufficient disk space in the temporary directory.
+The FlowFuse Device Agent Installer requires a minimum of 500MB of free disk space in the temporary directory to ensure proper installation.
+
+This error might also appear if there is not enough space on the disk partition where the Device Agent is being installed.
+Make sure that the target installation directory has at least 500MB of free space available.
+[Adjust installation directory](/docs/device-agent/install/device-agent-installer/#install-in-custom-directory) accordingly.
+
+##### Solution:
+To fix this issue, you can try to free up some disk space by deleting unnecessary files or moving them to another location.
+Alternatively, you can specify a different temporary directory with sufficient space by setting proper environmental variable before running the installer.
+
+**On Linux/macOS**, set the `TMPDIR` environment variable:
+
+```bash
+export TMPDIR=/path/to/existing/directory/with/sufficient/space
+```
+
+**On Windows**, you can set the `TEMP` or `TMP` environment variable:
+```powershell
+Set TMP="C:\path\to\existing\directory\with\sufficient\space"
+```
+
+Retry installation after making these adjustments.
+
 ## Further reading
 
 For more detailed technical information about the FlowFuse Device Agent, like list of supported parameters or how to contribute, please refer to the [documentation](https://github.com/FlowFuse/device-agent/blob/main/installer/README.md).

docs/device-agent/install/device-agent-installer.md

@@ -20,6 +20,10 @@ Use this method if you want direct control over the Node.js runtime and filesyst
 - Linux, macOS, or Windows
 - Outbound network access to FlowFuse platform and the NPM registry
 
+### Networking requirements
+
+Please see [Networking requirements](./overview.md#networking-requirements).
+
 ## Install the Device Agent
 
 The Device Agent is published to npm as [@flowfuse/device-agent](https://www.npmjs.com/package/@flowfuse/device-agent).
@@ -103,19 +107,6 @@ flowfuse-device-agent -v
 
 Once assigned, access the Node-RED editor at `http://<device-ip>:1880`.
 
-## Networking requirements
-
-Allow outbound TCP 443 to:
-
-- app.flowfuse.com
-- mqtt.flowfuse.cloud
-
-Ensure access to npm registry to download Node-RED and nodes:
-
-- https://registry.npmjs.com
-
-For offline environments, see [Running with no access to npmjs.org](../running.md#running-with-no-access-to-npmjs.org).
-
 ## Upgrading the agent
 
 With Device Agent 1.13+, the package moved from the `@flowforge` scope to `@flowfuse`:

docs/device-agent/install/manual.md

@@ -35,6 +35,24 @@ Most users should use the Device Agent Installer. Power users can choose Manual
 
 Note: The Device Agent downloads the required Node-RED version and any nodes specified by the assigned snapshot. Ensure firewall/proxy permits access to the npm registry or see [Running with no access to npmjs.org](../running.md#running-with-no-access-to-npmjs.org).
 
+### Networking requirements
+
+If you're working behind a firewall, and need to configure it to allow the Device Agent to connect to FlowFuse and the npm registry, see the following:
+
+Allow outbound TCP 443 to:
+
+- app.flowfuse.com
+- mqtt.flowfuse.cloud
+- registry.flowfuse.cloud
+- registry.flowfuse.com
+
+Ensure access to npm registry to download Node-RED and nodes:
+
+- https://registry.npmjs.com
+
+For offline environments, see [Running with no access to npmjs.org](../running.md#running-with-no-access-to-npmjs.org).
+
+
 ## Verify the installation
 
 After installing by any method:

docs/device-agent/install/overview.md

@@ -19,6 +19,8 @@ The FlowFuse platform can be used to manage Node-RED Remote Instances running on
 
 By installing the FlowFuse Device Agent, you can securely connect your hardware to FlowFuse in order to manage and deploy Node-RED flows remotely.
 
+**Note:** The FlowFuse Device Agent will install Node-RED when the agent receives a snapshot to run from FlowFuse.
+
 In order to connect your device to FlowFuse, and to allow FlowFuse to manage it, you'll need to do the following steps:
 
 - [Quick Start Guide](/docs/device-agent/quickstart.md) - Install on a device and remotely edit through FlowFuse Cloud.

docs/device-agent/introduction.md

@@ -338,6 +338,13 @@ httpStatic:
 
 This option can be used to enable local login for the Node-RED editor.  This option is not recommended for day to day use.
 
+It can be configured under the Remote Instance's Settings
+
+![Local Auth settings for Remote Instance](./images/device-local-access.png){data-zoomable}
+_Local Auth settings for Remote Instance_
+
+Or by adding the following to the `device.yml` file
+
 ```yml
 localAuth:
     enabled: true