Skip to content
Open
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
3 changes: 3 additions & 0 deletions _includes/docs-content.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
<div class="col-10-12">
{% endif %}
<div class="docs-content">
{% if banner %}
<div class="docs-banner">{{ banner}}</div>
{% endif %}
<h1 class="docs-title">{{ page.title }}</h1>
<div>{{ content }}</div>
</div>
Expand Down
3 changes: 3 additions & 0 deletions _includes/toc-editor-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<ul>
<li class="toctitle active"><a href="/docs/user-guide/editor">Editor Guide</a></li>
<li {% if page.url == "/docs/user-guide/editor/workspace/" %}class="active"{% endif %}><a href="/docs/user-guide/editor/workspace">Workspace</a></li>
<li {% if page.url == "/docs/user-guide/editor/workspace/actions" %}class="active"{% endif %}><a href="/docs/user-guide/editor/workspace/actions" style="padding-left: 50px;">Actions</a></li>
<li {% if page.url == "/docs/user-guide/editor/workspace/keyboard" %}class="active"{% endif %}><a href="/docs/user-guide/editor/workspace/keyboard" style="padding-left: 50px;">Keyboard</a></li>
<li {% if page.url == "/docs/user-guide/editor/workspace/flows" %}class="active"{% endif %}><a href="/docs/user-guide/editor/workspace/flows" style="padding-left: 50px;">Flows</a></li>
<li {% if page.url == "/docs/user-guide/editor/workspace/nodes" %}class="active"{% endif %}><a href="/docs/user-guide/editor/workspace/nodes" style="padding-left: 50px;">Nodes</a></li>
<li {% if page.url == "/docs/user-guide/editor/workspace/wires" %}class="active"{% endif %}><a href="/docs/user-guide/editor/workspace/wires" style="padding-left: 50px;">Wires</a></li>
Expand All @@ -16,6 +18,7 @@
<li {% if page.url == "/docs/user-guide/editor/palette/" %}class="active"{% endif %}><a href="/docs/user-guide/editor/palette/">Palette</a></li>
<li {% if page.url == "/docs/user-guide/editor/palette/manager" %}class="active"{% endif %}><a href="/docs/user-guide/editor/palette/manager" style="padding-left: 50px;">Palette Manager</a></li>
<li {% if page.url == "/docs/user-guide/editor/sidebar/" %}class="active"{% endif %}><a href="/docs/user-guide/editor/sidebar">Sidebar</a></li>
<li {% if page.url == "/docs/user-guide/editor/sidebar/explorer" %}class="active"{% endif %}><a href="/docs/user-guide/editor/sidebar/explorer" style="padding-left: 50px;">Explorer</a></li>
<li {% if page.url == "/docs/user-guide/editor/sidebar/info" %}class="active"{% endif %}><a href="/docs/user-guide/editor/sidebar/info" style="padding-left: 50px;">Information</a></li>
<li {% if page.url == "/docs/user-guide/editor/sidebar/help" %}class="active"{% endif %}><a href="/docs/user-guide/editor/sidebar/help" style="padding-left: 50px;">Help</a></li>
<li {% if page.url == "/docs/user-guide/editor/sidebar/debug" %}class="active"{% endif %}><a href="/docs/user-guide/editor/sidebar/debug" style="padding-left: 50px;">Debug</a></li>
Expand Down
12 changes: 8 additions & 4 deletions about/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ title: Release Plan
slug: releases
---

_Last Updated 2025-12-01_
_Last Updated 2026-06-09_


This plan is a guide for how the project plans to schedule upcoming releases, taking
into account the release schedule of the underlying Node.js runtime.

As an Open Source project, we rely on our contributors to make things happen. This can both
positively and negatively impact any well-intended schedule. Please take the information below
as what we aspire to achieve.

![](release-plan.png)

The project aims to make a new major release once a year to align with the Node.js schedule.
Expand All @@ -34,9 +38,9 @@ This proposal means:

