Node-RED

https://nodered.org/docs
Admin
Node-RED is a low-code programming tool for wiring together hardware devices, APIs, and online...
Tokens:91,477
Snippets:1,245
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### start()

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime.html

Starts the runtime.

```APIDOC
## start()

### Description
Start the runtime.

### Returns
- **Promise** - Resolves when the runtime is started.
```

--------------------------------

### Verify npm installation output

Source: https://nodered.org/docs/getting-started/local

Example of successful installation output confirming the package version and dependency count.

```text
+ node-red@4.1.7
added 227 packages in 13s
found 0 vulnerabilities
```

--------------------------------

### Install and Start Node-RED on Termux

Source: https://nodered.org/docs/getting-started/android

Commands to update the environment, install dependencies, and launch the Node-RED server.

```bash
apt update
apt upgrade
apt install coreutils nano nodejs
npm i -g node-red
node-red
```

--------------------------------

### start()

Source: https://nodered.org/docs/api/modules/v/1.3/node-red.html

Starts the Node-RED application runtime.

```APIDOC
## start()

### Description
Start the Node-RED application.

### Returns
- **Promise** - Resolves when complete
```

--------------------------------

### start()

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_editor-api.html

Starts the module and returns a promise that resolves when ready.

```APIDOC
## start()

### Description
Start the module.

### Returns
- **Promise** - Resolves when the application is ready to handle requests
```

--------------------------------

### Start Node-RED via Command Prompt

Source: https://nodered.org/docs/getting-started/windows

Execute the Node-RED runtime using the command prompt after a global npm installation.

```text
C:>node-red
```

--------------------------------

### Node module installation response

Source: https://nodered.org/docs/api/admin/methods/post/nodes

Example of a successful response body returned after installing a node module.

```json
{
  "name": "node-red-node-suncalc",
  "version": "0.0.6",
  "nodes": [
    {
      "id": "node-red-node-suncalc/suncalc",
      "name": "suncalc",
      "types": [
        "sunrise"
      ],
      "enabled": true,
      "loaded": true,
      "module": "node-red-node-suncalc"
    }
  ]
}
```

--------------------------------

### Start an existing container

Source: https://nodered.org/docs/getting-started/docker

Command to start a previously created container.

```bash
docker start mynodered

```

--------------------------------

### Initializing state on start

Source: https://nodered.org/docs/writing-functions

Use the On Start tab to define code that executes when the node starts, such as initializing context variables.

```javascript
if (context.get("counter") === undefined) {
    context.set("counter", 0)
}
```

--------------------------------

### Package.json Start Script

Source: https://nodered.org/docs/getting-started/docker

Required start script configuration within the package.json file.

```json
    "scripts": {
        "start": "node $NODE_OPTIONS node_modules/node-red/red.js $FLOWS",
        ...
```

--------------------------------

### Install tgz package via curl

Source: https://nodered.org/docs/api/admin/methods/post/nodes

Example command to install a node module using a local tgz file.

```bash
curl -X POST http://localhost:1880/nodes -H "Content-Type: multipart/form-data" -F "tarball=@node-red-contrib-foo-1.0.3.tgz;type=application/x-compressed-tar;filename=node-red-contrib-foo-1.0.3.tgz"
```

--------------------------------

### Install Node.js and Node-RED on Ubuntu

Source: https://nodered.org/docs/getting-started/aws

Commands to install the Node.js runtime and the Node-RED package globally on an Ubuntu instance.

```bash
   curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
   sudo apt-get install -y nodejs build-essential
   sudo npm install -g node-red
```

--------------------------------

### Install Windows Build Tools

Source: https://nodered.org/docs/getting-started/windows

Installs the necessary tools for compiling binary Node.js modules on Windows.

```bash
npm install --global --production windows-build-tools
```

```bash
npm install --global --production --add-python-to-path windows-build-tools
```

--------------------------------

### Install dependencies

Source: https://nodered.org/docs/getting-started/development

Installs all project dependencies using npm.

```bash
npm ci
```

--------------------------------

### Retrieve runtime settings response

Source: https://nodered.org/docs/api/admin/methods/get/settings

Example JSON response body returned by the GET /settings endpoint.

```json
{
  "httpNodeRoot": "/",
  "version": "0.X.Y",
  "user": {
    "username": "admin",
    "permissions": "*"
  }
}
```

--------------------------------

### GET /flows/state Response Example

Source: https://nodered.org/docs/api/admin/methods/get/flows/state

Example JSON response body indicating the current runtime state of the flows.

```json
{
    "state": "stop"
}
```

--------------------------------

### Example package.json Configuration

Source: https://nodered.org/docs/creating-nodes/packaging

A sample package.json file showing the required node-red entry and keywords for discoverability.

```json
{
    "name"         : "@myScope/node-red-sample",
    "version"      : "0.0.1",
    "description"  : "A sample node for Node-RED",
    "dependencies": {
    },
    "keywords": [ "node-red" ],
    "node-red"     : {
        "nodes": {
            "sample": "sample/sample.js"
        }
    }
}
```

