diff --git a/_includes/toc-editor-guide.html b/_includes/toc-editor-guide.html index fc8e89a9..33af8209 100644 --- a/_includes/toc-editor-guide.html +++ b/_includes/toc-editor-guide.html @@ -4,6 +4,8 @@

Editor Guide
Workspace
Actions
Keyboard
Flows
Nodes
Wires
Palette
Palette Manager
Sidebar
Explorer
Information
Help
Debug

diff --git a/_posts/2026-06-09-version-5-0-released.md b/_posts/2026-06-09-version-5-0-released.md new file mode 100644 index 00000000..ad011db2 --- /dev/null +++ b/_posts/2026-06-09-version-5-0-released.md @@ -0,0 +1,230 @@ +--- +layout: blog +title: Version 5.0 released +author: nick +image: /blog/content/images/2026/06/nr5-social.png +--- + +Node-RED 5.0 is now available to [install](https://npmjs.org/package/node-red). If upgrading, please read the [upgrade instructions](http://nodered.org/docs/getting-started/upgrading.html). + +Node-RED 5.0 is the biggest change to the editor experience in the history of the project. Back in our [roadmap post](/blog/2025/12/03/node-red-roadmap-to-5) we set out four areas of focus - modernising the UX, improving node appearance, targeted functional enhancements, and updating our project infrastructure. After a long run of beta releases - and a huge amount of community feedback along the way - we're delighted to bring it all together in the final release. + +We've highlighted the main changes below. As always, there have also been a large number of community contributions ranging from bug fixes, features, documentation and translations. We wouldn't be able to do what we do without these contributions - a big thank you to everyone involved. + +The [Change Log](https://github.com/node-red/node-red/releases/tag/5.0.0) has the full list of changes in this release. + +--- +- [A modernised editor](#a-modernised-editor) + - [Redesigned sidebars](#redesigned-sidebars) + - [The Explorer and Information sidebars](#the-explorer-and-information-sidebars) + - [Built-in Dark theme](#built-in-dark-theme) + - [Accessibility improvements](#accessibility-improvements) + - [Updated selection appearance](#updated-selection-appearance) + - [Updated pan and zoom](#updated-pan-and-zoom) + - [Node documentation](#node-documentation) + - [GitHub-style alerts in Markdown](#github-style-alerts-in-markdown) + - [Other editor updates](#other-editor-updates) +- [Functional enhancements](#functional-enhancements) + - [Pausing debug output](#pausing-debug-output) + - [Calling Link nodes from the Function node](#calling-link-nodes-from-the-function-node) + - [Sorted node selection lists](#sorted-node-selection-lists) + - [Delay node burst mode](#delay-node-burst-mode) +- [Node and security updates](#node-and-security-updates) + - [More TLS options](#more-tls-options) + - [Hardened authentication](#hardened-authentication) + - [Other updates](#other-updates) +- [Under the hood](#under-the-hood) + - [Node.js 24](#nodejs-24) + - [Bundling npm](#bundling-npm) + - [Modernised developer setup](#modernised-developer-setup) +- [Full Changelog](#full-changelog) +- [Community](#community) + +--- + +## A modernised editor + +The general look and feel of the editor hadn't changed substantially in a long time. With 5.0 we've taken the opportunity to step back and rethink how the editor is laid out, with a focus on better information flow, more flexible use of space, and improved accessibility. + +This was a big, iterative piece of work, refined through the beta releases in response to community feedback. The result is an editor that should feel familiar, but makes far better use of the space available to you. + +

The modernised Node-RED 5 editor

+ +### Redesigned sidebars + +Previously the sidebars were a catch-all space on the right-hand side, with the available panels hidden behind a hard-to-discover drop-down menu. Both sides of the editor now share the same, more discoverable sidebar behaviour. + +The biggest change is that you can now **show two panels at a time** by splitting a sidebar vertically. This means you can, for example, keep the Debug panel visible in the lower section while working with another panel above it - a long-requested capability. + +You can rearrange panels by **dragging them directly** between the available positions. Each panel has a small header showing its name that you can grab to move it around the editor - to either side, or into the upper or lower section of a side. + +Along the bottom are the sidebar buttons, grouped by sidebar section, and toggle buttons to open and close the sidebars in a single click. + +

Sidebar toolbar

+ +### The Explorer and Information sidebars + +The old Info sidebar has been split into two distinct panels: + + - The **Explorer** lets you navigate your flows and nodes. In our left-to-right reading convention it's far more natural to have this overview on the left, so it's now the default panel in the top-left sidebar section. + - The **Information** panel shows details on whatever you currently have selected, and is the default panel shown in the top-right. + +

The Explorer and Information sidebar panels

+ +### Built-in Dark theme + +Node-RED finally has a **built-in Dark theme**. The editor automatically picks the light or dark theme based on your browser/OS preference, and you can explicitly choose one in the User Settings dialog. + +

Node-RED 5 dark mode theme

+ +Alongside this, we've added a mechanism for theme plugins to provide multiple variants - so a third-party theme can now ship both a light and dark variant in a single package, and have the editor switch between them automatically. + +### Accessibility improvements + +Improved accessibility has been a recurring theme throughout this work. We've started applying appropriate ARIA attributes across the editor, the dropdown menus are more touch-accessible and scroll when there isn't enough vertical space, and the theme has had a number of contrast and accessibility refinements. There's always more to do here, but Google Lighthouse is much happier with us than it was before. + +#### Updated selection appearance + +As part of the accessibility improvements, selected nodes now show as a blue halo around the node, rather than just changing the node's border. This makes it much easier to spot what's selected, and clashes far less with the colour of the node body. + + +

Node selection

+ +#### Updated pan and zoom + +We've updated various pan/zoom interactions withe workspace to better align with standard behaviours seen elsewhere. + +As before, you can pan with the middle-mouse button. If you don't have one, you can now hold the spacebar and drag with the left-mouse button to achieve the same result. There's a new **'zoom to fit'** button in the status bar that zooms your view so all of your nodes are visible. Pinch-zoom on touch screens is also much better behaved, and shift-scroll now works consistently across browsers. + +### Node documentation + +Node that have additional documentation added under the [description tab of their edit dialog](/docs/user-guide/editor/workspace/nodes#editing-node-properties) now show a badge in the workspace. Clicking on the badge will show the documentation in a pop-up. + +

Node documentation badge

+ +### GitHub-style alerts in Markdown + +The Markdown used throughout the editor - in node help, the Comment node, info text and more - now supports [GitHub-style alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts). Adding a marker such as `> [!IMPORTANT]` or `> [!WARNING]` to a blockquote renders it as a highlighted callout. The Markdown editor toolbar also gained a button to help you discover and insert them. + + +

Markdown editor including an Information alert

+ + + +### Other editor updates + + - Search navigation now appears in a popover rather than expanding the status bar, so the status widgets no longer shuffle around as you step through results ([#5744](https://github.com/node-red/node-red/pull/5744)). + - The default palette categories now have description tooltips, and custom categories can provide their own descriptions via a theme plugin or node ([#5769](https://github.com/node-red/node-red/pull/5769)). + - Some missing core actions and keyboard shortcuts have been added and tidied up - including shortcuts to show the Palette (ctrl-g p) and Explorer (ctrl-g e) panels, and an action to toggle the Debug sidebar's pause state ([#5777](https://github.com/node-red/node-red/pull/5777)). + +## Functional enhancements + +### Pausing debug output + +A long-requested feature: you can now **pause the Debug sidebar** using a toggle button in its header. While paused, the panel stops scrolling and any new messages received are dropped. + +

Pausing debug output

+ + +### Calling Link nodes from the Function node + +It's now possible to call a Link node from the middle of a Function node and wait for a response to be sent back. For example, if you'd built a flow wrapped in Link nodes to handle database queries, you could call it from code with: + +```js +const { payload: data } = await node.linkcall('query-database', { query: "SELECT * FROM T1" }) +``` + +The new API is exposed as `node.linkcall`. You pass it the name, or id, of the `link in` node to call along with the message to send it. + +Fully details of the api are available in the [Function node documentation](/docs/user-guide/writing-functions#calling-link-nodes). + +### Sorted node selection lists + +The Link, Complete, Catch and Status nodes all present a list of other nodes to select from in their edit dialog. Previously this list was shown in the order the nodes were added to the workspace. It's now sorted alphabetically by label, making it much easier to find the node you're after. + +### Delay node burst mode + +The Delay node's rate-limiting mode has always spread incoming messages out evenly to the configured rate. It can now also be put into **burst mode**, where it lets messages through at whatever rate they arrive until the limit is reached - at which point it blocks them until the start of the next time interval. + +## Node and security updates + +### More TLS options + +The TLS configuration node and several core nodes have gained more flexible options for securing connections: + + - TLS certificates and keys can now be supplied from a PFX/P12 file ([#4907](https://github.com/node-red/node-red/pull/4907)). + - Certificates and keys can be loaded from environment variables ([#5376](https://github.com/node-red/node-red/pull/5376)). + - The HTTP Request node can now set the TLS SNI server name ([#5667](https://github.com/node-red/node-red/pull/5667)). + +### Hardened authentication + +We've made a couple of changes to tighten up the editor's authentication: + + - OAuth logins now use a token-exchange pattern ([#5657](https://github.com/node-red/node-red/pull/5657)). + - The default admin CORS rules have been removed ([#5652](https://github.com/node-red/node-red/pull/5652)). + +### Other updates + + - The Monaco code editor used by the Function node has been updated to the latest release ([#5508](https://github.com/node-red/node-red/pull/5508)). + - New credentials files are now created next to the flows file, rather than in the user directory ([#4951](https://github.com/node-red/node-red/pull/4951)). + - The WebSocket client now only connects when it needs to ([#5533](https://github.com/node-red/node-red/pull/5533)). + - The touch radial menu has been replaced with the standard context menu for a more consistent experience ([#5614](https://github.com/node-red/node-red/pull/5614)). + +## Under the hood + +### Node.js 24 + +Node-RED 5.0 requires a *minimum of Node.js 22.9.0* to run - it will not run anything earlier. + +However, keeping in mind the Node.js support scheduled, we recommend using **Node.js 24**, and this is what our Docker images are based on. + +As the Node.js project no longer create 32bit ARM (`arm/v7`) based images, we are no longer able to support running on older Raspberry Pis (3b or earlier) as they cannot run the required 64bit OS. + +### Bundling npm + +Previously, Node-RED relied on `npm` being installed and on the path for the palette manager to work. With this release, `npm` is now an explicit dependency of Node-RED. This gives us more control over how it's used and closes some potential security issues. + +### Modernised developer setup + +For contributors to the core code base, we've migrated away from the `grunt` task runner in favour of custom `npm` scripts. Grunt was the right choice 13 years ago, but the world has moved on - and now, so have we. This lets us drop a lot of unmaintained devDependencies from the project. + +We've also moved off the long-dormant `jshint` to `eslint`. At this stage we're not applying any new linting rules, but it lays the groundwork to do so in the near future. + +## Full Changelog + +The full set of changes in this release can be found in the [changelog](https://github.com/node-red/node-red/releases/tag/5.0.0). + +Thank you to everyone who contributed to this release - we wouldn't be able to do it without you! + +## Community + +As an open-source project we are reliant on the contribution of the community. We have a strong and vibrant user community, well demonstrated by the activity on the [forums](https://discourse.nodered.org). It's great to see the support the community provides each other. + +If you're interested in contributing to Node-RED, now is a good time to come over and chat with us in either the [forum](https://discourse.nodered.org) or [slack](https://nodered.org/slack). diff --git a/about/contribute/index.md b/about/contribute/index.md index 85db6bbd..3761faf3 100644 --- a/about/contribute/index.md +++ b/about/contribute/index.md @@ -100,7 +100,7 @@ The following workflow is used in git for the main project repositories. As in traditional git workflows, multiple branches are used for different streams of activity. The following describes how we use it today. - - `master` - this branch contains the latest shipped release of Node-RED, plus + - `main` - this branch contains the latest shipped release of Node-RED, plus any additional bug fixes that have been made since. At any time, this branch could get shipped as the next maintenance release. At the time of writing, this contains 0.16.2 and a few fixes that will be released as 0.16.3 at some point. diff --git a/about/releases/index.md b/about/releases/index.md index cda2c717..d76593b8 100644 --- a/about/releases/index.md +++ b/about/releases/index.md @@ -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. @@ -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 diff --git a/about/releases/release-plan.png b/about/releases/release-plan.png index 759cd934..ebea9147 100644 Binary files a/about/releases/release-plan.png and b/about/releases/release-plan.png differ diff --git a/blog/content/images/2026/06/editor-dark-mode.png b/blog/content/images/2026/06/editor-dark-mode.png new file mode 100644 index 00000000..ea381c7d Binary files /dev/null and b/blog/content/images/2026/06/editor-dark-mode.png differ diff --git a/blog/content/images/2026/06/editor-node-docs.png b/blog/content/images/2026/06/editor-node-docs.png new file mode 100644 index 00000000..10d1de8e Binary files /dev/null and b/blog/content/images/2026/06/editor-node-docs.png differ diff --git a/blog/content/images/2026/06/editor-sidebar-debug-pause.png b/blog/content/images/2026/06/editor-sidebar-debug-pause.png new file mode 100644 index 00000000..7109dd96 Binary files /dev/null and b/blog/content/images/2026/06/editor-sidebar-debug-pause.png differ diff --git a/blog/content/images/2026/06/editor-sidebar-explorer.png b/blog/content/images/2026/06/editor-sidebar-explorer.png new file mode 100644 index 00000000..272ce407 Binary files /dev/null and b/blog/content/images/2026/06/editor-sidebar-explorer.png differ diff --git a/blog/content/images/2026/06/editor-sidebar-info.png b/blog/content/images/2026/06/editor-sidebar-info.png new file mode 100644 index 00000000..b9bfe30b Binary files /dev/null and b/blog/content/images/2026/06/editor-sidebar-info.png differ diff --git a/blog/content/images/2026/06/editor-sidebar-toolbar.png b/blog/content/images/2026/06/editor-sidebar-toolbar.png new file mode 100644 index 00000000..d7c00e2a Binary files /dev/null and b/blog/content/images/2026/06/editor-sidebar-toolbar.png differ diff --git a/blog/content/images/2026/06/node-markdown-editor.png b/blog/content/images/2026/06/node-markdown-editor.png new file mode 100644 index 00000000..16bdeae2 Binary files /dev/null and b/blog/content/images/2026/06/node-markdown-editor.png differ diff --git a/blog/content/images/2026/06/node-selection.png b/blog/content/images/2026/06/node-selection.png new file mode 100644 index 00000000..2549bfa2 Binary files /dev/null and b/blog/content/images/2026/06/node-selection.png differ diff --git a/blog/content/images/2026/06/nr5-editor-overview.png b/blog/content/images/2026/06/nr5-editor-overview.png new file mode 100644 index 00000000..eb29cb6f Binary files /dev/null and b/blog/content/images/2026/06/nr5-editor-overview.png differ diff --git a/css/docs.css b/css/docs.css index 5021f8e2..d7df80b4 100644 --- a/css/docs.css +++ b/css/docs.css @@ -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; } diff --git a/docs/api/ui/treeList/index.md b/docs/api/ui/treeList/index.md index b6c6b806..2476b3b5 100644 --- a/docs/api/ui/treeList/index.md +++ b/docs/api/ui/treeList/index.md @@ -89,6 +89,7 @@ Property | Description `expanded` | (optional) If the item has children, set whether to display the children `deferBuild` | (optional) Delay building any UI elements for the item's children until it is expanded for the first time. This can have a significant performance benefit for large data sets. `element` | (optional) Custom DOM element to be used in place of the node's label. This is ignored if `label` is set. +`expandOnClick` | (optional) *since 5.0* If the item has children, set whether to expand on first click. Setting to `false` will mean the first click selects the item, a second click will expand it. The default behaviour is to expand (`true`). If the `children` property is provided as a function, that function should accept a single argument of a callback function. That callback function should be called diff --git a/docs/creating-nodes/first-node.md b/docs/creating-nodes/first-node.md index ec60174d..4a33e149 100644 --- a/docs/creating-nodes/first-node.md +++ b/docs/creating-nodes/first-node.md @@ -110,19 +110,24 @@ For more information about the runtime part of the node, see [here](node-js). ```html ~~~~ diff --git a/docs/faq/node-versions.md b/docs/faq/node-versions.md index a194929e..1accfc8f 100644 --- a/docs/faq/node-versions.md +++ b/docs/faq/node-versions.md @@ -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/). diff --git a/docs/getting-started/android.md b/docs/getting-started/android.md index 9441a429..040daeb5 100644 --- a/docs/getting-started/android.md +++ b/docs/getting-started/android.md @@ -23,7 +23,7 @@ Install it, and run it. Then at the prompt type apt update apt upgrade apt install coreutils nano nodejs - npm i -g --unsafe-perm node-red + npm i -g node-red node-red Then you can point a browser to `http://localhost:1880` diff --git a/docs/getting-started/aws.md b/docs/getting-started/aws.md index 116b5d63..4278ff1f 100644 --- a/docs/getting-started/aws.md +++ b/docs/getting-started/aws.md @@ -69,7 +69,7 @@ You will be asked if you wish to use ssh. If you do, please ensure you have ssh } ``` -2. Copy the default [Node-RED settings.js file](https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js) to the demoapp directory +2. Copy the default [Node-RED settings.js file](https://github.com/node-red/node-red/blob/main/packages/node_modules/node-red/settings.js) to the demoapp directory 3. Edit the settings.js file to add the following entries to module.exports (setting awsRegion to that used in eb init and replacing demoapp with your app name) : @@ -137,7 +137,7 @@ Once logged in you need to install node.js and Node-RED curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - sudo apt-get install -y nodejs build-essential - sudo npm install -g --unsafe-perm node-red + sudo npm install -g node-red At this point you can test your instance by running `node-red`. *Note*: you may @@ -149,7 +149,7 @@ Once started, you can access the editor at `http://:1880/`. To get Node-RED to start automatically whenever your instance is restarted, you can use pm2: - sudo npm install -g --unsafe-perm pm2 + sudo npm install -g pm2 pm2 start `which node-red` -- -v pm2 save pm2 startup diff --git a/docs/getting-started/azure.md b/docs/getting-started/azure.md index 44d7f515..0213b97d 100644 --- a/docs/getting-started/azure.md +++ b/docs/getting-started/azure.md @@ -49,7 +49,7 @@ Once logged in you need to install node.js and Node-RED curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash - sudo apt-get install -y nodejs build-essential - sudo npm install -g --unsafe-perm node-red + sudo npm install -g node-red At this point you can test your instance by running `node-red`. *Note*: you may @@ -61,7 +61,7 @@ Once started, you can access the editor at `http://:1880/`. To get Node-RED to start automatically whenever your instance is restarted, you can use pm2: - sudo npm install -g --unsafe-perm pm2 + sudo npm install -g pm2 pm2 start `which node-red` -- -v pm2 save pm2 startup diff --git a/docs/getting-started/beaglebone.md b/docs/getting-started/beaglebone.md index 3b8d8445..be9ef5ec 100644 --- a/docs/getting-started/beaglebone.md +++ b/docs/getting-started/beaglebone.md @@ -85,4 +85,4 @@ The easiest way to install them is direct from npm. To install manually run the following command: - sudo npm install -g --unsafe-perm beaglebone-io johnny-five node-red-contrib-gpio + sudo npm install -g beaglebone-io johnny-five node-red-contrib-gpio diff --git a/docs/getting-started/development.md b/docs/getting-started/development.md index 0e0c717e..b712c0a2 100644 --- a/docs/getting-started/development.md +++ b/docs/getting-started/development.md @@ -34,7 +34,7 @@ are inside that directory. You should then pick which branch you want to build. - - `master` - the default branch. This is the maintenance branch which contains + - `main` - the default branch. This is the maintenance branch which contains the code of the current stable release, plus any bug fixes that have been applied ahead of the next maintenance release. diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md index 90cd67f2..553e3078 100644 --- a/docs/getting-started/docker.md +++ b/docs/getting-started/docker.md @@ -238,7 +238,7 @@ FROM nodered/node-red # of your added nodes modules for Node-RED WORKDIR /data COPY package.json /data -RUN npm install --unsafe-perm --no-update-notifier --no-fund --only=production +RUN npm install --no-update-notifier --no-fund --only=production WORKDIR /usr/src/node-red # Copy _your_ Node-RED project files into place diff --git a/docs/getting-started/local.md b/docs/getting-started/local.md index ea6d3ef3..5c9d41cd 100644 --- a/docs/getting-started/local.md +++ b/docs/getting-started/local.md @@ -44,7 +44,7 @@ To install Node-RED locally you will need a [supported version of Node.js](/docs To install Node-RED you can use the `npm` command that comes with node.js: ``` -sudo npm install -g --unsafe-perm node-red +sudo npm install -g node-red ``` If you are using Windows, do not start the command with sudo. @@ -54,7 +54,7 @@ That command will install Node-RED as a global module along with its dependencie You can confirm it has succeeded if the end of the command output looks similar to: ``` -+ node-red@4.1.2 ++ node-red@4.1.7 added 227 packages in 13s found 0 vulnerabilities ``` @@ -69,8 +69,7 @@ For more detailed information see our [docker](/docs/getting-started/docker) gui ### Installing with snap -If your OS supports [Snap](https://snapcraft.io/docs/core/install) you can install -Node-RED with: +Generally not recommended, but if your OS supports [Snap](https://snapcraft.io/docs/core/install) you can install Node-RED with: ``` sudo snap install node-red @@ -84,7 +83,9 @@ When installed as a Snap package, it will run in a secure container that **does - direct access to gpio hardware - access to any external commands your flows want to use with the Exec node (for example). +

If you need access to system hardware or to add nodes that require compilation then we recommend using a full install of Node-RED and not using the snap. +

### Running @@ -97,17 +98,17 @@ $ node-red Welcome to Node-RED =================== -22 Dec 21:51:27 - [info] Node-RED version: v4.1.2 -22 Dec 21:51:27 - [info] Node.js version: v20.19.6 -22 Dec 21:51:27 - [info] Linux 6.8.0-90-generic x64 LE -22 Dec 21:51:27 - [info] Loading palette nodes -22 Dec 21:51:30 - [info] Settings file : /home/pi/.node-red/settings.js -22 Dec 21:51:30 - [info] Context store : 'default' [module=memory] -22 Dec 21:51:30 - [info] User directory : /home/pi/.node-red -22 Dec 21:51:30 - [warn] Projects disabled : editorTheme.projects.enabled=false -22 Dec 21:51:30 - [info] Flows file : /home/pi/.node-red/flows.json -22 Dec 21:51:30 - [info] Server now running at http://127.0.0.1:1880/ -22 Dec 21:51:30 - [info] Starting flows +06 Mar 21:51:27 - [info] Node-RED version: v4.1.7 +06 Mar 21:51:27 - [info] Node.js version: v22.22.1 +06 Mar 21:51:27 - [info] Linux 6.8.0-90-generic x64 LE +06 Mar 21:51:27 - [info] Loading palette nodes +06 Mar 21:51:30 - [info] Settings file : /home/pi/.node-red/settings.js +06 Mar 21:51:30 - [info] Context store : 'default' [module=memory] +06 Mar 21:51:30 - [info] User directory : /home/pi/.node-red +06 Mar 21:51:30 - [warn] Projects disabled : editorTheme.projects.enabled=false +06 Mar 21:51:30 - [info] Flows file : /home/pi/.node-red/flows.json +06 Mar 21:51:30 - [info] Server now running at http://127.0.0.1:1880/ +06 Mar 21:51:30 - [info] Starting flows ``` You can then access the Node-RED editor by pointing your browser at . @@ -203,7 +204,7 @@ If you have installed Node-RED as a global npm package, you can upgrade to the latest version with the following command: ``` -sudo npm install -g --unsafe-perm node-red +sudo npm install -g node-red ``` If you are using Windows, do not start the command with sudo. diff --git a/docs/getting-started/raspberrypi.md b/docs/getting-started/raspberrypi.md index 460283ea..cd8d742a 100644 --- a/docs/getting-started/raspberrypi.md +++ b/docs/getting-started/raspberrypi.md @@ -14,10 +14,10 @@ Pi, and other platforms running a Debian based OS. The script can also be used to upgrade an existing install when a new release is available. Running the following command will download and run the script. If you want -to review the contents of the script first, you can view it [on Github](https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered). +to review the contents of the script first, you can view it [on Github](https://raw.githubusercontent.com/node-red/linux-installers/master/deb/install-update-nodered). ``` -bash <(curl -sL https://github.com/node-red/linux-installers/releases/latest/download/update-nodejs-and-nodered-deb) +bash <(curl -sL https://github.com/node-red/linux-installers/releases/latest/download/install-update-nodered-deb) ``` There are extra parameters you can pass to the script. Add --help to the end of the above command to see them. @@ -35,7 +35,7 @@ first to ensure npm is able to fetch and build any binary modules it needs to in This script will: - remove the existing version of Node-RED if present. - - if it detects Node.js is already installed, it will ensure it is at least v18. If nothing is found it will install the Node.js 20 LTS release using the [NodeSource](https://github.com/nodesource/distributions/blob/master/README.md) package. + - if it detects Node.js is already installed, it will ensure it is at least v20. If nothing is found it will install the Node.js v22 LTS release using the [NodeSource](https://nodesource.com/products/distributions) package. - install the latest version of Node-RED using npm. - optionally install a collection of useful Pi-specific nodes. - setup Node-RED to run as a service and provide a set of commands to work with @@ -44,9 +44,8 @@ This script will:

+**Note**: As of Node v24 there are NO 32 bit builds available - so armv6 based Pi devices will no longer be supported.

- -

### Running locally @@ -75,7 +74,7 @@ The following commands are provided to work with the service: - `node-red-start` - this starts the Node-RED service and displays its log output. Pressing `Ctrl-C` or closing the window does *not* stop the service; it keeps - running in the background + running in the background. Use `node-red-log` to re-attach and view the log. - `node-red-stop` - this stops the Node-RED service - `node-red-restart` - this restarts the Node-RED service - `node-red-reload` - this stops then starts the Node-RED service @@ -103,7 +102,8 @@ 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: . -

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 and not Epiphany

. +

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. +

When browsing from another machine you should use the hostname or IP-address of the Pi: `http://:1880`. You can find the IP address by running `hostname -I` on the Pi. diff --git a/docs/getting-started/windows.md b/docs/getting-started/windows.md index 2c89bbbf..7cca071a 100644 --- a/docs/getting-started/windows.md +++ b/docs/getting-started/windows.md @@ -38,7 +38,7 @@ You should receive back output that looks similar to: Installing Node-RED as a global module adds the command `node-red` to your system path. Execute the following at the command prompt: - npm install -g --unsafe-perm node-red + npm install -g node-red #### 3. Run Node-RED diff --git a/docs/telemetry/index.md b/docs/telemetry/index.md index 9fc69e38..338c3a1e 100644 --- a/docs/telemetry/index.md +++ b/docs/telemetry/index.md @@ -62,9 +62,9 @@ are kept for up to 90 days. The raw data is only accessible by the core Team Committers. The aggregated data will be made available on a public dashboard for public -consumption. _Note_: At the time of writing, we have not yet released this feature, -so we have very little data to start building the dashboard with. Once it is available, -this document will be updated to link to it and it will be publicised within the community. +consumption. + +The Dashboard can be found [here](https://telemetry.nodered.org/dashboard/telemetry) ### How do I opt out? diff --git a/docs/user-guide/editor/images/editor-actions-menu.png b/docs/user-guide/editor/images/editor-actions-menu.png new file mode 100644 index 00000000..21a3a7d1 Binary files /dev/null and b/docs/user-guide/editor/images/editor-actions-menu.png differ diff --git a/docs/user-guide/editor/images/editor-default.png b/docs/user-guide/editor/images/editor-default.png index 64e5a95b..eb29cb6f 100644 Binary files a/docs/user-guide/editor/images/editor-default.png and b/docs/user-guide/editor/images/editor-default.png differ diff --git a/docs/user-guide/editor/images/editor-deploy-menu.png b/docs/user-guide/editor/images/editor-deploy-menu.png index 4dabec30..3ccddbc9 100644 Binary files a/docs/user-guide/editor/images/editor-deploy-menu.png and b/docs/user-guide/editor/images/editor-deploy-menu.png differ diff --git a/docs/user-guide/editor/images/editor-edit-config-node.png b/docs/user-guide/editor/images/editor-edit-config-node.png index ad6585c8..a9bd6f5e 100644 Binary files a/docs/user-guide/editor/images/editor-edit-config-node.png and b/docs/user-guide/editor/images/editor-edit-config-node.png differ diff --git a/docs/user-guide/editor/images/editor-edit-flow.png b/docs/user-guide/editor/images/editor-edit-flow.png index b5f50596..db1e3057 100644 Binary files a/docs/user-guide/editor/images/editor-edit-flow.png and b/docs/user-guide/editor/images/editor-edit-flow.png differ diff --git a/docs/user-guide/editor/images/editor-edit-node-appearance.png b/docs/user-guide/editor/images/editor-edit-node-appearance.png index f4b180f3..e653c2b8 100644 Binary files a/docs/user-guide/editor/images/editor-edit-node-appearance.png and b/docs/user-guide/editor/images/editor-edit-node-appearance.png differ diff --git a/docs/user-guide/editor/images/editor-edit-node-config-node.png b/docs/user-guide/editor/images/editor-edit-node-config-node.png index c7b498b1..f0a20741 100644 Binary files a/docs/user-guide/editor/images/editor-edit-node-config-node.png and b/docs/user-guide/editor/images/editor-edit-node-config-node.png differ diff --git a/docs/user-guide/editor/images/editor-edit-node-description.png b/docs/user-guide/editor/images/editor-edit-node-description.png index 15ab9d45..93112674 100644 Binary files a/docs/user-guide/editor/images/editor-edit-node-description.png and b/docs/user-guide/editor/images/editor-edit-node-description.png differ diff --git a/docs/user-guide/editor/images/editor-edit-node.png b/docs/user-guide/editor/images/editor-edit-node.png index f0f93b35..9b50c106 100644 Binary files a/docs/user-guide/editor/images/editor-edit-node.png and b/docs/user-guide/editor/images/editor-edit-node.png differ diff --git a/docs/user-guide/editor/images/editor-edit-subflow.png b/docs/user-guide/editor/images/editor-edit-subflow.png index bdec9842..82e37fec 100644 Binary files a/docs/user-guide/editor/images/editor-edit-subflow.png and b/docs/user-guide/editor/images/editor-edit-subflow.png differ diff --git a/docs/user-guide/editor/images/editor-flow-search-tabs.png b/docs/user-guide/editor/images/editor-flow-search-tabs.png index ba2c5c9e..c1f972ec 100644 Binary files a/docs/user-guide/editor/images/editor-flow-search-tabs.png and b/docs/user-guide/editor/images/editor-flow-search-tabs.png differ diff --git a/docs/user-guide/editor/images/editor-flow-tabs.png b/docs/user-guide/editor/images/editor-flow-tabs.png index 29625cae..5efb3744 100644 Binary files a/docs/user-guide/editor/images/editor-flow-tabs.png and b/docs/user-guide/editor/images/editor-flow-tabs.png differ diff --git a/docs/user-guide/editor/images/editor-node-details.png b/docs/user-guide/editor/images/editor-node-details.png index a8e34c60..ad0b7d63 100644 Binary files a/docs/user-guide/editor/images/editor-node-details.png and b/docs/user-guide/editor/images/editor-node-details.png differ diff --git a/docs/user-guide/editor/images/editor-node-docs.png b/docs/user-guide/editor/images/editor-node-docs.png new file mode 100644 index 00000000..10d1de8e Binary files /dev/null and b/docs/user-guide/editor/images/editor-node-docs.png differ diff --git a/docs/user-guide/editor/images/editor-node-errors.png b/docs/user-guide/editor/images/editor-node-errors.png new file mode 100644 index 00000000..cd0e43fc Binary files /dev/null and b/docs/user-guide/editor/images/editor-node-errors.png differ diff --git a/docs/user-guide/editor/images/editor-node-port-label.png b/docs/user-guide/editor/images/editor-node-port-label.png index 811ed62b..e4cd7d37 100644 Binary files a/docs/user-guide/editor/images/editor-node-port-label.png and b/docs/user-guide/editor/images/editor-node-port-label.png differ diff --git a/docs/user-guide/editor/images/editor-node-wire.png b/docs/user-guide/editor/images/editor-node-wire.png index 9019ae7e..17b0a962 100644 Binary files a/docs/user-guide/editor/images/editor-node-wire.png and b/docs/user-guide/editor/images/editor-node-wire.png differ diff --git a/docs/user-guide/editor/images/editor-palette.png b/docs/user-guide/editor/images/editor-palette.png index 9ff247e2..21c5807b 100644 Binary files a/docs/user-guide/editor/images/editor-palette.png and b/docs/user-guide/editor/images/editor-palette.png differ diff --git a/docs/user-guide/editor/images/editor-quick-add.png b/docs/user-guide/editor/images/editor-quick-add.png index f8247d8c..5a882c49 100644 Binary files a/docs/user-guide/editor/images/editor-quick-add.png and b/docs/user-guide/editor/images/editor-quick-add.png differ diff --git a/docs/user-guide/editor/images/editor-search-menu.png b/docs/user-guide/editor/images/editor-search-menu.png new file mode 100644 index 00000000..24d46243 Binary files /dev/null and b/docs/user-guide/editor/images/editor-search-menu.png differ diff --git a/docs/user-guide/editor/images/editor-search-toolbar.png b/docs/user-guide/editor/images/editor-search-toolbar.png new file mode 100644 index 00000000..ce9a6e36 Binary files /dev/null and b/docs/user-guide/editor/images/editor-search-toolbar.png differ diff --git a/docs/user-guide/editor/images/editor-search.png b/docs/user-guide/editor/images/editor-search.png index 543aeb05..3faa1a0d 100644 Binary files a/docs/user-guide/editor/images/editor-search.png and b/docs/user-guide/editor/images/editor-search.png differ diff --git a/docs/user-guide/editor/images/editor-settings-keyboard-edit.png b/docs/user-guide/editor/images/editor-settings-keyboard-edit.png new file mode 100644 index 00000000..dba03446 Binary files /dev/null and b/docs/user-guide/editor/images/editor-settings-keyboard-edit.png differ diff --git a/docs/user-guide/editor/images/editor-settings-keyboard.png b/docs/user-guide/editor/images/editor-settings-keyboard.png new file mode 100644 index 00000000..df13078e Binary files /dev/null and b/docs/user-guide/editor/images/editor-settings-keyboard.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-config-nodes.png b/docs/user-guide/editor/images/editor-sidebar-config-nodes.png index 99236206..620f171c 100644 Binary files a/docs/user-guide/editor/images/editor-sidebar-config-nodes.png and b/docs/user-guide/editor/images/editor-sidebar-config-nodes.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-context.png b/docs/user-guide/editor/images/editor-sidebar-context.png index 74f38427..58843bfc 100644 Binary files a/docs/user-guide/editor/images/editor-sidebar-context.png and b/docs/user-guide/editor/images/editor-sidebar-context.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-debug-filter.png b/docs/user-guide/editor/images/editor-sidebar-debug-filter.png index 04d1837a..f9aaf0b6 100644 Binary files a/docs/user-guide/editor/images/editor-sidebar-debug-filter.png and b/docs/user-guide/editor/images/editor-sidebar-debug-filter.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-debug-pause.png b/docs/user-guide/editor/images/editor-sidebar-debug-pause.png new file mode 100644 index 00000000..7109dd96 Binary files /dev/null and b/docs/user-guide/editor/images/editor-sidebar-debug-pause.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-debug.png b/docs/user-guide/editor/images/editor-sidebar-debug.png index 237ebff9..10a1ed24 100644 Binary files a/docs/user-guide/editor/images/editor-sidebar-debug.png and b/docs/user-guide/editor/images/editor-sidebar-debug.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-explorer.png b/docs/user-guide/editor/images/editor-sidebar-explorer.png new file mode 100644 index 00000000..272ce407 Binary files /dev/null and b/docs/user-guide/editor/images/editor-sidebar-explorer.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-help.png b/docs/user-guide/editor/images/editor-sidebar-help.png index 3c8cf3c6..00132f76 100644 Binary files a/docs/user-guide/editor/images/editor-sidebar-help.png and b/docs/user-guide/editor/images/editor-sidebar-help.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-info.png b/docs/user-guide/editor/images/editor-sidebar-info.png index c93db219..b9bfe30b 100644 Binary files a/docs/user-guide/editor/images/editor-sidebar-info.png and b/docs/user-guide/editor/images/editor-sidebar-info.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-panels.png b/docs/user-guide/editor/images/editor-sidebar-panels.png new file mode 100644 index 00000000..86ef8e3c Binary files /dev/null and b/docs/user-guide/editor/images/editor-sidebar-panels.png differ diff --git a/docs/user-guide/editor/images/editor-sidebar-toolbar.png b/docs/user-guide/editor/images/editor-sidebar-toolbar.png new file mode 100644 index 00000000..9441d555 Binary files /dev/null and b/docs/user-guide/editor/images/editor-sidebar-toolbar.png differ diff --git a/docs/user-guide/editor/images/editor-user-settings-view.png b/docs/user-guide/editor/images/editor-user-settings-view.png index 310c9253..4bc9814a 100644 Binary files a/docs/user-guide/editor/images/editor-user-settings-view.png and b/docs/user-guide/editor/images/editor-user-settings-view.png differ diff --git a/docs/user-guide/editor/images/editor-wiring-splice.png b/docs/user-guide/editor/images/editor-wiring-splice.png index cf62e2bc..b3ced790 100644 Binary files a/docs/user-guide/editor/images/editor-wiring-splice.png and b/docs/user-guide/editor/images/editor-wiring-splice.png differ diff --git a/docs/user-guide/editor/images/editor-workspace-navigator.png b/docs/user-guide/editor/images/editor-workspace-navigator.png index 286bf2c5..c9961958 100644 Binary files a/docs/user-guide/editor/images/editor-workspace-navigator.png and b/docs/user-guide/editor/images/editor-workspace-navigator.png differ diff --git a/docs/user-guide/editor/images/select-multiple-wires.png b/docs/user-guide/editor/images/select-multiple-wires.png deleted file mode 100644 index b8c218a9..00000000 Binary files a/docs/user-guide/editor/images/select-multiple-wires.png and /dev/null differ diff --git a/docs/user-guide/editor/index.md b/docs/user-guide/editor/index.md index c5994598..a829a961 100644 --- a/docs/user-guide/editor/index.md +++ b/docs/user-guide/editor/index.md @@ -5,24 +5,29 @@ slug: editor toc: toc-editor-guide.html --- - +

Editor window

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

Editor window

+ - 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. -

Editor components

+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. + + diff --git a/docs/user-guide/editor/palette/index.md b/docs/user-guide/editor/palette/index.md index 3128e501..50477dca 100644 --- a/docs/user-guide/editor/palette/index.md +++ b/docs/user-guide/editor/palette/index.md @@ -21,24 +21,14 @@ the palette. Categories can be expanded or collapsed by clicking its header. -The and - +The and + 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. - -

Palette toggle

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

Reference
Key shortcut	`Ctrl/⌘-p`
Menu option	`View -> Show Palette`
Action	`core:toggle-palette`
Action	`core:show-palette-tab`
Key shortcut	`Ctrl/⌘-g p`

diff --git a/docs/user-guide/editor/sidebar/debug.md b/docs/user-guide/editor/sidebar/debug.md index ad58e2f9..07f1df78 100644 --- a/docs/user-guide/editor/sidebar/debug.md +++ b/docs/user-guide/editor/sidebar/debug.md @@ -27,15 +27,17 @@ of messages, read the [Working with messages](/docs/user-guide/messages) guide. Key shortcutCtrl/⌘-g d +### Filtering the messages + By default, the Debug sidebar shows all messages passed to it. This can be filtered -by clicking the button to open the filter options panel. +by clicking the button to open the filter options menu. -

Debug filter options

-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 @@ -46,7 +48,25 @@ 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 button. +### Pausing messages + + +

Debug paused

+ + +The 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. + + + + +

Reference
Action	`core:toggle-debug-messages`

+ +### Clearing messages + +The sidebar can be cleared at any time by clicking the button. The button also provides a menu to choose whether to clear all debug messages, or just those that are currently shown. @@ -54,13 +74,14 @@ The sidebar can be cleared at any time by clicking the button +The 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.

Reference

diff --git a/docs/user-guide/editor/sidebar/explorer.md b/docs/user-guide/editor/sidebar/explorer.md new file mode 100644 index 00000000..873857a6 --- /dev/null +++ b/docs/user-guide/editor/sidebar/explorer.md @@ -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' +--- + +

Explorer Sidebar

+ +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. + +

Outline entry options

+ +The button will reveal the node/flow in the main workspace. + +If the node has a button, such as the Debug and Inject nodes, the button can be used to trigger that button. + + +The button can be used to enable or disable the node/flow. + + + +

Reference

+ + + +

Reference
Action	`core:show-explorer-tab`
Key shortcut	`Ctrl/⌘-g e`

diff --git a/docs/user-guide/editor/sidebar/help.md b/docs/user-guide/editor/sidebar/help.md index 4d124a9f..16d7f999 100644 --- a/docs/user-guide/editor/sidebar/help.md +++ b/docs/user-guide/editor/sidebar/help.md @@ -15,16 +15,10 @@ title: 'Sidebar: Help'

Help Sidebar

-*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 - button. + button. diff --git a/docs/user-guide/editor/sidebar/index.md b/docs/user-guide/editor/sidebar/index.md index 1998f1f3..6c0393a8 100644 --- a/docs/user-guide/editor/sidebar/index.md +++ b/docs/user-guide/editor/sidebar/index.md @@ -8,32 +8,52 @@ toc: toc-editor-guide.html title: Sidebar --- -

Editor Sidebar

- -The sidebar contains panels that provide a number of useful tools within the editor. +The sidebars contain panels that provide a number of useful tools within the editor. The sidebar panels can be +arranged on both sides of the workspace. + - [Explorer](explorer) - navigate the flows - [Information](info) - view information about nodes and their help - [Debug](debug) - view messages passed to Debug nodes + - [Help](help) - view Node help - [Configuration Nodes](config) - manage configuration nodes - [Context data](context) - view the contents of context -Some nodes contribute their own sidebar panels, such as [node-red-dashboard](https://flows.nodered.org/node/node-red-dashboard). +Some nodes and plugins can contribute their own sidebar panels, such as the [Node-RED Debugger](https://flows.nodered.org/node/node-red-debugger). + +The sidebar panels can be accessed by the sidebar toolbar. The panel buttons are grouped according to which sidebar section the panel is in. + +

Editor Sidebar Toolbar

+ +### Arranging sidebar panels + +

Editor Sidebar Panels

+ +Each sidebar can be split to show two panels at the same time. -The panels are opened by clicking their icon in the header of the sidebar, or by -selecting them in the drop-down list shown by clicking the button. +The panels can be arranged by dragging the panel by its header to the required sidebar section. If a section contains multiple panels, only one will be shown. The others can be shown by clicking its button in the sidebar toolbar. The sidebar can be resized by dragging its edge across the workspace. -If the edge is dragged close to the right-hand edge, the sidebar will be hidden. -It can be shown again by selecting the 'Show sidebar' option in the View menu, -or using the Ctrl/⌘-Space shortcut. +If the edge is dragged close to the window edge, the sidebar will be hidden. + +It can be shown again by selecting the corresponding 'Show sidebar' option in the View menu, or using the toggle button in the sidebar toolbar. + +

+ + + + +

Reference
Key shortcut	`Ctrl/⌘-Alt-Space`
Menu option	`View -> Show left sidebar`
Action	`core:toggle-left-sidebar`

- - + +

Reference
Key shortcut	`Ctrl/⌘-Space`
Menu option	`View -> Show sidebar`
Action	`core:toggle-sidebar`
Menu option	`View -> Show right sidebar`
Action	`core:toggle-right-sidebar`

diff --git a/docs/user-guide/editor/sidebar/info.md b/docs/user-guide/editor/sidebar/info.md index 08fd00f2..04f0cefc 100644 --- a/docs/user-guide/editor/sidebar/info.md +++ b/docs/user-guide/editor/sidebar/info.md @@ -10,48 +10,28 @@ toc: toc-editor-guide.html title: 'Sidebar: Information' --- -

Information Sidebar

-*Since Node-RED 1.1.0* +The Information sidebar shows information about the current selection. -The Information sidebar shows information about the flows. This includes an outline -view of all flows and nodes, as well as details of the current selection. +This includes: -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. - -

Outline entry options

- -The button will reveal the node/flow in the main workspace. - -If the node has a button, such as the Debug and Inject nodes, the button can be used to trigger that button. - - -The button can be used to enable or disable the node/flow. - - - -In the bottom section of the Information sidebar, details of the current selection are shown. - -This will include: - - - a summary of its properties + - a summary of its properties - the 'show more' link expands the table to show all of the properties - the [user-provided description of node/flow](../workspace/nodes#editing-node-properties) - - a link to the [node's help](./help) + + The toolbar in the header provides the following options: + - Copy the url for the node to the clipboard + - Open the [node's help](./help) + - Reveal the node/flow in the main workspace and highlight it in the [explorer sidebar](./explorer) If nothing is selected, it displays the description of the current flow - which can be edited in the [Flow Properties edit dialog](../workspace/flows#editing-flow-properties). - diff --git a/docs/user-guide/editor/workspace/actions.md b/docs/user-guide/editor/workspace/actions.md new file mode 100644 index 00000000..44139c1c --- /dev/null +++ b/docs/user-guide/editor/workspace/actions.md @@ -0,0 +1,33 @@ +--- +layout: docs-editor-guide +slug: + - url: /docs/user-guide/editor + label: editor + - url: "/docs/user-guide/editor/workspace" + label: "workspace" + - actions +toc: toc-editor-guide.html +title: Editor Actions +--- + +

Actions list

+ +Many of the tasks that can completed in the editor are exposed as Actions that can be assigned to keyboard shortcuts. + +A full list of available actions can be found by opening the Action list. This is done via the `View -> Action list` menu +item, or the default `Ctrl/⌘-Shift-p` shortcut. + +Throughout this user-guide, relevant actions are highlighted, along with any default keyboard shortcut that is preassigned. + +

Reference
Action	`core:show-info-tab`

+ + + + +

Reference
Key shortcut	`Ctrl/⌘-Shift-p`
Menu option	`View -> Action list`
Action	`core:show-action-list`

+ diff --git a/docs/user-guide/editor/workspace/arrange.md b/docs/user-guide/editor/workspace/arrange.md index 54192957..e34e9b0b 100644 --- a/docs/user-guide/editor/workspace/arrange.md +++ b/docs/user-guide/editor/workspace/arrange.md @@ -10,8 +10,6 @@ toc: toc-editor-guide.html title: Arranging Nodes --- -*Since Node-RED 2.1* - The editor provides a number of actions to help arrange nodes in the workspace. They can be used to align and distribute nodes. diff --git a/docs/user-guide/editor/workspace/flows.md b/docs/user-guide/editor/workspace/flows.md index b601025e..ad0d0378 100644 --- a/docs/user-guide/editor/workspace/flows.md +++ b/docs/user-guide/editor/workspace/flows.md @@ -49,7 +49,7 @@ Flows can be reordered in the workspace by dragging their tabs around in the tab

Flow properties editor

Information Sidebar

@@ -59,7 +59,7 @@ open the Flow Properties dialog.

: Properties - set the flow's name and description. The description can use Markdown syntax for formatting and will appear in the Information sidebar.
: Environment Variables - properties that are exposed as environment variables within the flow. Since Node-RED 2.1
: Environment Variables - properties that are exposed as environment variables within the flow.

@@ -76,7 +76,7 @@ The flow can be enabled or disabled using the toggle button at the bottom of the dialog. If a flow is disabled, none of the nodes it contains will be created when the flow is deployed. -The button in the [Information sidebar](../sidebar/info) can also be used to enable or disable the node/flow. +The button in the [Explorer sidebar](../sidebar/explorer) can also be used to enable or disable the node/flow. @@ -99,7 +99,7 @@ The icon next to it. Clicking that icon will show the flow again. +When hidden, the [Explorer sidebar](../sidebar/explorer) will show an icon next to it. Clicking that icon will show the flow again.

Reference

diff --git a/docs/user-guide/editor/workspace/groups.md b/docs/user-guide/editor/workspace/groups.md index 491f5da7..09069cef 100644 --- a/docs/user-guide/editor/workspace/groups.md +++ b/docs/user-guide/editor/workspace/groups.md @@ -10,8 +10,6 @@ toc: toc-editor-guide.html title: Groups --- -*Since Node-RED 1.1.0* - Nodes can be joined together to form a group. They can then be moved or copied as a single object within the editor. @@ -43,7 +41,7 @@ The edit dialog contains two tabs:

: Properties - the groups properties to edit.
: Environment Variables - properties that are exposed as environment variables within the group. Since Node-RED 2.1
: Environment Variables - properties that are exposed as environment variables within the group.
: Description - per-node documentation formatted using Markdown. This is displayed in the Information sidebar when the group is selected.

@@ -83,16 +81,14 @@ To apply that style to another group, select the group and press `Ctrl/⌘-Shift ### Adding nodes to a group -Nodes can be added to an existing group by dragging them into the group. Before Node-RED 3.1, this -could only be done one node at a time. Since Node-RED 3.1, a whole selection of nodes/groups can be -dragged into a group in one go. +Nodes can be added to an existing group by dragging them into the group. ### Removing from a group To remove a node from a group, select the node then select the 'Groups -> Remove from group' option in the menu. -Since Node-RED 3.1 you can press and hold the `Alt` key when dragging a selection and it will be +Alternatively, press and hold the `Alt` key when dragging a selection and it will be removed from the parent group.

Reference

diff --git a/docs/user-guide/editor/workspace/keyboard.md b/docs/user-guide/editor/workspace/keyboard.md new file mode 100644 index 00000000..c625e162 --- /dev/null +++ b/docs/user-guide/editor/workspace/keyboard.md @@ -0,0 +1,49 @@ +--- +layout: docs-editor-guide +slug: + - url: /docs/user-guide/editor + label: editor + - url: "/docs/user-guide/editor/workspace" + label: "workspace" + - keyboard +toc: toc-editor-guide.html +title: Keyboard Shortcuts +--- + +

Keyboard settings

+ +All of the [actions](./actions) in the editor can be assigned to keyboard shortcuts. Not all of the core actions have preassigned +shortcuts. + +The shortcuts can be customised in the Keyboard settings via the `View -> Keyboard shortcuts` menu. + +This lists all of the available actions and what shortcuts are currently assigned to them. + +
+ +To customise any shortcut, click on the row, enter the desired shortcut, select the scope of the shortcut then click on the tick to save the change. +The reverse arrow can be used to revert the shortcut back to the default value. + +

Editing a shortcut

+ +The scope of the shortcut determines what part of the editor should have focus for the shortcut to apply. There are three scope options: + - `global` - the whole editor UI + - `workspace` - the inner workspace area + - `edit dialog` - any edit dialog + + +

+ + + + +

Reference
Key shortcut	`Shift-?`
Menu option	`View -> Keyboard shortcuts`
Action	`core:show-keyboard-settings`

Node elements

Node error tooltip

Node documentation

: Properties - the edit form specific to the node type being edited.
: Description - per-node documentation formatted using Markdown. This is displayed in the Information sidebar when the node is selected.
: Appearance - options to customise the appearance of the node.
: Properties - the edit form specific to the node type being edited.
: Description - per-node documentation formatted using Markdown. This is displayed in the Information sidebar when the node is selected.
: Appearance - options to customise the appearance of the node.

@@ -111,7 +128,7 @@ The Appearance tab provides options to: - provide custom port labels. -#### Enabling or disabling a node +### Enabling or disabling a node

@@ -129,7 +146,7 @@ An node can be enabled or disabled using the toggle button at the bottom of the dialog. If a node is disabled it will not be created when the flow is deployed. If a disabled node sits in the middle of a flow, no messages will pass through it. -#### Configuration nodes +### Configuration nodes A Configuration (config) Node is a special type of node that holds reusable configuration that can be shared by regular nodes in a flow. diff --git a/docs/user-guide/editor/workspace/search.md b/docs/user-guide/editor/workspace/search.md index 8b7d0cf2..d6d4f4f1 100644 --- a/docs/user-guide/editor/workspace/search.md +++ b/docs/user-guide/editor/workspace/search.md @@ -10,10 +10,17 @@ toc: toc-editor-guide.html title: Searching flows --- -

Search dialog

+
+

Search menu

The Search dialog can be used to find nodes within the workspace, including configuration nodes. @@ -21,9 +28,7 @@ configuration nodes. It indexes all properties of the nodes, so it can be used to search for a node by its id, type, name or any other property. -Selecting a node in the result list will reveal that node within the editor. - -

@@ -32,8 +37,31 @@ Selecting a node in the result list will reveal that node within the editor.

Reference
Key shortcut	`Ctrl/⌘-f`

-Clicking the -button will copy the current search over to the Information sidebar search. +Selecting a node in the result list will reveal that node within the editor. + +The button on each result will reveal that node without closing the search window. + + +The +button in the header will copy the current search over to the [Explorer sidebar](../sidebar/explorer) search. + + +A number of predefined searches are available under the search menu dropdown. + + + +
+ + +### Search toolbar + +

Search toolbar

+ +When a search has multiple results and you select one, the search toolbar will appear to allow you to navigate between the search results without having to reopen the main search window. + ### Search syntax @@ -45,4 +73,5 @@ Filter | Description | `is:subflow` | Limits the results to Subflows | `is:unused` | Matches Configuration nodes or Subflows that are unused | `is:invalid` | Matches nodes that contain configuration errors | -`uses:` | Limits the results to nodes that depend on the specific configuration node | \ No newline at end of file +`uses:` | Limits the results to nodes that depend on the specific configuration node | + diff --git a/docs/user-guide/editor/workspace/subflows.md b/docs/user-guide/editor/workspace/subflows.md index e022a85d..63478f8f 100644 --- a/docs/user-guide/editor/workspace/subflows.md +++ b/docs/user-guide/editor/workspace/subflows.md @@ -99,7 +99,7 @@ properties dialog, the name and description of the subflow can be set.

: Properties - per-instance properties that are exposed as environment variables within the subflow.
: Module Properties - metadata about the subflow. Since Node-RED 1.3
: Module Properties - metadata about the subflow.
: Description - per-node documentation formatted using Markdown. This is displayed in the Information sidebar when the node is selected.
: Appearance - options to customise the appearance of the node.

diff --git a/docs/user-guide/editor/workspace/wires.md b/docs/user-guide/editor/workspace/wires.md index 89dc95c7..7867a826 100644 --- a/docs/user-guide/editor/workspace/wires.md +++ b/docs/user-guide/editor/workspace/wires.md @@ -57,12 +57,6 @@ You can also select multiple wires by holding `Ctrl/Command` while clicking on t When you select multiple nodes, we also highlight any wires between them. This can make it easier to follow a flow once you have selected it. -

Selecting multiple wires

- - #### Deleting wires 1. Select one or more wires @@ -109,8 +103,8 @@ You can also detach a node from the flow without deleting it: - +

Reference
Action	`core:detach-selected-nodes`
Key shortcut	`*Not assigned`
Key shortcut	`Not assigned`

\* There is no default shortcut for **Detach Node from wires**, but you can assign one yourself in the Keyboard pane of the Settings dialog.

Note : sudo is required if running as a non-root user on Linux/OS X. If diff --git a/docs/user-guide/runtime/adding-nodes.md b/docs/user-guide/runtime/adding-nodes.md index 86ced807..ec512e8e 100644 --- a/docs/user-guide/runtime/adding-nodes.md +++ b/docs/user-guide/runtime/adding-nodes.md @@ -60,10 +60,3 @@ npm install @latest ``` Whichever approach you take, you will need to restart Node-RED to load the updates. - -

Note : the reason for using the ---unsafe-perm option is that when node-gyp tries to recompile any -native libraries it tries to do so as a "nobody" user and then fails to get -access to certain directories. This causes the nodes in question (for example, -serialport) not to be installed. Allowing it root access during install -allows the nodes to be installed correctly during the upgrade.

diff --git a/docs/user-guide/runtime/configuration.md b/docs/user-guide/runtime/configuration.md index 7cb446bb..04ba7ea5 100644 --- a/docs/user-guide/runtime/configuration.md +++ b/docs/user-guide/runtime/configuration.md @@ -79,9 +79,6 @@ httpNodeRoot httpNodeAuth : enables HTTP Basic Authentication. See `httpAdminAuth` for format. -httpRoot -: this sets the root url for both admin and node endpoints. It overrides the values set by `httpAdminRoot` and `httpNodeRoot`. - https : enables https, with the specified options object, as defined [here](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener). @@ -309,3 +306,26 @@ socketReconnectTime socketTimeout : TCP Nodes - how long to wait, in milliseconds, before timing out a socket. Default: 120000 + +### Node Defaults + +As of v4.1.9 it is possible to override a node's default properties - this is useful for setting up a default way of working for a team to save everyone having to change the default output of the debug node to be "complete message" for example - or indeed a single user. + +NOTE: This only changes the defaults - ie the user can still edit the settings in the editor UI - this doesn't lock anything - it just allows changing the defaults for a newly dragged on node to something the user may wish to use more often. + +To do this the user adds an entry like this to their settings.js file + + nodeDefaults: { + debug: { + complete: true, + console:true, + active:false + }, + inject: { + props: [{"p":"payload"}], + payload: "Hello World", + payloadType: "str" + } + } + +The easiest way to find the names of properties of a node is to select an existing node and use the information sidebar - expand the 'show more' link and view the table of node properties. \ No newline at end of file diff --git a/docs/user-guide/runtime/settings-file.md b/docs/user-guide/runtime/settings-file.md index 4a68f5d0..be1b408d 100644 --- a/docs/user-guide/runtime/settings-file.md +++ b/docs/user-guide/runtime/settings-file.md @@ -17,7 +17,7 @@ Alternatively, the `--settings` command-line argument can be used when starting Node-RED to point at a different file. If you have not yet run Node-RED and want to edit the settings file, you can copy -the default settings file in manually from [here](https://github.com/node-red/node-red/blob/master/packages/node_modules/node-red/settings.js). +the default settings file in manually from [here](https://github.com/node-red/node-red/blob/main/packages/node_modules/node-red/settings.js). If you are not sure which settings file Node-RED is using, you should check the log output when Node-RED starts up. It will log the full path to the file: diff --git a/docs/user-guide/writing-functions.md b/docs/user-guide/writing-functions.md index 875a022b..4bd827c0 100644 --- a/docs/user-guide/writing-functions.md +++ b/docs/user-guide/writing-functions.md @@ -35,7 +35,7 @@ the function can construct a completely new object before returning it. For example: {% highlight javascript %} -var newMsg = { payload: msg.payload.length }; +const newMsg = { payload: msg.payload.length }; return newMsg; {% endhighlight %} @@ -49,7 +49,7 @@ changes to its properties.

Low-code programming for event-driven applications

The easiest way to collect, transform and visualize real-time data.

Latest version: v4.1.3 (npm)

Latest version: v5.0.4 (npm)

Get Started

@@ -139,6 +139,13 @@

{{ page.title }}

Low-code programming for event-driven applications

The easiest way to collect, transform and visualize real-time data.

Who's using Node-RED?

{{ page.title }}

Low-code programming for event-driven applications

The easiest way to collect, transform and visualize real-time data.

Who's using Node-RED?

Community more

Node-RED Con 2026