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
2 changes: 1 addition & 1 deletion docs/admin/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
navTitle: Administering FlowFuse
navOrder: 1
meta:
descriptions: Learn how to administer FlowFuse with this comprehensive guide. Explore user management, team setup, instance and stack management, and more.
description: Reach the Admin Settings and manage registration options, users, teams, team types, instance types, stacks and templates on a FlowFuse platform.
tags:
- flowfuse
- nodered
Expand Down
2 changes: 2 additions & 0 deletions docs/admin/sso/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Configuring Single Sign-On (SSO)
meta:
description: See how SAML and LDAP single sign-on work on self-hosted Enterprise FlowFuse, and how the email domain picks the provider for each user.
---

# Configuring Single Sign-On
Expand Down
2 changes: 1 addition & 1 deletion docs/install/first-run.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
navTitle: First Run Setup
meta:
descripition: Get started with FlowFuse using our concise first-run setup guide, covering initial access, administrator creation, license uploading, and platform setup.
description: Complete the first-run setup after installing FlowFuse by creating the administrator account and optionally uploading an Enterprise license.
tags:
- setup
- flowfuse
Expand Down
2 changes: 2 additions & 0 deletions docs/user/bill-of-materials.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
navTitle: Bill of Materials
navOrder: 2
meta:
description: Use the Bill of Materials in an application's Dependencies tab to view and search the dependencies and versions used by all its instances.
---

# Bill of Materials
Expand Down
2 changes: 2 additions & 0 deletions docs/user/changestack.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Changing the Stack
meta:
description: Change the stack a Node-RED instance runs on from its Settings tab in FlowFuse, for example to upgrade to a newer Node-RED version.
---

# Changing the Stack
Expand Down
2 changes: 2 additions & 0 deletions docs/user/concepts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
navTitle: FlowFuse Concepts
navOrder: 2
meta:
description: Understand the core FlowFuse concepts, including teams, applications, hosted and remote instances, stacks, templates, snapshots and pipelines.
---

# FlowFuse Concepts
Expand Down
2 changes: 2 additions & 0 deletions docs/user/custom-hostnames.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Custom Hostnames
meta:
description: Point a custom subdomain such as dashboard.example.com at a FlowFuse instance by setting the hostname and adding a CNAME record.
---

# Custom Hostnames
Expand Down
2 changes: 2 additions & 0 deletions docs/user/custom-npm-packages.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Custom Node Packages
meta:
description: Publish private Node-RED nodes to the FlowFuse Custom Node Registry, or connect an instance to a third-party npm registry and catalogue.
---

# Custom Node Packages
Expand Down
2 changes: 2 additions & 0 deletions docs/user/device-groups.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Groups
meta:
description: Create groups of remote instances in an application, manage their membership, and set group-level environment variables for pipeline deployments.
---

# Groups
Expand Down
2 changes: 2 additions & 0 deletions docs/user/devops-pipelines.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: DevOps Pipelines
meta:
description: Set up a DevOps pipeline to move flows and configuration from a development instance to production, and protect instances from direct edits.
---

# DevOps Pipelines
Expand Down
2 changes: 2 additions & 0 deletions docs/user/envvar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Environment Variables
meta:
description: Set, import and manage environment variables for a Node-RED instance in FlowFuse, and see the standard variables the platform provides.
---

# Environment Variables
Expand Down
4 changes: 3 additions & 1 deletion docs/user/expert/chat.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Chat Interface
meta:
description: Use the FlowFuse Expert chat in Support mode to build and debug flows on your canvas, or in Insights mode to query live operational data.
---

# Chat Interface
Expand Down Expand Up @@ -249,7 +251,7 @@ If the Expert starts giving unexpected or inconsistent answers, it may be due to

**Insights mode** connects the Expert to your live data via **Model Context Protocol (MCP)**. Use it when you want to query, analyze, or interact with real-world data - not just your Node-RED flows.

