diff --git a/docs/README.md b/docs/README.md index cca808559c..699d6df20a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,19 +15,6 @@ meta: - contributing --- - # FlowFuse Documentation @@ -45,31 +32,31 @@ It covers everything from setup, to usage, and development. All [contributions](
  • Quick Start Instructions - +
  • Install FlowFuse Self-Hosted - +
  • Upgrade Your FlowFuse Instance - +
  • Unlock Enterprise Features - +
  • Administering FlowFuse - +
    • @@ -78,10 +65,10 @@ It covers everything from setup, to usage, and development. All [contributions](

    Hosted solution, nothing to install anything, jump straight in.

    @@ -140,9 +127,7 @@ Here are some quick reference links to our most popular topics. You can also vie
    - - - +
    @@ -168,7 +153,6 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our
    -
    @@ -194,38 +178,38 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our

    A complete set of FlowFuse-maintained nodes for data sharing between instances, MQTT messaging, AI/ONNX models, MCP agent integrations, and enterprise data features.

    Create interactive, responsive and secure Dashboards in Node-RED.

    Manage thousands of Node-RED Instances remotely with the FlowFuse Device Agent.

    AI in the Node-RED Editor to help build your flows.

    @@ -240,106 +224,3 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our - [Development Setup](./contribute/introduction/#development-setup) - Configure your local development environment to contribute to FlowFuse. - [Testing](./contribute/introduction/#testing) - Understand our testing philosophy at FlowFuse. - - - - diff --git a/docs/admin/introduction.md b/docs/admin/introduction.md index c095a82ff0..fe938548e4 100644 --- a/docs/admin/introduction.md +++ b/docs/admin/introduction.md @@ -242,7 +242,7 @@ drop-down menu in the stack table. This allows the platform to notify users that an update is available for their instance, allowing them to upgrade the stack at their convenience. -![Screenshot of FlowFuse showing where admins can create new stacks](./images/admin-stacks-create-new-version.png){data-zoomable} +![Screenshot of FlowFuse showing where admins can create new stacks](./images/admin-stacks-create-new-version.png) Screenshot of FlowFuse showing where admins can create new stacks Node-RED instances that use the old stack will offer the new stack as a one-click upgrade option. @@ -251,7 +251,7 @@ Node-RED instances that use the old stack will offer the new stack as a one-clic Alternatively, click 'Create stack' to create an entirely new stack. -![Screenshot of FlowFuse showing the "Create Stack" dialog](./images/admin-stack-create.png){data-zoomable} +![Screenshot of FlowFuse showing the "Create Stack" dialog](./images/admin-stack-create.png) Screenshot of FlowFuse showing the "Create Stack" dialog When prompted for the Node-RED version, the value here depends on the setup you're running: diff --git a/docs/device-agent/deploy.md b/docs/device-agent/deploy.md index d72e091502..e91d2a8775 100644 --- a/docs/device-agent/deploy.md +++ b/docs/device-agent/deploy.md @@ -77,7 +77,7 @@ the Remote Instance can be placed in Developer Mode that enables remote access t * Local access to the editor can be enabled by defining a Username & Password in the Device Settings -> Security and enabling "Allow offline access" - ![Device Allow Offline Access Settings](./images/device-local-access.png){data-zoomable} + ![Device Allow Offline Access Settings](./images/device-local-access.png) _Device Allow Offline Access Srttings_ Whilst in Developer Mode the Remote Instance will not receive new updates from the platform. diff --git a/docs/device-agent/introduction.md b/docs/device-agent/introduction.md index 9bf7ab472c..2cac208e21 100644 --- a/docs/device-agent/introduction.md +++ b/docs/device-agent/introduction.md @@ -12,7 +12,7 @@ meta: # FlowFuse Device Agent -![FlowFuse Device Agent Workflow](./images/device-agent-workflow.png){data-zoomable} +![FlowFuse Device Agent Workflow](./images/device-agent-workflow.png) _Workflow to onboard new Remote Instances through the FlowFuse Platform and Device Agent_ The FlowFuse platform can be used to manage Node-RED Remote Instances running on remote hardware, e.g. devices on your factory floor. diff --git a/docs/device-agent/quickstart.md b/docs/device-agent/quickstart.md index e886d5e329..64bc05d747 100644 --- a/docs/device-agent/quickstart.md +++ b/docs/device-agent/quickstart.md @@ -12,7 +12,7 @@ meta: 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. -![FlowFuse Device Agent Workflow](./images/device-agent-workflow.png){data-zoomable} +![FlowFuse Device Agent Workflow](./images/device-agent-workflow.png) _Workflow to onboard new Remote Instances through the FlowFuse Platform and Device Agent_ ## Video Walkthrough @@ -28,13 +28,13 @@ This video will walk you through every step from creating a remote instance, ins 3. Click **Add Remote Instance.** 4. Fill in the **Name** & **Type** and select an **Application** - ![Screenshot of the dialog form to fill out when registering a Device](./images/add_remote_instance.png){data-zoomable}{ style="max-width: 600px"; } + ![Screenshot of the dialog form to fill out when registering a Device](./images/add_remote_instance.png){ style="max-width: 600px"; } _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.)_ - ![Screenshot of the dialog shown to a user when a Device is registered](./images/config_yml2a.png){data-zoomable} + ![Screenshot of the dialog shown to a user when a Device is registered](./images/config_yml2a.png) _Screenshot of the dialog shown to a user when a Device is registered_ 7. Copy the installation command. You will need it in next step. @@ -46,7 +46,7 @@ This video will walk you through every step from creating a remote instance, ins 3. Answer prompts as needed. 4. Installer will set up the runtime and configure the Device Agent, and summarize on successful completion. - ![Example output in a Terminal showing a device agent successfully installed](./images/installer_output.png){data-zoomable} + ![Example output in a Terminal showing a device agent successfully installed](./images/installer_output.png) _Example output in a Terminal showing a device agent successfully installed_ Your device is now connected to FlowFuse and ready to be used. @@ -65,22 +65,22 @@ There are two approaches to deploying flows to your Remote Instances. 3. Locate your newly added device and **click** on your Remote Instance. 4. Then Click **Developer Mode** toggle button on upper right. - ![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](./images/developer.png) _The "Developer Mode" toggle button available on the Device screen_ 5. This will enable editor access for your device. - ![The "Device Editor" button available on the Device screen](./images/editorEnabled.png){data-zoomable} + ![The "Device Editor" button available on the Device screen](./images/editorEnabled.png) _The "Device Editor" button available on the Device screen_ 6. Clicking **Device Editor** will launch the editor. - ![Screenshot of a Node-RED Editor for a Device](./images/nr_editor.png){data-zoomable} + ![Screenshot of a Node-RED Editor for a Device](./images/nr_editor.png) _Screenshot of a Node-RED Editor for a Device_ ### DevOps Pipelines -![Screenshot showing the user interface for creating and running DevOps Pipelines in FlowFuse](./images/ui-devops-pipelines.png){width=750}{data-zoomable} +![Screenshot showing the user interface for creating and running DevOps Pipelines in FlowFuse](./images/ui-devops-pipelines.png){width=750} _Screenshot showing the user interface for creating and running DevOps Pipelines in FlowFuse_ To work with Pipelines, you need at least one other Hosted Instance or Remote Device to push _from_/_to_. You can follow the instructions on setting up a Pipeline and deploying your flows between Hosted Instances/Remote Instances [DevOps Pipelines](/docs/user/devops-pipelines.md). diff --git a/docs/device-agent/register.md b/docs/device-agent/register.md index 345383b33e..6699bd5b8d 100644 --- a/docs/device-agent/register.md +++ b/docs/device-agent/register.md @@ -73,19 +73,19 @@ This approach provides you with a single "Provisioning Token" for all of your Re * Select an **Application** if you want the device to be automatically assigned to an application. 6. Click **Create** -![Screenshot of a FlowFuse Remote Instance Provisioning Token](./images/create-provisioning-token.png){data-zoomable} +![Screenshot of a FlowFuse Remote Instance Provisioning Token](./images/create-provisioning-token.png) Once the Provisioning Token has been created, you will be shown the **Device Provisioning Configuration** dialog: -![Screenshot of a FlowFuse Remote Instance Provisioning Token](./images/provisioning-token.png){data-zoomable} +![Screenshot of a FlowFuse Remote Instance Provisioning Token](./images/provisioning-token.png) **IMPORTANT:** This is the only time the platform will show you this information. Make sure to take a copy or use the **Download** button to save the configuration file locally. Once the token is created, it will be shown in the list of tokens on the **Provisioning** tab. -![Screenshot of FlowFuse Remote Instance Provisioning Tokens](./images/provisioning-tokens.png){data-zoomable} +![Screenshot of FlowFuse Remote Instance Provisioning Tokens](./images/provisioning-tokens.png) ## Connecting your Hardware @@ -342,7 +342,7 @@ This option can be used to enable local login for the Node-RED editor. This opt 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](./images/device-local-access.png) _Local Auth settings for Remote Instance_ Or by adding the following to the `device.yml` file diff --git a/docs/install/docker/README.md b/docs/install/docker/README.md index 50729d5313..2ccf632b71 100644 --- a/docs/install/docker/README.md +++ b/docs/install/docker/README.md @@ -12,45 +12,6 @@ meta: - nodered --- - # Docker Install @@ -65,19 +26,26 @@ The following guide walks through a full production-ready deployment. If you wan
    - - - - + ::ChecklistItem{task="Domain Name"} + :: + ::ChecklistItem{task="Docker Engine & Docker Compose"} + :: + ::ChecklistItem{type="recommended" task="Setup Dedicated Database"} + :: + ::ChecklistItem{type="recommended" task="Prepare TLS Certificates"} + ::
    - - - + ::ChecklistItem{task="Download FlowFuse"} + :: + ::ChecklistItem{task="Configure FlowFuse"} + :: + ::ChecklistItem{type="recommended" task="Enable HTTPS"} + ::
    diff --git a/docs/install/introduction.md b/docs/install/introduction.md index 4ddb26668d..a8741a201d 100644 --- a/docs/install/introduction.md +++ b/docs/install/introduction.md @@ -10,10 +10,6 @@ meta: - kubernetes - trial license - deployment models -templateEngineOverride: njk,md -installationServiceHubspot: - formId: "22edc659-d098-4767-aeb1-6480daae41ad" - targetId: "hs-form-installation-service" --- # Installing FlowFuse @@ -40,8 +36,5 @@ for any specific actions required. If you need assistance, request our complimentary Installation Service, and we will help you install FlowFuse. -{% set formId = installationServiceHubspot.formId %} -{% set targetId = installationServiceHubspot.targetId %} -{% set cta = "cta-request-installation-service" %} -{% set reference = "docs-install-intro" %} -{% include "hubspot/hs-form.njk" %} \ No newline at end of file +::HubSpotForm{formId="22edc659-d098-4767-aeb1-6480daee41ad" cta="cta-request-installation-service" reference="docs-install-intro"} +:: \ No newline at end of file diff --git a/docs/install/kubernetes/README.md b/docs/install/kubernetes/README.md index 15dd3ed3c7..a305150ae2 100644 --- a/docs/install/kubernetes/README.md +++ b/docs/install/kubernetes/README.md @@ -11,45 +11,6 @@ meta: - mqtt --- - # Kubernetes Install @@ -62,19 +23,26 @@ By the end, you will have a fully functioning FlowFuse instance running on a Kub
    - - - - + ::ChecklistItem{task="Domain Name"} + :: + ::ChecklistItem{task="Kubernetes cluster"} + :: + ::ChecklistItem{type="recommended" task="Setup Dedicated Database"} + :: + ::ChecklistItem{type="recommended" task="Prepare TLS Certificates"} + ::
    - - - + ::ChecklistItem{task="Download FlowFuse"} + :: + ::ChecklistItem{task="Configure FlowFuse"} + :: + ::ChecklistItem{type="recommended" task="Enable HTTPS"} + ::
    diff --git a/docs/install/kubernetes/openshift.md b/docs/install/kubernetes/openshift.md index 4a9ca8d539..99e0a101a3 100644 --- a/docs/install/kubernetes/openshift.md +++ b/docs/install/kubernetes/openshift.md @@ -11,45 +11,6 @@ meta: - helm --- - # OpenShift Install @@ -62,20 +23,28 @@ By the end, you will have a fully functioning FlowFuse instance running on a Ope
    - - - - - + ::ChecklistItem{task="Domain Name"} + :: + ::ChecklistItem{task="OpenShift cluster"} + :: + ::ChecklistItem{task="FlowFuse License"} + :: + ::ChecklistItem{type="recommended" task="Setup Dedicated Database"} + :: + ::ChecklistItem{type="recommended" task="Prepare TLS Certificates"} + ::
    - - - + ::ChecklistItem{task="Download FlowFuse"} + :: + ::ChecklistItem{task="Configure FlowFuse"} + :: + ::ChecklistItem{type="recommended" task="Enable HTTPS"} + ::
    diff --git a/docs/user/bill-of-materials.md b/docs/user/bill-of-materials.md index a3dffaa3af..7b628d093c 100644 --- a/docs/user/bill-of-materials.md +++ b/docs/user/bill-of-materials.md @@ -11,7 +11,7 @@ The Application Bill of Materials (BoM) provides a comprehensive overview of all The BoM is located in the **Dependencies** tab of each application. -![bom.png](images/bom.png){data-zoomable} +![bom.png](images/bom.png) ## Search Functionality diff --git a/docs/user/custom-npm-packages.md b/docs/user/custom-npm-packages.md index 1a79218ec7..9472a84fcf 100644 --- a/docs/user/custom-npm-packages.md +++ b/docs/user/custom-npm-packages.md @@ -35,7 +35,7 @@ only need to be done once. The credentials can be found by navigating to the "Custom Nodes" tab under the Team Library and clicking on the "Publish" button. -![Publish Custom Package](./images/publish-custom-package.png){data-zoomable}{style="max-width: 600px;"} +![Publish Custom Package](./images/publish-custom-package.png){style="max-width: 600px;"} _Screenshot fo the "Publish Custom Package" dialog shown in the FlowFuse UI_ ``` @@ -77,7 +77,7 @@ npm publish Once published you should see the Node listed in the "Custom Nodes" section of the Team Library. -![Screenshot of the "Custom Nodes" view in the Team Library](./images/custom-node-library.png){data-zoomable}{style="max-width: 850px;"} +![Screenshot of the "Custom Nodes" view in the Team Library](./images/custom-node-library.png){style="max-width: 850px;"} _Screenshot of the "Custom Nodes" view in the Team Library_ ### Installing Nodes @@ -85,7 +85,7 @@ _Screenshot of the "Custom Nodes" view in the Team Library_ Any packages uploaded to the Team Library will be published to your Instances under a custom catalogue with the name "FlowFuse Team [team name] Catalogue" -![Node-RED Custom Catalogue](./images/custom-catalogue.png){data-zoomable}{style="max-width: 600px;"} +![Node-RED Custom Catalogue](./images/custom-catalogue.png){style="max-width: 600px;"} _Screenshot of the contents of a FlowFUse catalogue appearing in the "install" tab of the Node-RED Palette Manager_ ## 3rd Party NPM Registries or Private npmjs.org packages @@ -101,7 +101,7 @@ in the Instance Settings. This can include authentication tokens to access private packages. -![.npmrc file](./images/instance-settings-npmrc.png){data-zoomable}{style="max-width: 600px;"} +![.npmrc file](./images/instance-settings-npmrc.png){style="max-width: 600px;"} _Screenshot from the FlowFuse platform, showing the input for defining an .npmrc file_ ### Node-RED Catalogues @@ -110,5 +110,5 @@ In order to be able to install packages in the Node-RED editor they need to in a Node-RED Catalogue file that is loaded from a HTTPS URL. You can supply a list of Catalogue URLs in the Instance Settings. -![Node Catalogues](./images/instance-settings-catalogues.png){data-zoomable}{style="max-width: 600px;"} +![Node Catalogues](./images/instance-settings-catalogues.png){style="max-width: 600px;"} _Screenshot of the listed Node Catalogues configured on an Instance_ \ No newline at end of file diff --git a/docs/user/device-groups.md b/docs/user/device-groups.md index 22b5390b37..7eaee2c9f5 100644 --- a/docs/user/device-groups.md +++ b/docs/user/device-groups.md @@ -8,7 +8,7 @@ navTitle: Groups ## Overview -![Groups UI](./images/groups.png){data-zoomable} +![Groups UI](./images/groups.png) Groups help you organize and manage multiple devices that run the same [snapshot](./snapshots.md) configuration. By grouping devices logically, you can deploy updates to dozens or even hundreds of devices simultaneously through [DevOps Pipelines](./devops-pipelines.md). @@ -32,7 +32,7 @@ Groups help you organize and manage multiple devices that run the same [snapshot ## Creating a Group -![Create Group](./images/create-device-group.png){data-zoomable} +![Create Group](./images/create-device-group.png) 1. Navigate to your Application 2. Select the **Groups** tab @@ -45,7 +45,7 @@ Groups help you organize and manage multiple devices that run the same [snapshot ### Adding and Removing Devices -![Edit Group Members](./images/ui-device-group-member-edit.png){data-zoomable} +![Edit Group Members](./images/ui-device-group-member-edit.png) 1. Click the group you want to modify from the table 2. Click **Edit** diff --git a/docs/user/expert/chat.md b/docs/user/expert/chat.md index 5c9c2b49a4..8d1c3df858 100644 --- a/docs/user/expert/chat.md +++ b/docs/user/expert/chat.md @@ -16,7 +16,7 @@ While in Immersive Mode you also have access to all [instance settings](/docs/us > **Note:** Note: As of v2.29, the FlowFuse Expert panel opens automatically whenever you enter the FlowFuse platform or an instance. If you close the panel, your preference is saved — Expert will remain closed on your next visit so it doesn’t get in your way. To open or close the panel while within the editor, click the FlowFuse drawer button in the top-left corner of the editor. -!["Chat interface of FlowFuse Expert alongside the Node-RED editor"](../images/assistant/flowfuse-expert-drawer.png){data-zoomable} +!["Chat interface of FlowFuse Expert alongside the Node-RED editor"](../images/assistant/flowfuse-expert-drawer.png) ## Chat Modes @@ -59,7 +59,7 @@ Expert can act on your requests directly by adding tabs, placing and wiring node To use it, describe what you want to build in the chat input, the same way you would ask a question. Expert will start working immediately, and you can follow along via real-time status updates in the chat panel as each step completes. When it finishes, the result is live on your canvas. You can continue refining it through chat by asking Expert to adjust a configuration, add a node, or change a topic path, or you can edit the canvas directly as normal. -![FlowFuse Expert building and configuring a flow directly on the Node-RED canvas](../images/assistant/flowfuse-expert-building-flow.gif){data-zoomable} +![FlowFuse Expert building and configuring a flow directly on the Node-RED canvas](../images/assistant/flowfuse-expert-building-flow.gif) Some prompts that work well: @@ -117,7 +117,7 @@ This allows you to ask questions like: The Expert can use palette context to tailor its suggestions - for example, recommending nodes you actually have installed rather than suggesting ones that are not available. -![Palette Context discussion with the FlowFuse Expert.](../images/assistant/palette-context.gif){data-zoomable} +![Palette Context discussion with the FlowFuse Expert.](../images/assistant/palette-context.gif) ##### Flow Context @@ -132,7 +132,7 @@ This allows you to ask questions like: Flow Context is what makes the Expert genuinely useful as a debugging and code review tool - it can see the same flow you're looking at and reason about it directly. -![FlowFuse Context discussion with the FlowFuse Expert.](../images/assistant/flow-context.gif){data-zoomable} +![FlowFuse Context discussion with the FlowFuse Expert.](../images/assistant/flow-context.gif) ##### Debug Context @@ -151,7 +151,7 @@ This allows you to ask questions like: Debug Context is especially useful in combination with Flow Context - together they give the Expert both the structure of your flow and the actual data it is producing, making debugging significantly more effective. -![Debug Context discussion with the FlowFuse Expert.](../images/assistant/expert-debug-context.gif){data-zoomable} +![Debug Context discussion with the FlowFuse Expert.](../images/assistant/expert-debug-context.gif) #### Resetting Context @@ -223,7 +223,7 @@ If you have multiple questions, consider asking them separately so the Expert ca When a newer version of FlowFuse Expert is available, a banner appears in the chat area to let you know. You can update with a single click directly from the notification, without leaving your current workflow. -![FlowFuse Expert Update Banner](../images/assistant/ff-expert-update-banner.gif){data-zoomable} +![FlowFuse Expert Update Banner](../images/assistant/ff-expert-update-banner.gif)