--------------------------------

### Start Node-RED service

Source: https://nodered.org/docs/getting-started/local

Executes the node-red command to start the runtime and displays the initialization logs.

```bash
$ node-red

Welcome to Node-RED
===================
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
```

--------------------------------

### Install Node-RED globally with npm

Source: https://nodered.org/docs/getting-started/local

Installs Node-RED as a global module. Omit 'sudo' when installing on Windows.

```bash
sudo npm install -g node-red
```

--------------------------------

### Install Theme Locally

Source: https://nodered.org/docs/api/ui/themes

Install the plugin locally within the Node-RED user directory for testing.

```bash
 npm install /path/to/my-custom-theme

```

--------------------------------

### Install node-red-admin globally

Source: https://nodered.org/docs/user-guide/node-red-admin

Installs the administrative tool as a global npm module.

```bash
npm install -g node-red-admin
```

--------------------------------

### Install Node-RED with snap

Source: https://nodered.org/docs/getting-started/local

Installs Node-RED via snap. Note that this runs in a restricted container with limited system access.

```bash
sudo snap install node-red
```

--------------------------------

### Node-RED startup logs

Source: https://nodered.org/docs/getting-started/docker

Example output showing a successful Node-RED startup inside a Docker container.

```text
    Welcome to Node-RED
    ===================

    10 Oct 12:57:10 - [info] Node-RED version: v1.2.0
    10 Oct 12:57:10 - [info] Node.js  version: v10.22.1
    10 Oct 12:57:10 - [info] Linux 4.19.76-linuxkit x64 LE
    10 Oct 12:57:11 - [info] Loading palette nodes
    10 Oct 12:57:16 - [info] Settings file  : /data/settings.js
    10 Oct 12:57:16 - [info] Context store  : 'default' [module=memory]
    10 Oct 12:57:16 - [info] User directory : /data
    10 Oct 12:57:16 - [warn] Projects disabled : editorTheme.projects.enabled=false
    10 Oct 12:57:16 - [info] Flows file     : /data/flows.json
    10 Oct 12:57:16 - [info] Creating new flow file
    10 Oct 12:57:17 - [warn]

    ---------------------------------------------------------------------
    Your flow credentials file is encrypted using a system-generated key.

    If the system-generated key is lost for any reason, your credentials
    file will not be recoverable, you will have to delete it and re-enter
    your credentials.

    You should set your own key using the 'credentialSecret' option in
    your settings file. Node-RED will then re-encrypt your credentials
    file using your chosen key the next time you deploy a change.
    ---------------------------------------------------------------------

    10 Oct 12:57:17 - [info] Starting flows
    10 Oct 12:57:17 - [info] Started flows
    10 Oct 12:57:17 - [info] Server now running at http://127.0.0.1:1880/

    [...]

```

--------------------------------

### Install Johnny-Five dependency

Source: https://nodered.org/docs/faq/interacting-with-arduino

Run these commands in your Node-RED home directory to install the Johnny-Five library.

```bash
cd ~/.node-red
npm install johnny-five
```

--------------------------------

### Example Flow File Path

Source: https://nodered.org/docs/creating-nodes/examples

The file path structure for defining an example flow within a node package.

```text
examples\My Great Example.json
```

--------------------------------

### Start Node-RED with command-line arguments

Source: https://nodered.org/docs/getting-started/local

Basic syntax for launching the Node-RED runtime with optional flags.

```bash
node-red [-v] [-?] [--settings settings.js] [--userDir DIR]
         [--port PORT] [--title TITLE] [--safe] [flows.json|projectName]
         [-D X=Y|@file]
```

--------------------------------

### Install Arduino Nodes

Source: https://nodered.org/docs/faq/interacting-with-arduino

Command to install the node-red-node-arduino package via npm.

```bash
    npm install node-red-node-arduino
```

--------------------------------

### Install or Upgrade Node-RED

Source: https://nodered.org/docs/getting-started/raspberrypi

Executes the official installation script to set up Node.js, npm, and Node-RED on Debian-based systems.

```bash
bash <(curl -sL https://github.com/node-red/linux-installers/releases/latest/download/install-update-nodered-deb)
```

--------------------------------

### Install Termux API

Source: https://nodered.org/docs/getting-started/android

Command to install the Termux API package for hardware access.

```bash
apt install termux-api
```

--------------------------------

### Verify Node.js and npm installation

Source: https://nodered.org/docs/getting-started/windows

Check the installed versions of Node.js and npm to ensure the environment is configured correctly.

```powershell
node --version; npm --version
```

```cmd
node --version && npm --version
```

--------------------------------

### Run Node-RED

Source: https://nodered.org/docs/getting-started/development

Starts the Node-RED runtime.

```bash
npm start
```

```bash
npm start -- <args>
```

--------------------------------

### Flow Configuration JSON Examples

Source: https://nodered.org/docs/api/admin/methods/put/flow

