Skip to content

Commit 5d53428

Browse files
authored
Merge pull request #7223 from FlowFuse/update-docs-2-30
docs: update documentation to align with 2.30
2 parents a8aa55d + b847830 commit 5d53428

10 files changed

Lines changed: 89 additions & 30 deletions

File tree

docs/admin/sso/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ registers when they first sign in.
1818
Otherwise, a user will have to first register on the platform, providing a temporary
1919
password in order to create an account. They will then be able to log in via their SSO provider.
2020

21-
Admin users will still be able to log in with their original FlowFuse username/password - this ensures
22-
they don't get locked out of the platform if there is a problem with the SSO configuration.
21+
By default, admin users can still log in with their original FlowFuse username and password, which ensures they are not locked out if there is a problem with the SSO configuration.
2322

2423
## SAML SSO
2524

141 KB
Loading

docs/admin/sso/saml.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,20 @@ For Self Hosted users there is an option in the Admin Settings to enable buttons
195195

196196
These buttons will redirect to the SSO provider rather than requiring users to enter and email address in the username field to select the correct provider.
197197

198+
## Forcing All Users to Use SSO
199+
200+
For self-hosted installations that need to ensure no user can bypass SSO, there is an option in **Admin Settings > Settings > SSO > Force all logins for non-admin users via a single SAML SSO provider**.
201+
202+
![SSO settings page showing the option to force all non-admin users to log in via a single SAML SSO provider](./images/force-sso.png)
203+
_SSO settings page showing the option to force all non-admin users to log in via a single SAML SSO provider_
204+
205+
When this option is enabled:
206+
- All users are redirected to the configured SSO provider at login, regardless of their email domain
207+
- The email and password login form is no longer presented as a fallback option
208+
- Admin users can bypass SSO by accessing `/admin` routes
209+
210+
This is intended for organisations running a single identity provider across the entire platform, where per-domain SSO configuration is not sufficient to cover all users.
211+
198212
## Providers
199213

200214
The following is a non-exhaustive list of the providers that are known to work

docs/user/expert/chat.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ navTitle: Chat Interface
44

55
# Chat Interface
66

7-
The FlowFuse Expert chat interface is your conversational AI companion that you can open directly in the Node-RED editor. While other FlowFuse Expert features (like inline code completions and next-node prediction) work passively in the Node-RED Editor, the chat interface is where you actively engage the AI - asking questions, exploring your flows, and gaining insights from your live data.
7+
The FlowFuse Expert chat interface is where you actively engage the AI: asking questions, building flows directly on your canvas, and querying live operational data. While other FlowFuse Expert features (like inline code completions and next-node prediction) work passively in the Node-RED editor, the chat interface is where you direct Expert and see it act on your behalf.
88

99
## Opening the Chat Interface
1010

11-
To open the chat, first open your Node-RED instance using the **Open Editor** button. This launches Immersive Mode.
11+
To open the chat, first open your Node-RED instance using the **Open Editor** button. This launches Immersive Mode, where the Expert panel is available alongside your canvas.
1212

13-
As of v2.29, the FlowFuse Expert panel opens automatically when you enter the immersive editor. If you close the panel, that preference is saved — Expert will remain closed on your next visit so it doesn't get in your way.
13+
While in Immersive Mode you also have access to all [instance settings](/docs/user/instance-settings/) from a drawer that sits beside the canvas. You can manage environment variables, snapshots, the palette, and other settings without leaving the editor. Use the eye icon at the top of the drawer to move it left or right, pin or unpin it, or toggle fullscreen mode.
1414

15-
You can reopen the Expert panel at any time by clicking the **FlowFuse Expert** button in the top-left of the editor.
15+
> **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.
1616
17-
![FlowFuse Expert open by default in the immersive editor.](../images/assistant/ff-expert-opened-by-default.png){data-zoomable}
17+
!["Chat interface of FlowFuse Expert alongside the Node-RED editor"](../images/assistant/flowfuse-expert-drawer.png){data-zoomable}
1818

1919
## Chat Modes
2020

@@ -42,13 +42,33 @@ The chat interface operates in two distinct modes. You can switch between them u
4242

4343
### Support Mode
4444

45-
**Support mode** is for flow-building assistance. Use it when you need help understanding, building, or debugging your Node-RED flows. In this mode, the Expert draws on its knowledge of Node-RED, your installed palette, and the context of your current flows to answer questions and provide guidance.
45+
**Support mode** is for flow-building assistance. Use it when you need help understanding, building, or debugging your Node-RED flows. Expert draws on its knowledge of Node-RED, your installed palette, and the context of your current flows to answer questions, explain and debug flows, and, when agentic flow building is enabled, build flows directly on your canvas.
4646

