Merge branch 'master' into monaco-editor-construction-options

Author: bonanitech

about/releases/index.md

@@ -4,27 +4,24 @@ title: Release Plan
 slug: releases
 ---
 
-_Updated: 2022-08-04_
+_Updated: 2024-01-03_
 
 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.
 
 ![](release-plan.png)
 
+The project aims to make a new major release around April each year. This aligns
+with when versions of Node.js reach their end-of-life and enables us to drop support
+for them.
 
-The active Node-RED stream (3.x) will get a new minor version release (for example, 3.1 ->  3.2)
-every three months. Maintenance releases (for example 3.1.0 -> 3.1.1) will continue
-to happen as and when they are needed.
+The active Node-RED stream will get regular minor releases (for example 4.0 -> 4.1)
+containing new features as well as maintenance releases (for example 4.0.1 -> 4.0.2)
+as and when they are needed.
 
-At the end of April 2023, when Node 14.x reaches its end-of-life, we will publish
-Node-RED 4.x that will *drop* support for Node 14.
-
-The 3.x stream will then enter maintenance mode. It will only receive bug fixes
-and security updates. New features could get back-ported from 4.x if there was
-a very good reason to do so as well as people available to do the work.
-
-The 4.x stream will continue in active development with a minor release every
-three months or so for a year, when the next major release is made.
+When a new major version is released, the previous version enters maintenance mode
+for an extended period of time. During this time it will only receive bug fixes
+and security updates.
 
 This proposal means:
 
@@ -36,12 +33,12 @@ This proposal means:
 
 Release | Initial         | Maintenance Start    | End-of-life
 --------|-----------------|----------------------|-----------------
-1.x     | 2019-09-30      | 2021-04-30           | 2022-06-30
+4.x     | *2024-04-30* *  | *2025-04-30* *       | 2026-06-30
+3.x     | 2022-07-14      | *2024-04-30* *       | 2025-06-30
 2.x     | 2021-07-22      | 2022-07-14           | 2023-06-30
-3.x     | 2022-07-14      | *2023-04-30* *       | 2024-06-30
-4.x     | *2023-04-30* *  | *2024-04-30* *       | 2025-06-30
+1.x     | 2019-09-30      | 2021-04-30           | 2022-06-30
 