Examples of the JSON structure required for updating a normal flow versus the global flow configuration.

```json
{
  "id": "91ad451.f6e52b8",
  "label": "Sheet 1",
  "nodes": [ ],
  "configs": [ ]
}
```

```json
{
  "id": "global",
  "configs": [ ],
  "subflows": [ ]
}
```

--------------------------------

### Install Node-RED globally

Source: https://nodered.org/docs/getting-started/windows

Install Node-RED as a global module to add the node-red command to the system path.

```shell
npm install -g node-red
```

--------------------------------

### Install PM2

Source: https://nodered.org/docs/faq/starting-node-red-on-boot

Installs the PM2 process manager globally via npm.

```bash
sudo npm install -g pm2
```

--------------------------------

### Enable flow file formatting

Source: https://nodered.org/docs/user-guide/runtime/settings-file

Example of a commented-out configuration option in the settings.js file.

```javascript
//flowFilePretty: true,
```

--------------------------------

### Install external modules via CLI

Source: https://nodered.org/docs/writing-functions

Install third-party modules in the Node-RED user directory to ensure they are accessible.

```bash
cd ~/.node-red
npm install name_of_3rd_party_module
```

--------------------------------

### Install nodes and restart container

Source: https://nodered.org/docs/getting-started/docker

Installs a new node package via npm and restarts the container to apply changes.

```bash
bash-4.4$ npm install node-red-dashboard
bash-4.4$ exit
$ docker stop mynodered
$ docker start mynodered
```

--------------------------------

### Mustache List Output Example

Source: https://nodered.org/docs/user-guide/nodes

The resulting HTML output generated from the list iteration example.

```html
<ul>
  <li>Nick</li>
  <li>Dave</li>
  <li>Claire</li>
</ul>
```

--------------------------------

### Select Theme in Settings

Source: https://nodered.org/docs/api/ui/themes

Update the settings file to use the installed theme plugin.

```javascript
 editorTheme: {
     theme: "my-custom-theme",
 }

```

--------------------------------

### Install Additional Node-RED Nodes

Source: https://nodered.org/docs/getting-started/android

Commands to navigate to the Node-RED directory and install specific packages like node-red-dashboard.

```bash
cd ~/.node-red
npm i node-red-dashboard
```

--------------------------------

### Install node module from npm repository

Source: https://nodered.org/docs/api/admin/methods/post/nodes

Request body format for installing a module from the npm repository.

```json
{
  "module": "node-red-node-suncalc"
}
```

--------------------------------

### Register a preInstall hook

Source: https://nodered.org/docs/api/hooks/install

Use this hook to log installation details or modify the npm arguments before execution.

```javascript
RED.hooks.add("preInstall", (installEvent) => {
    console.log(`About to install ${installEvent.module}@${installEvent.version}`);
});
```

--------------------------------

### Install BeagleBone I/O Nodes

Source: https://nodered.org/docs/getting-started/beaglebone

Install specific npm packages to enable direct access to BeagleBone I/O pins.

```bash
sudo npm install -g beaglebone-io johnny-five node-red-contrib-gpio
```

--------------------------------

### Node Module Response Example

Source: https://nodered.org/docs/api/admin/methods/get/nodes/module

Example JSON response body returned when successfully querying a node module.

```json
{
  "name": "node-red-node-suncalc",
  "version": "0.0.6",
  "nodes": [
    {
      "id": "node-red-node-suncalc/suncalc",
      "name": "suncalc",
      "types": [
        "sunrise"
      ],
      "enabled": true,
      "module": "node-red-node-suncalc",
      "version": "0.0.6"
    }
  ]
}
```

--------------------------------

### Configure default context storage

Source: https://nodered.org/docs/api/context

Example of defining a memory-based context store in the settings.js file.

```javascript
contextStorage: {
   default: {
       module:"memory",
       config: {
           customOption: 'value'
       }
   }
}
```

--------------------------------

### Run Node-RED with Docker

Source: https://nodered.org/docs/getting-started/local

Starts a Node-RED container mapping port 1880 to the host.

```bash
docker run -it -p 1880:1880 --name mynodered nodered/node-red
```

--------------------------------

### GET /settings

Source: https://nodered.org/docs/api/admin/methods/get/settings

Retrieves the runtime settings for the Node-RED instance.

```APIDOC
## GET /settings

### Description
Get the runtime settings for the Node-RED instance. Requires the `settings.read` permission.

### Method
GET

### Endpoint
/settings

### Headers
- **Authorization** (string) - Required - Bearer [token] if authentication is enabled

### Response
#### Success Response (200)
- **httpNodeRoot** (string) - The root path of HTTP nodes
- **version** (string) - Node-RED runtime version
- **user** (object) - Information about the logged in user (only present if authentication is enabled)

#### Response Example
{
  "httpNodeRoot": "/",
  "version": "0.X.Y",
  "user": {
    "username": "admin",
    "permissions": "*"
  }
}
```

--------------------------------

### installerEnabled()

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_registry.html