4747
Typical use cases in Support mode:
4848
- "How do I convert data to CSV for writing to file & do you have any flow examples?"
4949
- "Explain what this flow is doing"
5050
- "Why is this node outputting a number instead of a string?"
5151
- "Is `node-red-contrib-string` node installed on this instance?"
52+
- "Build a flow that reads from Modbus and publishes each tag value to MQTT"
53+
54+
#### Building Flows on the Canvas
55+
56+
Expert can act on your requests directly by adding tabs, placing and wiring nodes, and configuring node properties on the canvas, rather than only describing what you should do yourself.
57+
58+
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.
59+
60+
![FlowFuse Expert building and configuring a flow directly on the Node-RED canvas](../images/assistant/flowfuse-expert-building-flow.gif){data-zoomable}
61+
62+
Some prompts that work well:
63+
64+
- "Create a flow that reads Modbus registers from `192.168.1.10` every 5 seconds and publishes the values to MQTT on `factory/line3/temperature`"
65+
- "Build an OEE dashboard tab with downtime reason buttons and a shift target gauge"
66+
- "Add a shift handover screen that shows the last 5 alarms and a notes input field"
67+
- "Set up a flow that polls an HTTP endpoint every minute and sends an alert if the response status is not 200"
68+
69+
The more specific your prompt, the closer the result will be to what you need. Include node names, topic paths, endpoints, or field names where you have them. Expert will use them directly rather than substituting placeholders.
70+
71+
> **Availability:** This feature is currently available on **FlowFuse Cloud** (Starter, Team, and Enterprise tiers) and must be enabled for your team on request. [Contact us](https://flowfuse.com/contact-us/?subject=FlowFuse%20Expert%20Application%20Building) to get access. Self-hosted support is coming in a future release.
5272
5373
#### Context: What the Expert Can See
5474

@@ -159,9 +179,9 @@ Typical use cases in Insights mode:
159179

160180
## Writing Better Queries
161181

162-
The quality of the Expert's responses depends heavily on how your questions are phrased. The more specific and contextual your query, the more accurate and actionable the answer.
182+
The quality of Expert's responses depends heavily on how your prompt is phrased, whether you are asking a question or requesting Expert to build something on the canvas. The more specific and contextual your prompt, the more accurate and actionable the result.
163183

164-
Here are some common patterns to improve your queries:
184+
Here are some common patterns to improve your prompts:
165185

166186
### Be specific about what you're referring to
167187

@@ -234,4 +254,4 @@ When a newer version of FlowFuse Expert is available, a banner appears in the ch
234254
font-size: 1.15rem;
235255
pointer-events: none;
236256
}
237-
</style>
257+
</style>

docs/user/expert/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ FlowFuse Expert works in two distinct ways inside your environment.
1414

1515
### Chat Interface
1616

17-
The Chat Interface is a conversational AI panel built into the FlowFuse Platform and accessible directly within the Node-RED editor. You can ask questions, get help building and debugging flows, query live operational data via MCP, and explore your environment using context-aware tools.
17+
The Chat Interface is a conversational AI panel built into the FlowFuse Platform and accessible directly within the Node-RED editor. With agentic flow building enabled, you can describe what you want to build and Expert will build it on your canvas for you. It can also answer questions, debug flows, and query live operational data via MCP.
1818

19-
The Chat Interface supports two modes - **Support** for flow-building assistance, and **Insights** for querying live data via MCP tools and resources.
19+
The Chat Interface supports two modes:
20+
- **Support**: flow-building assistance, including asking questions, debugging, and building flows on the canvas
21+
- **Insights**: query live operational data via MCP tools and resources exposed by your own MCP servers
2022

2123
[Learn more about the Chat Interface](/docs/user/expert/chat/)
2224

499 KB
Loading
316 KB
Loading
395 KB
Loading

docs/user/instance-settings.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,32 @@ navTitle: Instance Settings
66

77
The Instance Settings allow you to customize many aspects of your Node-RED runtime.
88

9+
To access them, click on an instance from the FlowFuse platform and select the **Settings** tab. The instance view also includes other tabs such as Overview, Devices, Version History, Assets, and Node-RED Logs.
10+
11+
You can also access all the same settings from within the immersive Node-RED editor. The settings drawer sits alongside the canvas without overlapping it, so you can adjust environment variables, manage snapshots, update the palette, and make other changes without leaving your flow.
12+
13+
You can customize the drawer layout using the eye icon at the top of the drawer, which lets you move it from right to left, pin or unpin it, and toggle fullscreen mode.
14+
15+
![Instance settings drawer](./images/instance-settings.png)
16+
917
Instance Settings are split into a number of sections:
1018