Release | Initial | Maintenance Start | End-of-life
--------|-----------------|----------------------|-----------------
5.x. | *2026-01* | |
4.x | 2024-04-30. | *2026-01* | 2026-06-30
3.x | 2022-07-14 | 2024-04-30. | 2025-06-30
5.x. | 2026-06-09 | |
4.x | 2024-04-30 | 2026-06-09 | 2026-12-31
3.x | 2022-07-14 | 2024-04-30 | 2025-06-30
2.x | 2021-07-22 | 2022-07-14 | 2023-06-30
1.x | 2019-09-30 | 2021-04-30 | 2022-06-30

Expand Down
Binary file modified about/releases/release-plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions css/docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,15 @@ ul.toc li.tocheader li.toctitle a {
font-size: 15px;
line-height: 18px;
}

.docs-banner {
border: 1px solid #B68181;
padding: 10px;
border-radius: 4px;
font-weight: 500;
margin-top: 1em;
text-align: center;
}
.docs-content a {
color: #aa4444;
}
Expand Down
4 changes: 2 additions & 2 deletions docs/faq/node-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ title: Supported Node versions
slug: node versions
---

_Updated: December 2025_
_Updated: June 2026_

Node-RED currently recommends **Node 22.x**.
Node-RED currently recommends **Node 24.x**.