Checks if the registry is capable of installing or removing modules.

```APIDOC
## installerEnabled()

### Description
Check if the registry is able to install/remove modules. This is based on whether it has found npm on the command-line.

### Returns
- **Boolean** - Whether the installer is enabled
```

--------------------------------

### Storage.init(settings)

Source: https://nodered.org/docs/api/storage/methods

Initialise the storage system.

```APIDOC
## Storage.init(settings)

### Description
Initialise the storage system.

### Parameters
- **settings** (object) - Required - The runtime settings.

### Returns
A promise that resolves when the storage system is initialised.
```

--------------------------------

### Define module structure for resources

Source: https://nodered.org/docs/creating-nodes/resources

Example directory structure for a Node-RED module containing a resources folder.

```text
node-red-node-example
 |- resources
 |   |- image.png
 |   \- library.js
 |- example-node.js
 |- example-node.html
 \- package.json
```

--------------------------------

### init(settings, _server, storage, runtimeAPI)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_editor-api.html

Initializes the module with the necessary runtime components.

```APIDOC
## init(settings, _server, storage, runtimeAPI)

### Description
Initialise the module.

### Parameters
- **settings** (Object) - Required - The runtime settings
- **_server** (HTTPServer) - Required - An instance of HTTP Server
- **storage** (Storage) - Required - An instance of Node-RED Storage
- **runtimeAPI** (Runtime) - Required - An instance of Node-RED Runtime
```

--------------------------------

### GET /nodes

Source: https://nodered.org/docs/api/admin/methods/get/nodes

Retrieves a list of the installed nodes. Requires the nodes.read permission.

```APIDOC
## GET /nodes

### Description
Get a list of the installed nodes.

### Method
GET

### Endpoint
/nodes

### Headers
- **Accept** (string) - Required - application/json or text/html
- **Authorization** (string) - Optional - Bearer [token] (if authentication is enabled)

### Response
#### Success Response (200)
- **Response** (array/string) - Returns an array of Node Set objects if Accept is application/json, or HTML content if Accept is text/html.

#### Response Example
[
  {
    "id": "node-red/sentiment",
    "name": "sentiment",
    "types": [
      "sentiment"
    ],
    "enabled": true,
    "module": "node-red",
    "version": "0.10.6"
  }
]
```

--------------------------------

### init(httpServer, userSettings)

Source: https://nodered.org/docs/api/modules/v/1.3/node-red.html

Initializes the Node-RED application with the provided HTTP server and runtime settings.

```APIDOC
## init(httpServer, userSettings)

### Description
Initialise the Node-RED application.

### Parameters
- **httpServer** (server) - Required - The HTTP server object to use
- **userSettings** (Object) - Required - An object containing the runtime settings
```

--------------------------------

### Run Node-RED in headless mode

Source: https://nodered.org/docs/getting-started/docker

Starts the container in the background using the -d flag.

```bash
docker run -d -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red
```

--------------------------------

### Install grunt-cli globally

Source: https://nodered.org/docs/getting-started/development

Required global dependency for building Node-RED from source.

```bash
sudo npm install -g grunt-cli
```

--------------------------------

### initialiseProject(opts)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime_projects.html

Initializes an empty project.

```APIDOC
## initialiseProject(opts)

### Description
Initialises an empty project.

### Parameters
- **opts** (Object) - Required
  - **user** (User) - Required - The user calling the api
  - **id** (String) - Required - The id of the project to initialise
  - **project** (Object) - Required - The project information
  - **req** (Object) - Optional - The request to log

### Returns
- **Promise.<Object>** - Resolves when complete
```

--------------------------------

### Authentication Response Examples

Source: https://nodered.org/docs/api/admin/methods/get/auth/login

Displays the JSON response structure for different authentication states.

```json
{}
```

```json
{
  "type": "credentials",
  "prompts": [
    {
      "id": "username",
      "type": "text",
      "label": "Username"
    },
    {
      "id": "password",
      "type": "password",
      "label": "Password"
    }
  ]
}
```

--------------------------------

### installModule(module, version, url)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_registry.html

Installs a new node module using npm and adds it to the registry.

```APIDOC
## installModule(module, version, url)

### Description
Installs a new node module using npm and then add to the registry.

### Parameters
- **module** (String|Buffer) - Required - The name of the module to install, or a Buffer containing a module tar file
- **version** (String) - Required - The version of the module to install, default: latest
- **url** (String) - Optional - A url to install the module from

### Returns
- **Promise.<Array>** - A promise that resolves with the module information once it has been installed
```

--------------------------------

### Start a Node-RED container

Source: https://nodered.org/docs/getting-started/docker

Launches a new Node-RED container with a named volume for data persistence and port mapping.

```bash
    docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red

```

--------------------------------

### Run MQTT broker on bridge network

Source: https://nodered.org/docs/getting-started/docker

Starts an MQTT broker container attached to the custom bridge network.

```bash
docker run -itd --network iot --name mybroker eclipse-mosquitto mosquitto -c /mosquitto-no-auth.conf
```

