Merge branch 'main' into docs-k8s-refactor

Author: ppawlowski

.github/scripts/initial-setup.sh

@@ -207,7 +207,7 @@ curl -ks -w "\n" -XPOST \
                        "contextLimit": null,
                        "customHostnames":false,
                        "staticAssets":false,
-                       "teamBroker":true
+                       "teamBroker":false
                   },
                   "instances": {
                       "'"$projectTypeId"'": {

.github/workflows/branch-deploy.yaml

@@ -9,6 +9,8 @@ on:
       - closed
     paths-ignore:
       - 'docs/**'
+      - '**/.github/workflows/**'
+      - '!.github/workflows/branch-deploy.yaml'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.number }}

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Publish Documentation
+on:
+  push:
+    branches: [ main, maintenance ]
+    paths:
+      - 'docs/**'
+  pull_request:
+    paths:
+      - 'docs/**'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Test Documentation links
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Test Documentation Links
+        run: npm run test:docs
+  publish:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: test
+    name: Publish Documentation
+    steps:
+      - name: Generate token
+        id: generate_token
+        uses: tibdex/github-app-token@v2
+        with:
+          app_id: ${{ secrets.GH_BOT_APP_ID }}
+          private_key: ${{ secrets.GH_BOT_APP_KEY }}
+      
+      - name: Trigger website rebuild
+        uses: benc-uk/workflow-dispatch@v1
+        with:
+          workflow: build.yml
+          repo: flowfuse/website
+          ref: main
+          token: ${{ steps.generate_token.outputs.token }}

.github/workflows/publish.yml