-_* Dates are subject to change_
+_Dates are subject to change_
 
 References:
  - [Blog post: Going beyond Node-RED 1.x](https://nodered.org/blog/2020/07/01/release-plans)

about/releases/release-plan.png

@@ -15,6 +15,7 @@ property in the settings file.
 - [Creating theme CSS](#creating-theme-css)
 - [Packaging as a Theme Plugin](#packaging-as-a-theme-plugin)
 - [Theming the Monaco editor](#theming-the-monaco-editor)
+- [Theming the Mermaid diagrams](#theming-the-mermaid-diagrams)
 
 ### Creating theme CSS
 
@@ -241,3 +242,21 @@ RED.plugins.registerPlugin("my-custom-theme", {
 ```
 
 The specific details of how to create a Monaco theme is beyond the scope of our documentation.
+
+### Theming the Mermaid diagrams
+
+A theme plugin can also set the theme for the Mermaid diagramming and charting tool.
+
+Mermaid comes with a number of built-in themes available. The full list is [here](https://mermaid.js.org/config/theming.html#available-themes).
+
+The name of the theme can be provided in the plugin settings:
+
+```javascript
+RED.plugins.registerPlugin("my-custom-theme", {
+   type: "node-red-theme",
+   css: "style.css",
+   mermaid: {
+     theme: "dark" //Mermaid theme name
+   }
+ })
+ ```

docs/api/ui/themes/index.md

@@ -5,23 +5,22 @@ title: Supported Node versions
 slug: node versions
 ---
 
-Node-RED currently recommends **Node 18.x or Node 20.x**.
+_Updated: 2024-01-03_
 
-Version    | Support Level   | Notes
------------|-----------------|------
- < 10.x    | *Unsupported*   | Node-RED 1.x or earlier only
- **12.x**  | *Supported*     | Node-RED 2.x or earlier only
- **14.x**  | *Supported*     |  
- **16.x**  | Supported       |  
- **18.x**  | **Recommended** | 
- **20.x**  | **Recommended** | 
+Node-RED currently recommends **Node 20.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/).
 
-We do not generally recommend using the odd numbered Node.js versions - we do not
+We do not recommend using the odd numbered Node.js versions - we do not
 routinely test against them.
 
+Node-RED Version | Minimum Node.js Version
+---|---
+4.x | 18
+3.x | 14
+2.x | 12
+
 With such a large community of 3rd party nodes available to install, we cannot
 provide any guarantees on what they support. We rely on the community to keep
 up to date.

docs/faq/node-versions.md

@@ -7,11 +7,13 @@ redirect_from:
   - /docs/platforms/android
 ---
 
-Using the [Termux](https://termux.com) app in the app store makes it easy to run
-Node-RED on Android devices. You can get it from the [Play Store](https://play.google.com/store/apps/details?id=com.termux&hl=en_GB).
+Using the [Termux](https://termux.com) app makes it easy to run
+Node-RED on Android devices. Get it directly from thier [github](https://github.com/termux/termux-app#github) or via [F-Droid](https://f-droid.org/) here [Termux on F-Droid](https://f-droid.org/en/packages/com.termux/).
+
+Note that the Play Store version is not maintained.
 
 <div class="doc-callout"><em>Note</em> : the Node-RED team have no connection
-with the Termux application nor its development. We cannot provide support for
+with the Termux application nor its development, nor F-Droid. We cannot provide support for
 it in any way, other than to say that at this point in time it works.</div>
 
 ### Installing
@@ -26,21 +28,33 @@ Install it, and run it. Then at the prompt type
 
 Then you can point a browser to `http://localhost:1880`
 
+Note that installing openssh may make interacting with termux a little easier.  [see this thread](https://discourse.nodered.org/t/android-termux-playstore-no-longer-a-recommended-install-source/85034/4) for a description of one such install.
+
 ### Notes
 
  - You can also npm install other node-red nodes such as `node-red-dashboard` in the standard way :
 
        cd ~/.node-red
        npm i node-red-dashboard
+   
+   or via the Pallete Manager.
 
  - The `volume-down` key is the ctrl key - so `vol-down-c` can be used to "break" a running app.
  - The instructions above also install the `nano` editor, which is useful for editing files.
 
 ### Autostarting
 
-The recommended way of starting applications running in Termux is using the [Termux:Boot application](https://github.com/termux/termux-boot) (available from [F-droid](https://f-droid.org/en/packages/com.termux.boot/) or [Play Store](https://play.google.com/store/apps/details?id=com.termux.boot)).
+The recommended way of starting applications running in Termux is using the [Termux:Boot application](https://github.com/termux/termux-boot) (available from [F-droid](https://f-droid.org/en/packages/com.termux.boot/) - note that the Play Store version may not be maintained, and it's recommended to use the same source that you installed termux from).
+
+We have found this other app useful for autostarting Termux on boot - <a href="https://play.google.com/store/apps/details?id=com.autostart&amp;hl=en_GB">Autostart - No Root</a> (Note: with termux:boot, use of other autoboot apps does not seem to be required).
 
-We have found this other app useful for autostarting Termux on boot - <a href="https://play.google.com/store/apps/details?id=com.autostart&amp;hl=en_GB">Autostart - No Root</a>
+Note that the shebang in the node-red script is incompatible with termux:boot scripts.  The workaround is to start node-red using a termux:boot startup script like:
+
+```
+#!/data/data/com.termux/files/usr/bin/sh
+termux-wake-lock
+node /data/data/com.termux/files/usr/bin/node-red
+```
 
 ### Device Access
 
@@ -50,7 +64,7 @@ node.
 
 **Note**: you need to install both the add-on app, and also the add-on api in Termux.
 
-Install add-on app - <a href="https://play.google.com/store/apps/details?id=com.termux.api&amp;hl=en">Termux:API</a> from Play store.
+Install add-on app - Termux:API from the same source you got termux.
 
 Install add-on access into Termux
 
@@ -59,3 +73,7 @@ Install add-on access into Termux
 ### Useful links
 
  - [How to use Termux API](https://wiki.termux.com/wiki/Termux:API)
+ - [node-red-contrib-termux-api](https://flows.nodered.org/node/node-red-contrib-termux-api)
+ - [Another Node-Red on termux install guide](https://che-adrian.medium.com/install-node-red-on-an-android-device-using-the-termux-app-1e1679ae876)
+
+  

docs/getting-started/android.md

@@ -105,6 +105,8 @@ This has the advantage that you don't need to know/specify which architecture yo
 docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red:1.2.0-10-arm32v6
 ```
 
+As of Node-RED v3.1.0 we also provide a Debian based image for those nodes with native components that do not work well on Alpine.
+
 ### Managing User Data
 
 Once you have Node-RED running with Docker, we need to
@@ -234,8 +236,10 @@ FROM nodered/node-red
 
 # Copy package.json to the WORKDIR so npm builds all
 # of your added nodes modules for Node-RED
-COPY package.json .
+WORKDIR /data
+COPY package.json /data
 RUN npm install --unsafe-perm --no-update-notifier --no-fund --only=production
+WORKDIR /usr/src/node-red
 
 # Copy _your_ Node-RED project files into place
 # NOTE: This will only work if you DO NOT later mount /data as an external volume.
@@ -244,10 +248,6 @@ RUN npm install --unsafe-perm --no-update-notifier --no-fund --only=production
 COPY settings.js /data/settings.js
 COPY flows_cred.json /data/flows_cred.json
 COPY flows.json /data/flows.json
-
-# You should add extra nodes via your package.json file but you can also add them here:
-#WORKDIR /usr/src/node-red
-#RUN npm install node-red-node-smooth
 ```
 
 **Note**: the `package.json` file must contain a start option within the script section. For example the default container is like this:

docs/getting-started/docker.md

@@ -88,6 +88,8 @@ flows nodes, there can be at most one input and as many outputs as needed.
 
 The toolbar provides an option to add a 'status' output to a subflow. This can
 be used to update the Status of subflow instance nodes.
+The node uses the input of `msg.payload` which can either be a simple string or a
+<a href="/docs/creating-nodes/status#status-object">Status Object</a>
 
 
 #### Editing subflow properties

docs/user-guide/editor/workspace/subflows.md

@@ -237,6 +237,9 @@ The theme of the editor can be changed by using the following settings object. A
                 // The following only apply if the editor is set to "monaco"
                 theme: "vs", // Select a color theme for the text editor component. Must match the file name of a theme in packages/node_modules/@node-red/editor-client/src/vendor/monaco/dist/theme
             }
+        },
+        mermaid: {
+            theme: "default" // Select a color theme for the Mermaid diagramming and charting tool. Must match the name of a theme in https://mermaid.js.org/config/theming.html#available-themes
         }
     },
 

docs/user-guide/runtime/configuration.md

@@ -7,7 +7,7 @@
             <div class="content">
                 <h1>Node-RED</h1>
                 <h2>Low-code programming for event-driven applications</h2>
-                <p>Latest version: <a href="https://www.npmjs.com/package/node-red"><span class="node-red-latest-version">v3.1.3</span> (npm)</a></p>
+                <p>Latest version: <a href="https://www.npmjs.com/package/node-red"><span class="node-red-latest-version">v3.1.8</span> (npm)</a></p>
                 <!-- <img src="images/node-red-title-flow.png" /> -->
             </div>
         </div>