--------------------------------

### Example flow execution metrics log

Source: https://nodered.org/docs/user-guide/runtime/logging

Sample output showing node event metrics when metrics is enabled.

```text
9 Mar 13:57:53 - [metric] {"level":99,"nodeid":"8bd04b10.813f58","event":"node.inject.receive","msgid":"86c8212c.4ef45","timestamp":1489067873391}
9 Mar 13:57:53 - [metric] {"level":99,"nodeid":"8bd04b10.813f58","event":"node.inject.send","msgid":"86c8212c.4ef45","timestamp":1489067873392}
9 Mar 13:57:53 - [metric] {"level":99,"nodeid":"4146d01.5707f3","event":"node.debug.receive","msgid":"86c8212c.4ef45","timestamp":1489067873393}
```

--------------------------------

### init(settings)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_util.html

Initializes the @node-red/util module with the provided runtime settings.

```APIDOC
## init(settings)

### Description
Initialise the module with the runtime settings.

### Parameters
- **settings** (Object) - Required - The runtime settings object.
```

--------------------------------

### Pass arguments to the underlying Node.js process

Source: https://nodered.org/docs/getting-started/local

Configure memory limits for the Node.js runtime when starting Node-RED.

```bash
node-red-pi --max-old-space-size=128 --userDir /home/user/node-red-data/
node --max-old-space-size=128 red.js --userDir /home/user/node-red-data/
```

--------------------------------

### Initialize Plugin Package

Source: https://nodered.org/docs/api/ui/themes

Generate the package.json file for the theme plugin.

```bash
 cd my-custom-theme
 npm init

```

--------------------------------

### init(settings, server, adminApi)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime.html

Initializes the runtime module with the provided settings, HTTP server, and admin API instance.

```APIDOC
## init(settings, server, adminApi)

### Description
Initialise the runtime module.

### Parameters
- **settings** (Object) - Required - The runtime settings object.
- **server** (HTTPServer) - Required - The http server instance for the server to use.
- **adminApi** (AdminAPI) - Required - An instance of @node-red/editor-api.
```

--------------------------------

### Install local Node-RED node

Source: https://nodered.org/docs/creating-nodes/first-node

Commands to link a local node module into the Node-RED user directory for development.

```bash
npm install <location of node module>
```

```bash
cd ~/.node-red
npm install ~/dev/node-red-contrib-example-lower-case
```

```bash
cd C:\Users\my_name\.node_red
npm install C:\Users\my_name\Documents\GitHub\node-red-contrib-example-lower-case
```

--------------------------------

### Example Response Body

Source: https://nodered.org/docs/api/admin/methods/post/auth/token

The successful response returns the access token, expiration time, and token type.

```json
{
  "access_token": "A_SECRET_TOKEN",
  "expires_in":604800,
  "token_type": "Bearer"
}
```

--------------------------------

### Prepare Custom Theme Directory

Source: https://nodered.org/docs/api/ui/themes

Create a directory and copy the base colors.scss file for modification.

```bash
 mkdir my-custom-theme
 cp node-red/packages/node_modules/@node-red/editor-client/src/sass/colors.scss my-custom-theme

```

--------------------------------

### Enable Node-RED Autostart

Source: https://nodered.org/docs/getting-started/raspberrypi

Configures the Node-RED service to launch automatically upon system boot.

```bash
sudo systemctl enable nodered.service
```

--------------------------------

### Configure multiple context stores

Source: https://nodered.org/docs/api/context

Example of defining both a default memory store and a custom store loaded via require.

```javascript
contextStorage: {
   default: {
       module:"memory",
   },
   custom: {
       module:require("my-custom-store")
   }
}
```

--------------------------------

### Initialize npm package

Source: https://nodered.org/docs/creating-nodes/subflow-modules

Command to initialize the package.json file for the module.

```bash
npm init
```

--------------------------------

### Configure Node-RED for automatic startup with PM2

Source: https://nodered.org/docs/getting-started/aws

Commands to install PM2 and configure it to manage the Node-RED process for automatic restarts.

```bash
   sudo npm install -g pm2
   pm2 start `which node-red` -- -v
   pm2 save
   pm2 startup
```

--------------------------------

### Debug Output Example

Source: https://nodered.org/docs/tutorials/second-flow

Example of the JSON object structure displayed in the Debug sidebar after CSV parsing.

```json
msg.payload : Object
{"time":"2017-11-19T15:09:03.120Z","latitude":-21.5167,"longitude":168.5426,"depth":14.19,"mag":6.6,"magType":"mww","gap":21,"dmin":0.478,"rms":0.86,"net":"us","id":"us2000brgk","updated":"2017-11-19T17:10:58.449Z","place":"68km E of Tadine, New Caledonia","type":"earthquake","horizontalError":6.2,"depthError":2.8,"magError":0.037,"magNst":72,"status":"reviewed","locationSource":"us","magSource":"us"}
```

--------------------------------

### Identify settings file path in logs