@@ -26,7 +26,7 @@ jobs:
     if: |
       ( github.event.workflow_run.conclusion == 'success' && github.ref == 'refs/heads/main' ) ||
       ( github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' )
-    uses: 'flowfuse/github-actions-workflows/.github/workflows/publish_node_package.yml@v0.36.0'
+    uses: 'flowfuse/github-actions-workflows/.github/workflows/publish_node_package.yml@v0.37.0'
     with:
       package_name: flowfuse
       build_package: true

.github/workflows/test-docs.yml

@@ -4,6 +4,8 @@ forge:
   localPostgresql: true
   broker:
     enabled: true
+    teamBroker:
+      uiOnly: true
   cloudProvider: aws
   email:
     ses:

ci/ci-values.yaml

@@ -188,27 +188,33 @@ platform.
 
 #### Enterprise Team Broker
 
-Enterprise level teams come with their own MQTT broker. You can provision clients from the broker tab in the left hand menu.
+Both Team and Enterprise level teams come with their own MQTT broker. You can provision clients from the broker tab in the left hand menu.
 
-Teams can register up to 20 clients as part of their plan. The ability to purchase additional packs of clients will come in a future release.
+Enterprise level Teams can register up to 20 and Teams level Teams can register up to 5 clients as part of their plan. The ability to purchase additional packs of clients will come in a near future release.
 
 The broker is available on `broker.flowfuse.cloud` and supports the following connection types:
 
  - MQTT on port `1883`
  - MQTT over TLS on port `8883`
  - MQTT over secure WebSockets on port `443`
 
- When creating clients you can specify a username, but it will prepended to the the Team's id e.g. `alice` will become `alice@abcd1234`.
+ When creating clients you can specify a username, but it will prepended to the the Team's id e.g. `alice` will become `alice@32E4NEO5pY`.
  Clients must also use the username as the MQTT Client ID in order to connect.
 
  ![Create Broker Client](./images/create-broker-client.png)
 
  e.g.
 
  ```
- mosquitto_sub -u "alice@abcd1234" -i "alice@abcd1234" -P "password" -h broker.flowfuse.cloud -t "#"
+ mosquitto_sub -u "alice@32E4NEO5pY" -i "alice@32E4NEO5pY" -P "password" -h broker.flowfuse.cloud -t "#"
  ```
 
+ Or in Node-RED as follows
+
+![Node-RED MQTT Client Connection](./images/node-red-mqtt-connection.png)
+
+![Node-RED MQTT Client Security](./images/node-red-mqtt-security.png)
+
 ### IP Addresses
 
 Outbound connections from FlowFuse will always come from the IP address `63.33.85.112`. 

docs/cloud/images/create-broker-client.png

@@ -284,3 +284,8 @@ If you are running as your normal user you can drop the `sudo -u flowfuse` and j
 
 [^2]: Assumes you are running FlowFuse as a Linux service.
 [^3]: Assumes you are running FlowFuse as the `flowfuse` user as created by the installer
+
+
+## Uninstall
+
+To uninstall, stop all the running processes and then delete the `/opt/flowfuse` or `c:\flowfuse\` directory.

docs/cloud/images/node-red-mqtt-connection.png

@@ -12,8 +12,12 @@ meta:
 
 # FlowFuse Device Agent
 
-The FlowFuse platform can be used to manage Node-RED instances running on remote Devices.
-A Device runs a software agent that connects back to FlowFuse in order to receive updates.
+![FlowFuse Device Agent Workflow](./images/device-agent-workflow.png){data-zoomable}
+_Workflow to onboard new Edge Devices through the FlowFuse Platform and Device Agent_
+
+The FlowFuse platform can be used to manage Node-RED instances running on remote hardware, e.g. devices on your factory floor.
+
+By installing the FlowFuse Device Agent, you can securely connect your hardware to FlowFuse in order to manage and deploy Node-RED flows remotely.
 
 In order to connect your device to FlowFuse, and to allow FlowFuse to manage it, you'll need to do the following steps:
 

docs/cloud/images/node-red-mqtt-security.png

@@ -8,60 +8,102 @@ meta:
       - flowfuse
 ---
 
-# Developing Flows on Your Device
+# Quick Start Guide: Device Agent
 
-## Add Device to FlowFuse
+This guide will walk you through the process of adding a device to FlowFuse, connecting it to the platform, and deploying your Node-RED flows remotely. FlowFuse's Device Agent helps unlock the power of your devices by allowing you to manage and deploy Node-RED flows running on those devices securely and remotely.
 
-### Prerequisites
+![FlowFuse Device Agent Workflow](./images/device-agent-workflow.png){data-zoomable}
+_Workflow to onboard new Edge Devices through the FlowFuse Platform and Device Agent_
 
-If you do not already have the device agent installed, follow the [install instructions](./install.md), otherwise, proceed to the next step.
+## Setup & Installation
 
-_NOTE: It is good practice to keep your Device Agent up to date. Update instructions are also provided in the link above._
+### Step 1: Install Device Agent (On Device)
 
-_NOTE: If you prefer to use the Device Agent WEB UI, follow the [Quick Start with Web UI](./quickstart-web-ui.md) guide._
+NodeJS version 18 is supported but version 20 or later is recommended. However, if necessary, device agent version 2.8 does support NodeJS versions 14 and 16.
+
+For full install instructions, follow the [install instructions here](/docs/device-agent/install.md).
+
+#### Linux/MacOS
+
+```bash
+sudo npm install -g @flowfuse/device-agent
+```
+
+#### Windows
+
+Issue the below command in an elevated command prompt:
+
+```bash
+npm install -g @flowfuse/device-agent
+```
+
+### Step 2: Register Device (On FlowFuse)
 
-### Step 1: Add a new Device
 1. Open your web browser and go to your FlowFuse application page.
 2. Navigate to the **Devices** section.
 3. Click **Add Device.**
 4. Fill in the **Device Name** & **Device Type** and select an **Application**
 
-    <img src="images/add_device.png" />
+    ![Screenshot of the dialog form to fill out when registering a Device](./images/add_device.png){data-zoomable}
+    _Screenshot of the dialog form to fill out when registering a Device_
+    
 5. Click **Add**
 6. You will be presented with a **Device Configuration** that you will need in the next step. _(Do not close this window just yet.)_
 
-    <img src="images/config_yml2a.png"/>
+    ![Screenshot of the dialog shown to a suer when a Device is registered](./images/config_yml2a.png){data-zoomable}
+    _Screenshot of the dialog shown to a suer when a Device is registered_
+
+### Step 3: Connect the Device (On Device)
 
-### Step 2: Connect the Device
-1. Open a Terminal/Command Prompt.
-2. Paste the command copied from the previous step and run it.
+1. Open a Terminal/Command Prompt on the Device.
+2. Paste the command presented when you registered your Device, and run it.
+
+    ![Example output in a Terminal showing a device agent successfully connecting to the FlowFuse Platform](./images/device_cli.png){data-zoomable}
+    _Example output in a Terminal showing a device agent successfully connecting to the FlowFuse Platform_
+
+### Step 4: Start the Device Agent (On Device)
+
+1. Start the Device Agent using the command instructed by the device agent output e.g:
 
-    <img src="images/device_cli.png" />
-3. Start the Device Agent using the command instructed by the device agent output e.g:
    ```bash
    flowfuse-device-agent
    ```
 
 Your device is now connected to FlowFuse and ready to be used.
 
+## Deploy Flows to Device
+
+There are two approaches to deploying flows to your Devices.
+
+- **Developer Mode**: This mode allows you to edit and deploy flows directly from the FlowFuse platform.
+- **DevOps Pipelines**: FlowFuse provides [DevOps Pipelines](/docs/user/devops-pipelines.md) as a way of pushing flows from one Instance/Device to another (or several in the case of [Device Groups](/docs/user/device-groups.md)). This is the recommended approach if you're pushing from development environments (e.g. test devices) out to production devices.
+
+### Developer Mode
 
-## Develop on Device
-### Enable Developer Mode
 1. Navigate to **Applications** and select the application your device was added to.
 2. Go to the **Devices** tab within the application.
 3. Locate your newly added device and **click** on your device.
 4. Then Click **Developer Mode** toggle button on upper right.
 
-    <img src="images/developer.png" />
+    ![The "Developer Mode" toggle button available on the Device screen](./images/developer.png){data-zoomable}
+    _The "Developer Mode" toggle button available on the Device screen_
 
 5. This will enable editor access for your device.
 
-    <img src="images/editorEnabled.png"/>
+    ![The "Device Editor" button available on the Device screen](./images/editorEnabled.png){data-zoomable}
+    _The "Device Editor" button available on the Device screen_
 
 6. Clicking **Device Editor** will launch the editor.
 
-    <img src="images/nr_editor.png" />
+    ![Screenshot of a Node-RED Editor for a Device](./images/nr_editor.png){data-zoomable}
+    _Screenshot of a Node-RED Editor for a Device_
+
+### DevOps Pipelines
+
+![Screenshot showing the user interface for creating and running DevOps Pipelines in FlowFuse](../user/images/ui-devops-pipelines.png){width=750}{data-zoomable}
+_Screenshot showing the user interface for creating and running DevOps Pipelines in FlowFuse_
 
+To work with Pipelines, you need at least one other Instance or Device to push _from_/_to_. You can follow hte instructions on setting up a Pipeline and deploying your flows between Instances/Devices [DevOps Pipelines](/docs/user/devops-pipelines.md).
 
 ## Next Steps