11-
- [General](#general)
12-
- [Environment](#environment)
13-
- [High Availability](#high-availability)
14-
- [Editor](#editor)
15-
- [Security](#security)
16-
- [Palette](#palette)
17-
- [Alerts](#alerts)
19+
- [Instance Settings](#instance-settings)
20+
- [General](#general)
21+
- [Change Stack](#change-stack)
22+
- [Copy Instance](#copy-instance)
23+
- [Import Instance](#import-instance)
24+
- [Suspend Instance](#suspend-instance)
25+
- [Delete Instance](#delete-instance)
26+
- [Environment](#environment)
27+
- [High Availability](#high-availability)
28+
- [Editor](#editor)
29+
- [Security](#security)
30+
- [None](#none)
31+
- [Basic Authentication](#basic-authentication)
32+
- [FlowFuse User Authentication](#flowfuse-user-authentication)
33+
- [Palette](#palette)
34+
- [Alerts](#alerts)
1835

1936
## General
2037

docs/user/snapshots.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -250,22 +250,29 @@ _Screenshot to an example flow preview for a Snapshot in FlowFuse_
250250

251251
### Comparing Snapshots
252252

253-
From any Snapshots tab, you can compare two snapshots by selecting the Snapshot's action,
254-
then selecting "Compare Snapshots". This will open a new dialog with the option to choose
255-
a second snapshot to compare with.
253+
From any Snapshots tab, you can compare two snapshots by selecting the Snapshot's action, then selecting "Compare Snapshots". This will open a dialog where you choose a second snapshot to compare with.
256254

257-
In the top left, a sidebar lists every changed, added, and deleted node, showing what action
258-
occurred for each. The flow canvas highlights the selected node and scrolls to it
259-
automatically, giving you a visual indication of where the change is in your flow. The right
260-
side shows the property and code changes for the affected node. You can step through them
261-
one at a time using the **Prev / Next** buttons. For each change you can see:
255+
The comparison view has three panels:
262256

263-
- **Property diffs** - Each changed property is shown inline with the old and new value side by side, with red `-` for removed and green `+` for added
257+
- **Left sidebar** — lists every node that differs between the two snapshots. Each entry shows a node-type badge (config node, tab, or regular node) and one of three statuses:
258+
- **Added** — the node exists in the newer snapshot but not the older one
259+
- **Deleted** — the node existed in the older snapshot but has been removed
260+
- **Changed** — the node exists in both snapshots but one or more properties differ
261+
- **Flow canvas** — highlights the selected node and scrolls to it automatically, giving a visual indication of where the change is in your flow
262+
- **Right panel** — shows the property and code changes for the selected node. Use the **Prev / Next** buttons to step through changes one at a time
263+
264+
Selecting an entry in the sidebar highlights the corresponding node on the canvas. The highlight clears automatically when you select a different entry.
265+
266+
There are two types of diff shown in the right panel:
267+
268+
- **Property diffs** — each changed property is shown with the old and new value side by side, with red `-` for removed and green `+` for added
264269

265270
![Screenshot showing property-level diff with old and new values displayed side by side](images/snapshots/snapshot-diff-prop-change.png)
266271
_Screenshot showing property-level diff with old and new values displayed side by side_
267272

268-
- **Code diffs** - For multiline properties — for example in function and template nodes — code changes appear as a line-level diff with red `-` for removed lines and green `+` for added, the same format you'd expect from a git diff
273+
- **Code diffs** — for multiline properties such as function and template nodes, changes appear as a line-level diff with red `-` for removed lines and green `+` for added, in the same format as a git diff. Use the **Prettify** and **Wrap** toggles to make large or nested values easier to read
269274

270275
![Screenshot showing a code diff for a function node with red and green line-level changes](images/snapshots/snapshot-diff-code-change.png)
271276
_Screenshot showing a code diff for a function node with red and green line-level changes_
277+
278+
Not every difference between two snapshots is meaningful. Computed layout properties such as group node `w` and `h` values are automatically excluded because they are recalculated by Node-RED and do not reflect intentional edits. Position-only changes (nodes that moved on the canvas but had no property edits) can be hidden when you want to focus on substantive changes.

0 commit comments

Comments
 (0)