Source: https://nodered.org/docs/user-guide/runtime/settings-file

Example of the log output indicating the active settings file path during startup.

```text
22 Jun 12:34:56 - [info] Settings file  : /Users/nol/.node-red/settings.js
```

--------------------------------

### Configure Node-RED Autostart Script

Source: https://nodered.org/docs/getting-started/android

A startup script for Termux:Boot that bypasses shebang incompatibility by invoking node directly.

```bash
#!/data/data/com.termux/files/usr/bin/sh
termux-wake-lock
node /data/data/com.termux/files/usr/bin/node-red
```

--------------------------------

### ContextStore.open()

Source: https://nodered.org/docs/api/context/methods

Initializes the storage plugin. This method is called before any data access occurs.

```APIDOC
## ContextStore.open()

### Description
Opens the storage ready for use. This is called before any store values are accessed.

### Returns
A Promise that resolves when the store is ready for access.
```

--------------------------------

### Configure PM2 Startup

Source: https://nodered.org/docs/faq/starting-node-red-on-boot

Commands to save the current process list and generate a system-specific startup script.

```bash
pm2 save
pm2 startup
```

```bash
pm2 startup systemd
```

--------------------------------

### Build and Run Commands

Source: https://nodered.org/docs/getting-started/docker

Commands for building the custom image and running it with environment variables and local volume mapping.

```bash
docker build -t your-image-name:your-tag .
```

```bash
docker run --rm -e "NODE_RED_CREDENTIAL_SECRET=your_secret_goes_here" -p 1880:1880 -v `pwd`:/data --name a-container-name your-image-name
```

--------------------------------

### Install a node module via npm

Source: https://nodered.org/docs/user-guide/runtime/adding-nodes

Run this command within your user data directory to install a specific node module.

```bash
npm install <npm-package-name>
```

--------------------------------

### length()

Source: https://nodered.org/docs/api/ui/editableList

Gets the number of list items.

```APIDOC
## length()

### Description
Gets the number of list items.

### Example
`var length = $("ol.list").editableList('length');`
```

--------------------------------

### init(runtime)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_registry.html

Initializes the registry with a reference to the runtime object.

```APIDOC
## init(runtime)

### Description
Initialise the registry with a reference to a runtime object.

### Parameters
- **runtime** (Object) - Required - A runtime object
```

--------------------------------

### items()

Source: https://nodered.org/docs/api/ui/editableList

Gets an Array of all list items.

```APIDOC
## items()

### Description
Gets an Array of all list items. Each item is the jQuery DOM element for the item. Each element stores the original data for the item under the property called `data`.

### Example
`var items = $("ol.list").editableList('items');`
```

--------------------------------

### addModule(opts)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime_nodes.html

Installs a new module into the runtime.

```APIDOC
## addModule(opts)

### Description
Installs a new module into the runtime.

### Parameters
- **opts** (Object) - Required
  - **user** (User) - Required - The user calling the api
  - **module** (String) - Required - The id of the module to install
  - **version** (String) - Optional - The version of the module to install
  - **tarball** (Object) - Optional - A tarball file to install (properties: name, size, buffer)
  - **url** (String) - Optional - URL to install
  - **req** (Object) - Optional - The request to log

### Returns
- **Promise.<ModuleInfo>** - The node module info
```

--------------------------------

### isStarted(opts)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime.html

Checks if the runtime is currently started.

```APIDOC
## isStarted(opts)

### Description
Returns whether the runtime is started.

### Parameters
- **opts** (Object) - Required - Options object.
  - **user** (User) - Required - The user calling the api.

### Returns
- **Promise.<Boolean>** - Whether the runtime is started.
```

--------------------------------

### Storage.getSettings()

Source: https://nodered.org/docs/api/storage/methods

Retrieve the user settings.

```APIDOC
## Storage.getSettings()

### Description
Returns a promise that resolves with the user settings.
```

--------------------------------

### Configuring multiple context stores

Source: https://nodered.org/docs/user-guide/context

Define multiple storage backends to mix memory-only and persistent filesystem storage.

```javascript
contextStorage: {
   default: "memoryOnly",
   memoryOnly: { module: 'memory' },
   file: { module: 'localfilesystem' }
}
```

--------------------------------

### getIcon(opts)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime_nodes.html

Gets a node icon from the runtime.

```APIDOC
## getIcon(opts)

### Description
Gets a node icon.

### Parameters
- **opts** (Object) - Required
  - **user** (User) - Required - The user calling the api
  - **module** (String) - Required - The id of the module requesting the icon
  - **icon** (String) - Required - The name of the icon
  - **req** (Object) - Optional - The request to log

### Returns
- **Promise.<Buffer>** - The icon file as a Buffer or null if no icon available
```

--------------------------------

### getBranchStatus(opts)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime_projects.html

Gets the status of a specific branch.