In Insights mode, you first select an MCP Server that you've built using [FlowFuse MCP Server Nodes](https://flowfuse.com/node-red/flowfuse/mcp/). The Expert can then use the tools and resources exposed by that server to answer questions against your live operational data. If you haven't built an MCP Server yet, see the guide on [building an MCP Server using FlowFuse](https://flowfuse.com/blog/2025/10/building-mcp-server-using-flowfuse/).
In Insights mode, you first select an MCP Server that you've built using [FlowFuse MCP Server Nodes](https://flowfuse.com/docs/flowfuse-nodes/mcp/). The Expert can then use the tools and resources exposed by that server to answer questions against your live operational data. If you haven't built an MCP Server yet, see the guide on [building an MCP Server using FlowFuse](https://flowfuse.com/blog/2025/10/building-mcp-server-using-flowfuse/).

As of v2.32, Insights mode also reaches your **remote instances** at the edge, not just hosted instances. Point the Expert at a remote instance and ask about its live machine or operational data in plain language, with no dashboard to build and no query to write.

Expand Down
2 changes: 2 additions & 0 deletions docs/user/expert/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: FlowFuse Expert
meta:
description: See what FlowFuse Expert does in its Chat Interface and in the Node-RED editor, how to turn AI features on or off, and how data is handled.
---

# FlowFuse Expert
Expand Down
2 changes: 2 additions & 0 deletions docs/user/expert/node-red-embedded-ai.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: AI in Node-RED
meta:
description: Use FlowFuse Expert's AI inside the Node-RED editor for flow autocomplete, code completion, flow explanations and JSON, CSS and HTML generation.
---

# AI in Node-RED
Expand Down
4 changes: 3 additions & 1 deletion docs/user/expert/third-party-agents.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Connect Your Own Agent
meta:
description: Connect your own MCP-capable AI agent, such as Copilot, ChatGPT or Claude, to FlowFuse to manage the platform and build Node-RED flows.
---

# Connect Your Own Agent
Expand Down Expand Up @@ -39,7 +41,7 @@ The same three steps, written out:

Your agent is now connected. If your client does not support OAuth, use a token instead, see [clients without a sign-in flow](#clients-without-a-sign-in-flow).

> **Note:** This is separate from [MCP server nodes](https://flowfuse.com/node-red/flowfuse/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client.
> **Note:** This is separate from [MCP server nodes](https://flowfuse.com/docs/flowfuse-nodes/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client.

## What your agent can do

Expand Down
2 changes: 2 additions & 0 deletions docs/user/ff-tables.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: FlowFuse Tables
meta:
description: Create a FlowFuse Tables database for an Enterprise team, build tables with the wizard, and query it from Node-RED or any Postgres client.
---

# FlowFuse Tables
Expand Down
2 changes: 2 additions & 0 deletions docs/user/filenodes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: FlowFuse File Nodes
meta:
description: See how Node-RED file nodes store files in FlowFuse, from the older FlowFuse File Nodes to Persistent Storage in FlowFuse 2.7.0 and later.
---

# FlowFuse File Nodes
Expand Down
2 changes: 2 additions & 0 deletions docs/user/high-availability.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: High Availability mode
meta:
description: Run multiple copies of a Node-RED instance in High Availability mode, and build flows that handle shared state and load-balanced work.
---

# High Availability mode
Expand Down
2 changes: 2 additions & 0 deletions docs/user/http-access-tokens.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: HTTP Access Tokens
meta:
description: Create HTTP access tokens so other applications can reach the dashboard and HTTP endpoints of a FlowFuse instance secured with user authentication.
---

# HTTP Access Tokens
Expand Down
2 changes: 2 additions & 0 deletions docs/user/instance-settings.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Instance Settings
meta:
description: Change a Node-RED instance's settings in FlowFuse, covering stack, environment, High Availability, editor, security, palette and alerts.
---

# Instance Settings
Expand Down
2 changes: 2 additions & 0 deletions docs/user/instance-states.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
navTitle: Instance States
navOrder: 10
meta:
description: Look up the stable and transitional states a hosted or remote Node-RED instance can be in on FlowFuse, and what each state means.
---

# FlowFuse Node-RED Instance States
Expand Down
2 changes: 2 additions & 0 deletions docs/user/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
navTitle: Getting Started
navOrder: 1
meta:
description: Create your first hosted and remote Node-RED instances in FlowFuse, pick a blueprint, and set up a first DevOps Pipeline.
---

# Getting Started with FlowFuse
Expand Down
2 changes: 2 additions & 0 deletions docs/user/logs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Logging
meta:
description: Find the Node-RED logs, instance audit log and team audit log in FlowFuse, and see how AI agent and API actions are marked.
---

# Logs
Expand Down
4 changes: 3 additions & 1 deletion docs/user/mcp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: FlowFuse MCP
meta:
description: See what an AI agent can do through the FlowFuse MCP server, from platform actions to building flows, and how read-only or full access limits it.
---

# FlowFuse MCP Server
Expand All @@ -13,7 +15,7 @@ Two clients use it:

Both use the same capabilities. What an agent can do depends only on the access you grant.

> **Note:** This is not the same as [MCP server nodes](https://flowfuse.com/node-red/flowfuse/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client.
> **Note:** This is not the same as [MCP server nodes](https://flowfuse.com/docs/flowfuse-nodes/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client.

## Platform Automations

Expand Down
2 changes: 2 additions & 0 deletions docs/user/mqtt-nodes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: FlowFuse MQTT Nodes
meta:
description: Use the FlowFuse MQTT In and MQTT Out nodes to publish and subscribe through the Team Broker without configuring any broker settings.
---

# FlowFuse MQTT Nodes
Expand Down
5 changes: 5 additions & 0 deletions docs/user/persistent-context.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
meta:
description: Keep Node-RED context values across restarts and stack updates by selecting the persistent context store in nodes and in Function node code.
---

# FlowFuse Persistent Context

Some Node-RED flows require the ability to persist context values between restarts and FlowFuse stack updates. By default, context data in Node-RED is ephemeral, meaning it does not survive restarts or stack updates. With FlowFuse's paid plans, however, you can enable **persistent context storage**, ensuring that your context values persist across restarts, upgrades, and more.
Expand Down
2 changes: 2 additions & 0 deletions docs/user/projectnodes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: FlowFuse Project Nodes
meta:
description: Send messages and call flows between Node-RED instances in a team with the Project In, Out and Call nodes, and the limits for remote instances.
---

# FlowFuse Project Nodes
Expand Down
2 changes: 2 additions & 0 deletions docs/user/role-based-access-control.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Role-Based Access Control
meta:
description: Control what team members can create, change, view or delete in FlowFuse with team-level roles and application-level overrides.
---

# Role-Based Access Control
Expand Down
2 changes: 2 additions & 0 deletions docs/user/shared-library.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Shared Team Library
meta:
description: Share flows and functions between Node-RED instances by exporting them to, and importing them from, the FlowFuse Team Library.
---

# Shared Team Library
Expand Down
2 changes: 2 additions & 0 deletions docs/user/snapshots.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Snapshots
meta:
description: Create, restore, compare and download snapshots, the point-in-time backups of a Node-RED instance's flows, credentials, settings and packages.
---

# Snapshots
Expand Down
2 changes: 2 additions & 0 deletions docs/user/static-asset-service.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
navTitle: Static asset service
navOrder: 1
meta:
description: Upload and manage files and folders on a hosted Node-RED instance with the Static Asset Service, and serve folders publicly on a static path.
---

# Static asset service
Expand Down
2 changes: 2 additions & 0 deletions docs/user/team/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Teams
meta:
description: Create a FlowFuse team, invite members with an initial role, and remove members who should no longer have access to the team's data.
---

# Teams
Expand Down
2 changes: 2 additions & 0 deletions docs/user/teambroker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: Team Broker
meta:
description: Create Team Broker clients and connect MQTT clients or Node-RED to the FlowFuse broker, with the hostname, ports and client ID rules.
---

# Getting Started with Team Broker
Expand Down
2 changes: 2 additions & 0 deletions docs/user/user-settings.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
navTitle: User Settings
meta:
description: Change your FlowFuse username, email, theme and password, set up two-factor authentication, and create scoped personal access tokens.
---

# User Settings
Expand Down
Loading