diff --git a/docs/README.md b/docs/README.md index cca808559c..42be5f2e36 100644 --- a/docs/README.md +++ b/docs/README.md @@ -79,7 +79,7 @@ It covers everything from setup, to usage, and development. All [contributions](

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

@@ -120,7 +120,7 @@ Here are some quick reference links to our most popular topics. You can also vie Centralized management of re-usable flows and functions. - +
@@ -129,7 +129,7 @@ Here are some quick reference links to our most popular topics. You can also vie Deploy flows between Test, Staging & Production Environments. - +
@@ -162,7 +162,7 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our
- Host your Instances at a custom subdomain + Invite people, set their roles, and control who can do what.
@@ -175,7 +175,7 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our Host your Instances at a custom subdomain - +
@@ -195,11 +195,11 @@ 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.
@@ -233,6 +233,7 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our ## Support - [Troubleshooting](/docs/debugging/) +- [Community Support](/docs/community-support/) - [FlowFuse Cloud Support](/docs/premium-support/) ## Contributing to FlowFuse diff --git a/docs/admin/introduction.md b/docs/admin/introduction.md index f79045f1c3..8fe18338fd 100644 --- a/docs/admin/introduction.md +++ b/docs/admin/introduction.md @@ -17,17 +17,17 @@ meta: ## Getting started - - [Understanding the FlowFuse Architecture](/docs/contribute/architecture.md) + - [Understanding the FlowFuse Architecture](/docs/contribute/architecture/) - [Install/Upgrade](/docs/install) - requirements, deployment models, installation methods and upgrading - - [`flowforge.yml` configuration](/docs/install/configuration.md) - base platform configuration, done before you run. - - [First Run Setup](/docs/install/first-run.md) - create your admin user - - [FlowFuse Concepts](/docs/user/concepts.md) - - [Usage Telemetry](/docs/admin/telemetry.md) + - [`flowforge.yml` configuration](/docs/install/configuration/) - base platform configuration, done before you run. + - [First Run Setup](/docs/install/first-run/) - create your admin user + - [FlowFuse Concepts](/docs/user/concepts/) + - [Usage Telemetry](/docs/admin/telemetry/) - [Single-Sign On](/docs/admin/sso/) - [Licensing](https://flowfuse.com/pricing/) - - [User management](/docs/admin/user-management.md) - - [Platform Monitoring](/docs/admin/monitoring.md) - - [Soft Launch Enablement](/docs/admin/feature-flags.md) + - [User management](/docs/admin/user-management/) + - [Platform Monitoring](/docs/admin/monitoring/) + - [Soft Launch Enablement](/docs/admin/feature-flags/) ## Administering FlowFuse @@ -229,9 +229,9 @@ to create and edit the stacks on the platform. For Deployment specific information about working with stacks, refer to the documentation of your chosen deployment model: - - [Local Stacks](/docs/contribute/local/stacks.md) - - [Docker Stacks](/docs/install/docker/stacks.md) - - [Kubernetes Stacks](/docs/install/kubernetes/stacks.md) + - [Local Stacks](/docs/contribute/local/stacks/) + - [Docker Stacks](/docs/install/docker/stacks/) + - [Kubernetes Stacks](/docs/install/kubernetes/stacks/) #### Create Stack @@ -260,8 +260,8 @@ When prompted for the Node-RED version, the value here depends on the setup you' if you ran the script with `latest` and it resulted in `3.1.9` being installed, you should enter `3.1.9`. This must match the directory name created in your `stacks` directory. If you changed the directory name for any reason, make sure to use that name. -- **Docker**: Support the container image name ([docs](/docs/install/docker/stacks.md)) -- **k8s**: Support the container image name ([docs](/docs/install/kubernetes/stacks.md)) +- **Docker**: Support the container image name ([docs](/docs/install/docker/stacks/)) +- **k8s**: Support the container image name ([docs](/docs/install/kubernetes/stacks/)) #### Updating Stacks diff --git a/docs/admin/observability.md b/docs/admin/observability.md index a1a1a217ef..e9deb998f8 100644 --- a/docs/admin/observability.md +++ b/docs/admin/observability.md @@ -73,5 +73,5 @@ Once the cluster basics are in place, build a FlowFuse-specific dashboard from t ## Next steps -- [Platform Monitoring](/docs/admin/monitoring.md) - details of the FlowFuse statistics endpoint used by Prometheus. +- [Platform Monitoring](/docs/admin/monitoring/) - details of the FlowFuse statistics endpoint used by Prometheus. - [Installing FlowFuse on Kubernetes](/docs/install/kubernetes/) - deploying and configuring the platform on a cluster. diff --git a/docs/cloud/introduction.md b/docs/cloud/introduction.md index dec9efb5d1..39aee0aa6d 100644 --- a/docs/cloud/introduction.md +++ b/docs/cloud/introduction.md @@ -18,7 +18,7 @@ meta: # FlowFuse Cloud FlowFuse Cloud is a hosted service allowing users to sign-up and start creating Node-RED instances without having to install and manage their own instance of FlowFuse. -The [Concepts](/docs/user/concepts.md) remain the same, but we run the platform for you. +The [Concepts](/docs/user/concepts/) remain the same, but we run the platform for you. ## 30-day Free Trial @@ -40,7 +40,7 @@ they know what is happening. ## Billing Customers are billed at the team level for each Node-RED instance they create. This is a recurring monthly charge. -See the [Billing](/docs/cloud/billing.md) page for more detailed answers about billing. +See the [Billing](/docs/cloud/billing/) page for more detailed answers about billing. ## Support @@ -86,8 +86,8 @@ that level. Please Suspend or Delete any no longer required Instances or Devices ## Node-RED on FlowFuse Cloud FlowFuse currently offers Node-RED 4.x, 3.x and 2.x to customers. When creating a -new instance a [stack](/docs/user/concepts.md#stack) is chosen, which later -can be [upgraded to a later version](/docs/user/changestack.md). +new instance a [stack](/docs/user/concepts/#stack) is chosen, which later +can be [upgraded to a later version](/docs/user/changestack/). Each Node-RED can install custom modules as advertised in the [Flow Library](https://flows.nodered.org). @@ -231,12 +231,12 @@ FlowFuse Cloud can support custom hostnames for instances in Enterprise teams. This allows you to point your own subdomain, such as `dashboard.example.com` at one of your instances. -See [Custom Hostnames](/docs/user/custom-hostnames.md) for more information. +See [Custom Hostnames](/docs/user/custom-hostnames/) for more information. ## Removing your account Before you can delete your account, teams you own must either be deleted or have at least 1 other owner. Once this is done, you can remove your account by going to the "User Settings" page and clicking the "Delete Account" button. -See also: [cancelling your subscription](/docs/cloud/billing.md#cancelling-your-subscription). +See also: [cancelling your subscription](/docs/cloud/billing/#cancelling-your-subscription). diff --git a/docs/contribute/local/README.md b/docs/contribute/local/README.md index 311f6b9f04..ce81e0c1c3 100644 --- a/docs/contribute/local/README.md +++ b/docs/contribute/local/README.md @@ -137,7 +137,7 @@ If you want to allow access from other devices on the network, you must edit the change the `host` setting to `0.0.0.0` and change `base_url` to contain the IP address of the server. NOTE: We do not support changing the `host` and `base_url` values once you have created an instance. -For more information on all of the options available, see the [configuration guide](/docs/install/configuration.md). +For more information on all of the options available, see the [configuration guide](/docs/install/configuration/). ## Running FlowFuse @@ -165,7 +165,7 @@ Or to run as a service: Once FlowFuse is started, you will be ready to perform the first run setup. -Follow [this guide](/docs/install/first-run.md) to continue. +Follow [this guide](/docs/install/first-run/) to continue. ## Setting up Mosquitto (optional) diff --git a/docs/debugging/README.md b/docs/debugging/README.md index 2f723a7634..491b38fc93 100644 --- a/docs/debugging/README.md +++ b/docs/debugging/README.md @@ -16,7 +16,7 @@ meta: When a Node-RED instance is unresponsive, for example due to an infinite loop, it can be put into Safe Mode. -1. Edit the instance's [Environment Variables](/docs/user/envvar.md) +1. Edit the instance's [Environment Variables](/docs/user/envvar/) 2. Add a variable called `NODE_RED_ENABLE_SAFE_MODE` to `true`. 3. Save the changes then suspend/restart the instance. diff --git a/docs/device-agent/install/device-agent-installer.md b/docs/device-agent/install/device-agent-installer.md index ad2f5d7b86..fae13d2f1a 100644 --- a/docs/device-agent/install/device-agent-installer.md +++ b/docs/device-agent/install/device-agent-installer.md @@ -35,7 +35,7 @@ Please see [Networking requirements](./overview.md#networking-requirements). ### One-line install -For the fastest one-line install experience, see the [Quick Start guide](/docs/device-agent/quickstart.md). +For the fastest one-line install experience, see the [Quick Start guide](/docs/device-agent/quickstart/). ### Manual install diff --git a/docs/device-agent/install/overview.md b/docs/device-agent/install/overview.md index d205079297..a50fb91b43 100644 --- a/docs/device-agent/install/overview.md +++ b/docs/device-agent/install/overview.md @@ -85,4 +85,4 @@ After installing by any method: - Follow the [Quick Start guide](../quickstart.md) to add and connect a Remote Instance - Learn [how to run and configure the agent](../running.md) -- Use [DevOps Pipelines](/docs/user/devops-pipelines.md) to deploy flows +- Use [DevOps Pipelines](/docs/user/devops-pipelines/) to deploy flows diff --git a/docs/device-agent/introduction.md b/docs/device-agent/introduction.md index 58c982c99b..bc5c1dd89b 100644 --- a/docs/device-agent/introduction.md +++ b/docs/device-agent/introduction.md @@ -24,7 +24,7 @@ The Agent creates a secure connection between the FlowFuse Platform and your dev You can install the Device Agent on any hardware capable of running Node.js / Node-RED. -The [Quick Start Guide](/docs/device-agent/quickstart.md) will get the Device Agent installed and connected to FlowFuse in under 5 minutes. +The [Quick Start Guide](/docs/device-agent/quickstart/) will get the Device Agent installed and connected to FlowFuse in under 5 minutes. -For more detailed information on installing and running the Device Agent, the full [installation guide](/docs/device-agent/install/overview.md) has you covered. +For more detailed information on installing and running the Device Agent, the full [installation guide](/docs/device-agent/install/overview/) has you covered. diff --git a/docs/device-agent/quickstart.md b/docs/device-agent/quickstart.md index 593c9beedf..c71eb1a016 100644 --- a/docs/device-agent/quickstart.md +++ b/docs/device-agent/quickstart.md @@ -99,7 +99,7 @@ From there you can start building your applications. There are two approaches to deploying flows to your Remote Instances. - **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 Hosted Instance/Remote Instance 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. remote test instances) out to remote production instances. +- **DevOps Pipelines**: FlowFuse provides [DevOps Pipelines](/docs/user/devops-pipelines/) as a way of pushing flows from one Hosted Instance/Remote Instance to another (or several in the case of [Device Groups](/docs/user/device-groups/)). This is the recommended approach if you're pushing from development environments (e.g. remote test instances) out to remote production instances. ### Developer Mode @@ -126,7 +126,7 @@ There are two approaches to deploying flows to your Remote Instances. ![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_ -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). +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/). ## Next Steps diff --git a/docs/device-agent/register.md b/docs/device-agent/register.md index f7694a2378..b8f3de4cff 100644 --- a/docs/device-agent/register.md +++ b/docs/device-agent/register.md @@ -165,7 +165,7 @@ automatically be assigned to an Application or Instance. ### Applications -This step will permit you to push Snapshots to your Remote Instance via [DevOps Pipelines](/docs/user/devops-pipelines.md), or via a [Target Snapshot](/docs/user/snapshots/#application-owned-devices) from the Application. +This step will permit you to push Snapshots to your Remote Instance via [DevOps Pipelines](/docs/user/devops-pipelines/), or via a [Target Snapshot](/docs/user/snapshots/#application-owned-devices) from the Application. #### Assign to Application @@ -207,7 +207,7 @@ NOTE: If you wish to keep the flows currently running on the Remote Instance, it This method establishes a deployment relationship where a Hosted Instance becomes the source for snapshot deployments to your Remote Instance(s). -**Important:** This is a legacy feature; [assigning to Applications](./register.md#applications) is the recommended approach as it provides better fleet management and DevOps Pipeline capabilities. For guidance, see [when to use each approach](/docs/user/concepts.md#when-to-use-instance-assignment-vs-devops-pipelines). +**Important:** This is a legacy feature; [assigning to Applications](./register.md#applications) is the recommended approach as it provides better fleet management and DevOps Pipeline capabilities. For guidance, see [when to use each approach](/docs/user/concepts/#when-to-use-instance-assignment-vs-devops-pipelines). #### Assign to Hosted Instance @@ -215,7 +215,7 @@ This method establishes a deployment relationship where a Hosted Instance become 2. Open the dropdown menu to the right of the Remote Instance you want to assign and select the **Add to Instance** option. 3. Select the Hosted Instance in the dialog and click **Add** to continue. -**Note:** There are constraints on which instances can be assigned to each other. For detailed information, refer to [Assignment Rules and Constraints](/docs/user/concepts.md#assignment-rules). +**Note:** There are constraints on which instances can be assigned to each other. For detailed information, refer to [Assignment Rules and Constraints](/docs/user/concepts/#assignment-rules). ### Remove from Hosted Instance diff --git a/docs/hardware/introduction.md b/docs/hardware/introduction.md index 95148fe149..21a3b6c631 100644 --- a/docs/hardware/introduction.md +++ b/docs/hardware/introduction.md @@ -13,17 +13,17 @@ meta: # Device Agent - Hardware -The FlowFuse Device Agent can be installed on any Mac, Linux, or Windows-supported device. If you want to learn more about how to install the Device Agent in general, [click here](/docs/device-agent/install/overview.md). Nevertheless, this overview provides a guide for specific hardware platforms. +The FlowFuse Device Agent can be installed on any Mac, Linux, or Windows-supported device. If you want to learn more about how to install the Device Agent in general, [click here](/docs/device-agent/install/overview/). Nevertheless, this overview provides a guide for specific hardware platforms. ## Official FlowFuse Hardware Partners -- [ctrlX - Node-RED App](/docs/hardware/ctrlx-node-red.md) -- [ctrlX - Device Agent App](/docs/hardware/ctrlx-device-agent.md) - will be available soon +- [ctrlX - Node-RED App](/docs/hardware/ctrlx-node-red/) +- [ctrlX - Device Agent App](/docs/hardware/ctrlx-device-agent/) - will be available soon ## Other Hardware Guides - + -- [Raspberry Pi](/docs/hardware/raspbian.md) \ No newline at end of file +- [Raspberry Pi](/docs/hardware/raspbian/) \ No newline at end of file diff --git a/docs/install/configuration.md b/docs/install/configuration.md index ce3fa617e6..4a174bb547 100644 --- a/docs/install/configuration.md +++ b/docs/install/configuration.md @@ -167,7 +167,7 @@ Additionally, you can configure your own instance of FlowFuse to report back to - [PostHog](https://posthog.com/) _(recommended)_: You will require your own API key to pass into the `yml`, which will begin the logging of user interactions. - [Plausible](https://plausible.io/): _(deprecated since 0.9 and will be removed in the future)_: You can setup your own account, and pass the relevant domain to the `yml` in the telemetry configuration -For more information about this feature, see [here](/docs/admin/telemetry.md) +For more information about this feature, see [here](/docs/admin/telemetry/) Option | Description --------------|------------ @@ -231,7 +231,7 @@ broker, but some features will not be available: - Without a broker: Project Nodes, Device Actions and Remote Device Editing are unavailable. - The following features additionally require the platform broker to be EMQX: - the [Team Broker](/docs/user/teambroker.md), [FlowFuse Expert](/docs/user/expert/) + the [Team Broker](/docs/user/teambroker/), [FlowFuse Expert](/docs/user/expert/) and live device log and performance views in the platform UI. [Mosquitto](https://mosquitto.org/) is supported at a legacy level for existing @@ -317,9 +317,9 @@ This is done by adding `10-file.js` in the **Exclude nodes by filename** section of your instance settings under the **Palette** section. This setting is modifiable only by a Team owner and only if it has not been -locked in the [template](/docs/user/concepts.md#template) by the platform Administrator. +locked in the [template](/docs/user/concepts/#template) by the platform Administrator. -[Click here](/docs/user/filenodes.md), to learn more about the usage of the FlowFuse File Nodes. +[Click here](/docs/user/filenodes/), to learn more about the usage of the FlowFuse File Nodes. ## Content Security Policy diff --git a/docs/install/first-run.md b/docs/install/first-run.md index bf15777cd8..e41bf294f5 100644 --- a/docs/install/first-run.md +++ b/docs/install/first-run.md @@ -55,4 +55,4 @@ user you created and start using the platform. You can setup your Team and create your first Node-RED instance. More information about using the FlowFuse platform is available in the -main [user guide](/docs/user/introduction.md). +main [user guide](/docs/user/introduction/). diff --git a/docs/install/introduction.md b/docs/install/introduction.md index 22493b0bc1..f38fa1d282 100644 --- a/docs/install/introduction.md +++ b/docs/install/introduction.md @@ -22,22 +22,22 @@ FlowFuse can be installed to run in Docker or Kubernetes based environments. - **Docker:** - [Quick Start Guide](/docs/quick-start) - - [Full Install](/docs/install/docker/README.md) + - [Full Install](/docs/install/docker/) - **Kubernetes:** - - [Install Guide](/docs/install/kubernetes/README.md) + - [Install Guide](/docs/install/kubernetes/) We also provide one-click installs of the Docker version: - - [Digital Ocean Docker Install Guide](/docs/install/docker/digital-ocean.md) - - [AWS Docker Install Guide](/docs/install/docker/aws-marketplace.md) + - [Digital Ocean Docker Install Guide](/docs/install/docker/digital-ocean/) + - [AWS Docker Install Guide](/docs/install/docker/aws-marketplace/) Whichever installation you choose, the platform needs outbound network access to a set of hostnames. If it runs behind a firewall or proxy, see -[Networking requirements](/docs/install/networking-requirements.md). +[Networking requirements](/docs/install/networking-requirements/). ## Upgrading FlowFuse -If you are upgrading FlowFuse, please refer to the [Upgrade Guide](/docs/upgrade/README.md) +If you are upgrading FlowFuse, please refer to the [Upgrade Guide](/docs/upgrade/) for any specific actions required. ## Do You Need Help? Installation Service diff --git a/docs/install/kubernetes/aws-terraform.md b/docs/install/kubernetes/aws-terraform.md index 9169e939d0..5169a2fe43 100644 --- a/docs/install/kubernetes/aws-terraform.md +++ b/docs/install/kubernetes/aws-terraform.md @@ -191,7 +191,7 @@ Apply the SES module using the shared variables file: terraform -chdir=ses apply -var-file=../terraform.tfvars ``` -To get the IAM role ARN created by the SES module and required during [FlowFuse platform configuration](/docs/install/configuration.md#aws-ses-email), run the following command: +To get the IAM role ARN created by the SES module and required during [FlowFuse platform configuration](/docs/install/configuration/#aws-ses-email), run the following command: ```bash terraform -chdir=eks output flowfuse_role_arn diff --git a/docs/migration/introduction.md b/docs/migration/introduction.md index 15f7aa13e3..85ca410daa 100644 --- a/docs/migration/introduction.md +++ b/docs/migration/introduction.md @@ -27,7 +27,7 @@ If you have not yet created a Node-RED instance that you want to manage within F ## Migrating the flows and credentials Install the Node-RED tools plugin as explained -[in the documentation](/docs/migration/node-red-tools.md). After you created a snapshot for +[in the documentation](/docs/migration/node-red-tools/). After you created a snapshot for the Node-RED instance you wish to move, you'll have copied over the flows and credentials. ## Migrating Environment Variables diff --git a/docs/user/concepts.md b/docs/user/concepts.md index 74c61a09f5..ad45e29a3d 100644 --- a/docs/user/concepts.md +++ b/docs/user/concepts.md @@ -121,7 +121,7 @@ Snapshots are point-in-time backups that work differently depending on the insta #### Hosted Instance Snapshot -A snapshot is a point-in-time backup of a hosted Node-RED instance. It captures the flows, credentials, and runtime settings. Snapshots can be created and deleted on the FlowFuse Platform, or using the [FlowFuse Node-RED Tools plugin](/docs/migration/node-red-tools.md). The platform also allows you to roll an instance back to a previous snapshot. +A snapshot is a point-in-time backup of a hosted Node-RED instance. It captures the flows, credentials, and runtime settings. Snapshots can be created and deleted on the FlowFuse Platform, or using the [FlowFuse Node-RED Tools plugin](/docs/migration/node-red-tools/). The platform also allows you to roll an instance back to a previous snapshot. A user can create an hosted instance snapshot and then mark it as the *target* snapshot for remote instance. The platform will then deploy that snapshot to all of the devices assigned to the instance. Snapshots can be set as targets for DevOps pipeline stages. Auto snapshots are available for automatic backup scheduling. If an auto snapshot is set as a target or assigned to a pipeline stage, it will not be automatically cleaned up, so you may have more than 10 auto snapshots in that case. @@ -133,7 +133,7 @@ Similar to instance snapshots, a device snapshot is a point-in-time backup of a **Note:** This is a legacy feature that predates DevOps Pipelines. For new deployments, consider using [DevOps Pipelines](#devops-pipeline) instead, which provide more flexible and powerful deployment workflows. -Instance assignment establishes a parent-child deployment relationship between a hosted instance and remote instances. When assigned, the hosted instance becomes the source of truth and automatically pushes snapshots to the remote instance. You can only push nodes and flows that are supported by both Hosted and Remote Instances. For more information on how this works, see [How Instance Assignment Works](/docs/user/concepts.md#how-it-works). +Instance assignment establishes a parent-child deployment relationship between a hosted instance and remote instances. When assigned, the hosted instance becomes the source of truth and automatically pushes snapshots to the remote instance. You can only push nodes and flows that are supported by both Hosted and Remote Instances. For more information on how this works, see [How Instance Assignment Works](/docs/user/concepts/#how-it-works). #### How It Works diff --git a/docs/user/expert/chat.md b/docs/user/expert/chat.md index 63592c0d0f..ed50b87bbc 100644 --- a/docs/user/expert/chat.md +++ b/docs/user/expert/chat.md @@ -135,7 +135,7 @@ The settings split actions into two groups: **Flow Building Tools**, the actions **Role-based limits.** Permissions respect your team role. Read-only team members cannot enable or trigger actions that write or delete, and will see why they are unavailable. This is enforced by Expert itself, not just hidden in the interface. -**Auditability.** Every action Expert takes on the platform is recorded in the [Audit Log](/docs/user/logs.md#ai-agents-and-api-activity), alongside the tool it called and the user it was acting on behalf of. +**Auditability.** Every action Expert takes on the platform is recorded in the [Audit Log](/docs/user/logs/#ai-agents-and-api-activity), alongside the tool it called and the user it was acting on behalf of. **Example permission setups.** A few common ways to configure this: diff --git a/docs/user/expert/index.md b/docs/user/expert/index.md index 3d4cbbb482..57261faa31 100644 --- a/docs/user/expert/index.md +++ b/docs/user/expert/index.md @@ -8,7 +8,7 @@ FlowFuse Expert is the AI built into FlowFuse and the Node-RED editor. It is not **FlowFuse Expert is automatically installed and available in all hosted and remote instances running within or connected to FlowFuse**, no manual installation or configuration required. For self-hosted Enterprise customers, FlowFuse Expert can be enabled on request. [Contact us](https://flowfuse.com/contact-us/) to get it set up on your infrastructure. -> **Note:** On self-hosted installations, FlowFuse Expert requires an Enterprise license and the platform's EMQX-based MQTT broker with the Team Broker capability enabled in the platform configuration (see [MQTT Broker configuration](/docs/install/configuration.md#mqtt-broker-configuration)); installations running without EMQX cannot enable Expert. +> **Note:** On self-hosted installations, FlowFuse Expert requires an Enterprise license and the platform's EMQX-based MQTT broker with the Team Broker capability enabled in the platform configuration (see [MQTT Broker configuration](/docs/install/configuration/#mqtt-broker-configuration)); installations running without EMQX cannot enable Expert. ## Managing AI Features diff --git a/docs/user/introduction.md b/docs/user/introduction.md index e5a8736d0f..4129835194 100644 --- a/docs/user/introduction.md +++ b/docs/user/introduction.md @@ -5,7 +5,7 @@ navOrder: 1 # Getting Started with FlowFuse -This guide will help you learn how to use the FlowFuse platform to quickly create new Node-RED applications after a successful [installation](/docs/install/introduction.md) or [sign-up](https://app.flowforge.com/account/create) for FlowFuse Cloud. +This guide will help you learn how to use the FlowFuse platform to quickly create new Node-RED applications after a successful [installation](/docs/install/introduction/) or [sign-up](https://app.flowforge.com/account/create) for FlowFuse Cloud. ## Creating a Node-RED Instance @@ -72,7 +72,7 @@ FlowFuse will show you a device configuration window with installation options: Follow the steps in the window to connect your device—it takes less than a minute. -[Learn more about Device Agent](/docs/device-agent/introduction.md) +[Learn more about Device Agent](/docs/device-agent/introduction/) **Accessing Your Remote Instance:** @@ -124,45 +124,45 @@ DevOps Pipelines enable you to link multiple Node-RED instances together in a de FlowFuse supports managing Node-RED on your own hardware. - - [Getting started with Devices](/docs/device-agent/introduction.md) + - [Getting started with Devices](/docs/device-agent/introduction/) ## Working with Teams - - [Team management](/docs/user/team/README.md) - How to add and remove users from a team. - - [Role based access control](/docs/user/team/README.md#role-based-access-control) - Which privileges are granted to different roles. + - [Team management](/docs/user/team/) - How to add and remove users from a team. + - [Role based access control](/docs/user/team/#role-based-access-control) - Which privileges are granted to different roles. ## Working with Files and Context FlowFuse supports reading and writing persistent files and persistent context. - - [Working with Files](/docs/user/filenodes.md) - - [Working with the Static Asset Service](/docs/user/static-asset-service.md) - - [Working with Context](/docs/user/persistent-context.md) + - [Working with Files](/docs/user/filenodes/) + - [Working with the Static Asset Service](/docs/user/static-asset-service/) + - [Working with Context](/docs/user/persistent-context/) ## Working with Instances - - [Dashboards](/docs/user/dashboards.md) - View and switch between your Node-RED Dashboards from one place. - - [Instance States](/docs/user/instance-states.md) - List of states an instance can be in. - - [Snapshots](/docs/user/snapshots.md) - Create point-in-time backups of your Node-RED instances. - - [Environment Variables](/docs/user/envvar.md) - How to manage Environment Variables in your Node-RED instances. - - [Change Project Stack](/docs/user/changestack.md) - How to change an instance stack, for example to upgrade Node-RED. - - [Logs](/docs/user/logs.md) - The Logs available in the FlowFuse application. - - [Project Link Nodes](/docs/user/projectnodes.md) - Custom nodes for sending messages between Node-RED instances and devices. - - [MQTT Nodes](/docs/user/mqtt-nodes.md) - Custom nodes for zero config MQTT integration with the team broker. - - [Instance Settings](/docs/user/instance-settings.md) - Settings available for Node-RED instances. - - [Shared Team Library](/docs/user/shared-library.md) - Share flows easily between different Node-RED instances in your team. - - [Node-RED Tools Plugin](/docs/migration/node-red-tools.md) - A plugin for Node-RED that lets you work with your flows outside of FlowFuse. - - [High Availability mode](/docs/user/high-availability.md) - Run multiple copies of your instance for scaling and availability. + - [Dashboards](/docs/user/dashboards/) - View and switch between your Node-RED Dashboards from one place. + - [Instance States](/docs/user/instance-states/) - List of states an instance can be in. + - [Snapshots](/docs/user/snapshots/) - Create point-in-time backups of your Node-RED instances. + - [Environment Variables](/docs/user/envvar/) - How to manage Environment Variables in your Node-RED instances. + - [Change Project Stack](/docs/user/changestack/) - How to change an instance stack, for example to upgrade Node-RED. + - [Logs](/docs/user/logs/) - The Logs available in the FlowFuse application. + - [Project Link Nodes](/docs/user/projectnodes/) - Custom nodes for sending messages between Node-RED instances and devices. + - [MQTT Nodes](/docs/user/mqtt-nodes/) - Custom nodes for zero config MQTT integration with the team broker. + - [Instance Settings](/docs/user/instance-settings/) - Settings available for Node-RED instances. + - [Shared Team Library](/docs/user/shared-library/) - Share flows easily between different Node-RED instances in your team. + - [Node-RED Tools Plugin](/docs/migration/node-red-tools/) - A plugin for Node-RED that lets you work with your flows outside of FlowFuse. + - [High Availability mode](/docs/user/high-availability/) - Run multiple copies of your instance for scaling and availability. - [FlowFuse Expert](/docs/user/expert/) - A Node-RED plugin powered by AI, trained on FlowFuse content, that helps you code faster, build flows, and debug with context-aware guidance. ## Working with MQTT - - [Team Broker](/docs/user/teambroker.md) - Working with the FlowFuse bundled MQTT Broker + - [Team Broker](/docs/user/teambroker/) - Working with the FlowFuse bundled MQTT Broker ## Working with Custom Nodes - - [Custom Nodes](/docs/user/custom-npm-packages.md) - Publishing Custom Node-RED Nodes + - [Custom Nodes](/docs/user/custom-npm-packages/) - Publishing Custom Node-RED Nodes ## Working with FF Tables - - [FF Tables](/docs/user/ff-tables.md) - Databases + - [FF Tables](/docs/user/ff-tables/) - Databases diff --git a/docs/user/snapshots.md b/docs/user/snapshots.md index 9724963d21..7d65de5812 100644 --- a/docs/user/snapshots.md +++ b/docs/user/snapshots.md @@ -218,11 +218,11 @@ more information. ### Creating a Snapshot locally -Using the [Node-RED Tools Plugin](/docs/migration/node-red-tools.md) it is also possible to create +Using the [Node-RED Tools Plugin](/docs/migration/node-red-tools/) it is also possible to create Snapshots in a local copy of Node-RED and push them back into your FlowFuse managed Node-RED instances. -For more information, see the [Node-RED Tools Plugin guide](/docs/migration/node-red-tools.md). +For more information, see the [Node-RED Tools Plugin guide](/docs/migration/node-red-tools/). ### Auto Snapshots