```APIDOC
## getBranchStatus(opts)

### Description
Gets the status of a branch.

### Parameters
- **opts** (Object) - Required
  - **user** (User) - Required: The user calling the api
  - **id** (String) - Required: The id of the project
  - **branch** (String) - Required: The name of the branch
  - **req** (Object) - Optional: The request to log

### Returns
- **Promise.<Object>** - The status of the branch
```

--------------------------------

### Start Node-RED with PM2

Source: https://nodered.org/docs/faq/starting-node-red-on-boot

Commands to initiate Node-RED as a background process using PM2, including memory-constrained and user-directory configurations.

```bash
pm2 start /usr/bin/node-red -- -v
```

```bash
pm2 start /usr/bin/node-red --node-args="--max-old-space-size=128" -- -v
```

--------------------------------

### Get input value

Source: https://nodered.org/docs/api/ui/typedInput

Retrieves the current value of the widget.

```javascript
var value = $(".input").typedInput('value');
```

--------------------------------

### value()

Source: https://nodered.org/docs/api/ui/searchBox

Gets or sets the current value of the search input.

```APIDOC
## value()

### Description
Gets or sets the current value of the search input.

### Returns
- **String** - The current value of the search input when called without arguments.
```

--------------------------------

### Example Flow Menu Display

Source: https://nodered.org/docs/creating-nodes/examples

The resulting label displayed in the Node-RED library import menu based on the filename.

```text
My Great Example
```

--------------------------------

### getNodeList(opts)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_runtime_nodes.html

Retrieves the list of node modules installed in the runtime.

```APIDOC
## getNodeList(opts)

### Description
Gets the list of node modules installed in the runtime.

### Parameters
- **opts** (Object) - Required
  - **user** (User) - Required - The user calling the api
  - **req** (Object) - Optional - The request to log

### Returns
- **Promise.<NodeList>** - The list of node modules
```

--------------------------------

### POST /nodes

Source: https://nodered.org/docs/api/admin/methods/post/nodes

Install a new node module into the Node-RED instance.

```APIDOC
## POST /nodes

### Description
Install a new node module. Requires permission: `nodes.write`.

### Method
POST

### Endpoint
/nodes

### Headers
- **Authorization** (string) - Optional - Bearer [token] if authentication is enabled
- **Content-type** (string) - Required - application/json (for npm) or multipart/form-data (for tgz)

### Request Body
- **module** (string) - Required (for npm) - The name of the node module to install from the npm repository, or a full path to a directory.

### Request Example
{
  "module": "node-red-node-suncalc"
}

### Response
#### Success Response (200)
- **name** (string) - The name of the installed module
- **version** (string) - The version of the installed module
- **nodes** (array) - List of nodes contained in the module

#### Response Example
{
  "name": "node-red-node-suncalc",
  "version": "0.0.6",
  "nodes": [
    {
      "id": "node-red-node-suncalc/suncalc",
      "name": "suncalc",
      "types": ["sunrise"],
      "enabled": true,
      "loaded": true,
      "module": "node-red-node-suncalc"
    }
  ]
}
```

--------------------------------

### Node Management Endpoints

Source: https://nodered.org/docs/api/admin/methods

Endpoints for managing installed nodes and modules.

```APIDOC
## GET /nodes
### Description
Get a list of the installed nodes.

## POST /nodes
### Description
Install a new node module.

## GET /nodes/:module
### Description
Get a node module’s information.

## PUT /nodes/:module
### Description
Enable/Disable a node module.

## DELETE /nodes/:module
### Description
Remove a node module.

## GET /nodes/:module/:set
### Description
Get a node module set information.

## PUT /nodes/:module/:set
### Description
Enable/Disable a node set.
```

--------------------------------

### Configure eMMC Flashing

Source: https://nodered.org/docs/getting-started/beaglebone

Uncomment this line in /boot/uEnv.txt to enable flashing the image to the eMMC.

```text
cmdline=init=/opt/scripts/tools/eMMC/init-eMMC-flasher-v3.sh
```

--------------------------------

### Get selected type

Source: https://nodered.org/docs/api/ui/typedInput

Retrieves the currently selected type as a string.

```javascript
var type = $(".input").typedInput('type');
```

--------------------------------

### Get list length

Source: https://nodered.org/docs/api/ui/editableList

Returns the total number of items in the list.

```javascript
var length = $("ol.list").editableList('length');
```

--------------------------------

### run(command, args, options, emit)

Source: https://nodered.org/docs/api/modules/v/1.3/%40node-red_util_exec.html

Executes a system command and returns a promise that resolves or rejects based on the exit code.

```APIDOC
## run(command, args, options, emit)

### Description
Runs a system command with stdout/err being emitted as 'event-log' events on the @node-red/util/events handler. The arguments mirror those passed to `child_process.spawn`.

### Parameters
- **command** (String) - Required - The command to run.
- **args** (Array) - Required - Arguments for the command.
- **options** (Object) - Required - Options to pass to child_process.spawn.
- **emit** (Boolean) - Required - Whether to emit events to the event-log for each line of stdout/err.

### Returns
- **Promise** - Resolves (rc=0) or rejects (rc!=0) when the command completes. The resolved value is an object containing `code`, `stdout`, and `stderr`.
```

