Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ It covers everything from setup, to usage, and development. All [contributions](
<p>Hosted solution, nothing to install anything, jump straight in.</p>
<ul style="margin-top: 0; margin-bottom: 0;">
<li class="ff-offering-cta"><a href="https://app.flowfuse.com/account/create">Sign Up for Free<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="">Upgrading Teams<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="/docs/cloud/billing/#team-billing">Upgrading Teams<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="/docs/cloud/billing/">Billing<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="/docs/cloud/introduction/#single-sign-on">Single Sign On<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
</ul>
Expand Down Expand Up @@ -120,7 +120,7 @@ Here are some quick reference links to our most popular topics. You can also vie
<span>Centralized management of re-usable flows and functions.</span>
</div>
</a>
<a class="ff-tile ff-product-feature-tile" href="/docs/user/snapshots/">
<a class="ff-tile ff-product-feature-tile" href="/docs/user/devops-pipelines/">
<div class="ff-product-feature-tile-decorator">
<svg class="ff-icon" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 24 24" style="enable-background:new 0 0 24 24;" xml:space="preserve"><g class="st0"><path d="M7,15.8 M7,3.1 M7,15.8V4.2C7,3.5,6.5,3,5.8,3H3.9C3.2,3,2.6,3.5,2.6,4.2v11.6"/><path d="M14,15.8 M14,3.1 M14,15.8V4.2C14,3.5,13.5,3,12.8,3h-1.9c-0.7,0-1.2,0.5-1.2,1.2v11.6"/><path d="M21,3.1 M21,15c0-2.7,0-10.8,0-10.8C21,3.5,20.5,3,19.8,3h-1.9c-0.7,0-1.2,0.5-1.2,1.2V11"/><path d="M17.2,22.5c-0.2,0-0.4-0.1-0.5-0.2c-0.3-0.3-0.3-0.8,0-1.1l2.5-2.5H3c-0.4,0-0.8-0.3-0.8-0.8s0.3-0.8,0.8-0.8h16.2l-2.5-2.5c-0.3-0.3-0.3-0.8,0-1.1s0.8-0.3,1.1,0l3.8,3.8c0.1,0.1,0.1,0.2,0.2,0.2c0,0.1,0.1,0.2,0.1,0.3s0,0.2-0.1,0.3c0,0.1-0.1,0.2-0.2,0.2l-3.8,3.8C17.6,22.4,17.4,22.5,17.2,22.5z"/></g></svg>
</div>
Expand All @@ -129,7 +129,7 @@ Here are some quick reference links to our most popular topics. You can also vie
<span>Deploy flows between Test, Staging & Production Environments.</span>
</div>
</a>
<a class="ff-tile ff-product-feature-tile" href="/docs/user/device-groups/">
<a class="ff-tile ff-product-feature-tile" href="/docs/device-agent/introduction/">
<div class="ff-product-feature-tile-decorator">
<svg class="ff-icon" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M8.25 3v1.5M4.5 8.25H3m18 0h-1.5M4.5 12H3m18 0h-1.5m-15 3.75H3m18 0h-1.5M8.25 19.5V21M12 3v1.5m0 15V21m3.75-18v1.5m0 15V21m-9-1.5h10.5a2.25 2.25 0 0 0 2.25-2.25V6.75a2.25 2.25 0 0 0-2.25-2.25H6.75A2.25 2.25 0 0 0 4.5 6.75v10.5a2.25 2.25 0 0 0 2.25 2.25Zm.75-12h9v9h-9v-9Z" /></svg>
</div>
Expand Down Expand Up @@ -162,7 +162,7 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our
</div>
<div>
<label>Managing Teams</label>
<span>Host your Instances at a custom subdomain</span>
<span>Invite people, set their roles, and control who can do what.</span>
</div>
</a>
<a class="ff-tile ff-product-feature-tile" href="/docs/user/custom-hostnames/">
Expand All @@ -175,7 +175,7 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our
<span>Host your Instances at a custom subdomain</span>
</div>
</a>
<a class="ff-tile ff-product-feature-tile" href="/docs/user/device-groups/">
<a class="ff-tile ff-product-feature-tile" href="/docs/user/high-availability/">
<div class="ff-product-feature-tile-decorator">
<svg class="ff-icon" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M20.25 6.375c0 2.278-3.694 4.125-8.25 4.125S3.75 8.653 3.75 6.375m16.5 0c0-2.278-3.694-4.125-8.25-4.125S3.75 4.097 3.75 6.375m16.5 0v11.25c0 2.278-3.694 4.125-8.25 4.125s-8.25-1.847-8.25-4.125V6.375m16.5 0v3.75m-16.5-3.75v3.75m16.5 0v3.75C20.25 16.153 16.556 18 12 18s-8.25-1.847-8.25-4.125v-3.75m16.5 0c0 2.278-3.694 4.125-8.25 4.125s-8.25-1.847-8.25-4.125" /></svg>
</div>
Expand All @@ -195,11 +195,11 @@ Once you're more comfortable with FlowFuse, you may want to explore some of our
<p>A complete set of FlowFuse-maintained nodes for data sharing between instances, MQTT messaging, AI/ONNX models, MCP agent integrations, and enterprise data features.<p>
<ul>
<li><a href="/docs/user/projectnodes/">FlowFuse Project Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/node-red/flowfuse/mcp/">FlowFuse MCP Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/node-red/flowfuse/flowfuse-tables/">FlowFuse Tables Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/node-red/flowfuse/ai/">FlowFuse AI Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/docs/flowfuse-nodes/mcp/">FlowFuse MCP Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/docs/flowfuse-nodes/flowfuse-tables/">FlowFuse Tables Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/docs/flowfuse-nodes/ai/">FlowFuse AI Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="/docs/user/mqtt-nodes/">FlowFuse MQTT Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/node-red/flowfuse/">See all the Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
<li><a href="https://flowfuse.com/docs/flowfuse-nodes/">See all the Nodes<icon-chevron-right class="ff-icon ff-icon-sm" /></a></li>
</ul>
</div>
<div class="ff-tile ff-offering-tile">
Expand Down Expand Up @@ -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
Expand Down
26 changes: 13 additions & 13 deletions docs/admin/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
12 changes: 6 additions & 6 deletions docs/cloud/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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).

4 changes: 2 additions & 2 deletions docs/contribute/local/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion docs/debugging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/device-agent/install/device-agent-installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/device-agent/install/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/device-agent/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

4 changes: 2 additions & 2 deletions docs/device-agent/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/device-agent/register.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -207,15 +207,15 @@ 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

1. Go to your team's **Remote Instances** page.
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

Expand Down
10 changes: 5 additions & 5 deletions docs/hardware/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<a href="https://developer.community.boschrexroth.com/t5/Store-and-How-to/FlowFuse-Node-RED/ba-p/82135"><img src="https://upload.wikimedia.org/wikipedia/commons/0/0d/Logo_of_Bosch_Rexroth_AG.svg" width="150" height="75"></a>

- [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

<a href="/docs/hardware/raspbian.md"><img src="https://upload.wikimedia.org/wikipedia/de/c/cb/Raspberry_Pi_Logo.svg" width="80" height="30"></a>
<a href="/docs/hardware/raspbian/"><img src="https://upload.wikimedia.org/wikipedia/de/c/cb/Raspberry_Pi_Logo.svg" width="80" height="30"></a>

- [Raspberry Pi](/docs/hardware/raspbian.md)
- [Raspberry Pi](/docs/hardware/raspbian/)
Loading
Loading