We try to stay up to date with Node.js releases. Our goal is to support
the [Maintenance and Active LTS releases](https://nodejs.org/en/about/releases/).
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/raspberrypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ This script will:
<img src="/images/logos/raspberrypi.svg" height="30">
**Note**: As of Node v24 there are NO 32 bit builds available - so armv6 based Pi devices will no longer be supported.
</div>

</div>

### Running locally
Expand Down Expand Up @@ -104,6 +103,7 @@ Once Node-RED is running you can access the editor in a browser.
If you are using the browser on the Pi desktop, you can open the address: <http://localhost:1880>.

<div class="doc-callout">We recommend using a browser outside of the Pi and pointing it at Node-RED running on the Pi. However you can use the built in browser and if so we recommend Chromium or Firefox.
</div>

When browsing from another machine you should use the hostname or IP-address of the Pi: `http://<hostname>:1880`. You
can find the IP address by running `hostname -I` on the Pi.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-deploy-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-config-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-node-appearance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-node-config-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-node-description.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-edit-subflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-flow-search-tabs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-flow-tabs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-node-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-node-port-label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-node-wire.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-quick-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user-guide/editor/images/editor-sidebar-config-nodes.png
Binary file modified docs/user-guide/editor/images/editor-sidebar-context.png
Binary file modified docs/user-guide/editor/images/editor-sidebar-debug-filter.png
Binary file modified docs/user-guide/editor/images/editor-sidebar-debug.png
Binary file modified docs/user-guide/editor/images/editor-sidebar-help.png
Binary file modified docs/user-guide/editor/images/editor-sidebar-info.png
Binary file modified docs/user-guide/editor/images/editor-user-settings-view.png
Binary file modified docs/user-guide/editor/images/editor-wiring-splice.png
Binary file modified docs/user-guide/editor/images/editor-workspace-navigator.png
Diff not rendered.
37 changes: 21 additions & 16 deletions docs/user-guide/editor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,29 @@ slug: editor
toc: toc-editor-guide.html
---

<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?list=PLyNBB9VCLmo1hyO-4fIZ08gqFcXBkHy-6" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
<div style="text-align: center;">
<div style="width: 400px; display: inline-block;" class="figure">
<img src="images/editor-default.png" alt="Editor window">
<p class="caption">Editor window</p>
</div>
</div>

The editor window consists of four components:

- The header at the top, containing the deploy button, main menu, and, if user
authentication is enabled, the user menu.
- The [palette](palette) on the left, containing the nodes available to use.
- The main [workspace](workspace) in the middle, where flows are created.
- The [sidebar](sidebar) on the right.
Welcome to the Node-RED editor - the place where you'll build, wire together, and run your flows. If you're just getting started, this guide will help you find your way around.

Follow the links above to learn more about each component.
Everything happens inside the editor window, which is organised into three main areas:

<div style="width: 400px; display: inline-block;" class="figure">
<img src="images/editor-default.png" alt="Editor window">
<p class="caption">Editor window</p>
</div>
- The header, running along the top, holds the deploy button and main menu - and the user menu too, if authentication is enabled.
- The [workspace](workspace) in the middle is where the work happens: this is where you build your flows.
- The [sidebars](sidebar) sit on either side of the workspace. They hold a set of panels - tools and information to support you as you work - and you can move any panel between the left and right sides to arrange the editor the way that suits you best.

<div style="width: 400px; display: inline-block;" class="figure">
<img src="images/editor-default-components.png" alt="Editor components">
<p class="caption">Editor components</p>
</div>
One panel worth knowing from the start is the [palette](palette), which lists all the nodes you have available to drag onto your canvas. It's where most flows begin. By default it lives in the left sidebar, but like any panel you can move it to wherever feels right.

Follow the links above to dig into any of these in more detail. There's no need to read everything at once - feel free to explore the editor as you go.


### Node-RED Essentials on YouTube

We also have a series of videos to help get you started. They haven't been updated for Node-RED 5 yet, but they still cover everything you need for working with Node-RED.

<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?list=PLyNBB9VCLmo1hyO-4fIZ08gqFcXBkHy-6" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
18 changes: 4 additions & 14 deletions docs/user-guide/editor/palette/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,14 @@ the palette.

Categories can be expanded or collapsed by clicking its header.

The <i style="font-size: 0.8em; border-radius: 2px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-angle-double-up"></i> and
<i style="font-size: 0.8em; border-radius: 2px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-angle-double-down"></i>
The <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-angle-double-up"></i> and
<i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-angle-double-down"></i>
buttons at the bottom of the palette can be used to collapse or expand all categories.

Above the palette is an input that can be used to filter the list of nodes.


<div style="width: 64px" class="figure align-left">
<img src="../images/editor-palette-toggle.png" alt="Palette toggle">
<p class="caption">Palette toggle</p>
</div>

The entire palette can be hidden by clicking the palette toggle that is shown when
the mouse is over the palette.

<table class="action-ref inline">
<tr><th colspan="2">Reference</th></tr>
<tr><td>Key shortcut</td><td><code>Ctrl/⌘-p</code></td></tr>
<tr><td>Menu option</td><td><code>View -&gt; Show Palette</code></td></tr>
<tr><td>Action</td><td><code>core:toggle-palette</code></td></tr>
<tr><td>Action</td><td><code>core:show-palette-tab</code></td></tr>
<tr><td>Key shortcut</td><td><code>Ctrl/⌘-g p</code></td></tr>
</table>
35 changes: 28 additions & 7 deletions docs/user-guide/editor/sidebar/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,17 @@ of messages, read the [Working with messages](/docs/user-guide/messages) guide.
<tr><td>Key shortcut</td><td><code>Ctrl/⌘-g d</code></td></tr>
</table>

### Filtering the messages

By default, the Debug sidebar shows all messages passed to it. This can be filtered
by clicking the <i style="font-size: 0.8em; border-radius: 2px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-filter"></i> button to open the filter options panel.
by clicking the <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-filter"></i> button to open the filter options menu.

<div style="width: 300px" class="figure">
<div style="width: 209px" class="figure">
<img src="../images/editor-sidebar-debug-filter.png" alt="Debug filter options">
<p class="caption">Debug filter options</p>
</div>

The panel provides three options:
The menu provides three options:

- *all nodes* - displays all messages
- *selected nodes* - select particular Debug nodes from a list of all available nodes
Expand All @@ -46,21 +48,40 @@ is currently showing a filtered list of messages, the hidden messages still coun
the 100 limit. If a flow has noisy Debug nodes, rather than filter them from the sidebar
it can be better to disable them by clicking their button in the workspace.

The sidebar can be cleared at any time by clicking the <i style="font-size: 0.8em; border-radius: 2px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-trash"></i> button.
### Pausing messages


<div style="width: 296px" class="figure align-right">
<img src="../images/editor-sidebar-debug-pause.png" alt="Debug paused">
<p class="caption">Debug paused</p>
</div>


The <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-pause"></i> button can be used to pause the debug output. Whilst paused, any new message will be dropped by the sidebar and the panel will report how many messages have been dropped.

<table class="action-ref inline">
<tr><th colspan="2">Reference</th></tr>
<tr><td>Action</td><td><code>core:toggle-debug-messages</code></td></tr>
</table>

### Clearing messages

The sidebar can be cleared at any time by clicking the <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-trash"></i> button. The button also provides a menu to choose whether to clear all debug messages, or just those that are currently shown.

<table class="action-ref inline">
<tr><th colspan="2">Reference</th></tr>
<tr><td>Action</td><td><code>core:clear-debug-messages</code></td></tr>
<tr><td>Key shortcut</td><td><code>Ctrl/⌘-Alt-l</code></td></tr>
</table>

### Opening a separate debug window

The <i style="font-size: 0.8em; border-radius: 2px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-desktop"></i> button
The <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-desktop"></i> button
in the sidebar footer can be used to open a separate browser window containing the Debug sidebar.

### Additional actions



The debug sidebar registers the following actions that can be accessed from the [action menu](../workspace/actions) or have a [keyboard shortcut](../workspace/keyboard) assigned.

<table class="action-ref inline">
<tr><th colspan="2">Reference</th></tr>
Expand Down
42 changes: 42 additions & 0 deletions docs/user-guide/editor/sidebar/explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
layout: docs-editor-guide
slug:
- url: /docs/user-guide/editor
label: editor
- url: "/docs/user-guide/editor/sidebar"
label: "sidebar"
- "info"
toc: toc-editor-guide.html
title: 'Sidebar: Explorer'
---

<div style="width: 206px" class="figure align-right">
<img src="../images/editor-sidebar-explorer.png" alt="Explorer Sidebar">
<p class="caption">Explorer Sidebar</p>
</div>

The Explorer sidebar shows an outline view of all flows and nodes,

The outline view can be searched using the same syntax as the [main search dialog](../workspace/search).

Hovering over an entry in the outline reveals a set of options.

<div style="width: 344px" class="figure">
<img src="../images/editor-sidebar-info-entry.png" alt="Outline entry options">
<p class="caption">Outline entry options</p>
</div>

The <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-search"></i> button will reveal the node/flow in the main workspace.

If the node has a button, such as the Debug and Inject nodes, the <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-toggle-right"></i> button can be used to trigger that button.


The <i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-circle-thin"></i> button can be used to enable or disable the node/flow.



<table class="action-ref inline">
<tr><th colspan="2">Reference</th></tr>
<tr><td>Action</td><td><code>core:show-explorer-tab</code></td></tr>
<tr><td>Key shortcut</td><td><code>Ctrl/⌘-g e</code></td></tr>
</table>
10 changes: 2 additions & 8 deletions docs/user-guide/editor/sidebar/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,10 @@ title: 'Sidebar: Help'
<p class="caption">Help Sidebar</p>
</div>

*Since Node-RED 1.1.0*

In previous versions of Node-RED, the help text for the currently selected node
was displayed in the Information sidebar.

Introduced in Node-RED 1.1.0, the Help sidebar provides access to the help content
for all nodes in the editor - not just the current selection.
The Help sidebar provides access to the help content for all nodes in the editor.

The top section provides a full table of contents, that can be toggled using the
<i style="font-size: 0.8em; border-radius: 2px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-list-ul"></i> button.
<i style="font-size: 0.8em; border-radius: 4px; display:inline-block;text-align:center; width: 20px; color: #777; border: 1px solid #777; padding: 3px;" class="fa fa-list-ul"></i> button.


<table class="action-ref inline">
Expand Down
Loading