--------------------------------

### Example memory usage metrics log

Source: https://nodered.org/docs/user-guide/runtime/logging

Sample output showing runtime memory usage logged every 15 seconds.

```text
9 Mar 13:56:24 - [metric] {"level":99,"event":"runtime.memory.rss","value":97517568,"timestamp":1489067784815}
9 Mar 13:56:24 - [metric] {"level":99,"event":"runtime.memory.heapTotal","value":81846272,"timestamp":1489067784817}
9 Mar 13:56:24 - [metric] {"level":99,"event":"runtime.memory.heapUsed","value":59267432,"timestamp":1489067784817}
```

--------------------------------

### GET /auth/login

Source: https://nodered.org/docs/api/admin/oauth

Returns the active authentication scheme for the Node-RED instance.

```APIDOC
## GET /auth/login

### Description
Returns the active authentication scheme. If no authentication is configured, an empty object is returned. If credential-based authentication is active, it returns the required login prompts.

### Method
GET

### Endpoint
/auth/login

### Response
#### Success Response (200)
- **type** (string) - The authentication type (e.g., "credentials")
- **prompts** (array) - List of required login fields
```

--------------------------------

### GET /nodes/:module

Source: https://nodered.org/docs/api/admin/methods/get/nodes/module

Retrieves the details of a specific node module.

```APIDOC
## GET /nodes/:module

### Description
Get a node module’s information.

### Method
GET

### Endpoint
/nodes/:module

### Parameters
#### Path Parameters
- **module** (string) - Required - The name of the module

### Response
#### Success Response (200)
- **name** (string) - The name of the module
- **version** (string) - The version of the module
- **nodes** (array) - List of nodes contained in the module

#### Response Example
{
  "name": "node-red-node-suncalc",
  "version": "0.0.6",
  "nodes": [
    {
      "id": "node-red-node-suncalc/suncalc",
      "name": "suncalc",
      "types": [
        "sunrise"
      ],
      "enabled": true,
      "module": "node-red-node-suncalc",
      "version": "0.0.6"
    }
  ]
}
```

--------------------------------

### Documenting multiple node outputs

Source: https://nodered.org/docs/creating-nodes/help-style-guide

Use an ordered list with the class 'node-ports' to wrap multiple output descriptions. Each item contains a description and a definition list of message properties.

```HTML
<ol class="node-ports">
    <li>Standard output
        <dl class="message-properties">
            <dt>payload <span class="property-type">string</span></dt>
            <dd>the standard output of the command.</dd>
        </dl>
    </li>
    <li>Standard error
        <dl class="message-properties">
            <dt>payload <span class="property-type">string</span></dt>
            <dd>the standard error of the command.</dd>
        </dl>
    </li>
</ol>
```

```Markdown
1. Standard output
: payload (string) : the standard output of the command.

2. Standard error
: payload (string) : the standard error of the command.
```

--------------------------------

### POST /flows/state

Source: https://nodered.org/docs/api/admin/methods/post/flows/state

Sets the runtime state of flows to either start or stop.

```APIDOC
## POST /flows/state

### Description
Set the runtime state of flows. Note that runtime state of flows is available only if `runtimeState` value is set to `enabled: true` in the `settings.js` file.

### Method
POST

### Endpoint
/flows/state

### Parameters
#### Request Body
- **state** (string) - Required - Required runtime state of the flow. Can be either `start` or `stop`.

### Response
#### Success Response (200)
- **state** (string) - runtime state of the flows. Can be either `start` or `stop`.

#### Response Example
{
    "state": "stop"
}
```

--------------------------------

### GET /flows

Source: https://nodered.org/docs/api/admin/methods/get/flows

Retrieves the active flow configuration. Requires the flows.read permission.

```APIDOC
## GET /flows

### Description
Retrieves the active flow configuration. Requires the flows.read permission.

### Method
GET

### Endpoint
/flows

### Headers
- **Authorization** (string) - Required - Bearer [token] if authentication is enabled
- **Node-RED-API-Version** (string) - Optional - The API version (v1 or v2). Defaults to v1.

### Response
#### Success Response (200)
- **v1** (array) - An array of node objects
- **v2** (object) - A flow response object including the current revision identifier

#### Response Example (v1)
[
  {
    "type": "tab",
    "id": "396c2376.c693dc",
    "label": "Sheet 1"
  }
]

#### Response Example (v2)
{
    "rev": "abc-123",
    "flows": [
      {
        "type": "tab",
        "id": "396c2376.c693dc",
        "label": "Sheet 1"
      }
    ]
}
```

--------------------------------

### Run Node-RED with Memory Optimization

Source: https://nodered.org/docs/getting-started/raspberrypi

Starts Node-RED with a restricted heap size to accommodate the limited memory of Raspberry Pi hardware.

```bash
node-red-pi --max-old-space-size=256
```
Tokens:
Raw