Installation

Before you can install Node-RED, you must have a working install of Node.js. We recommend the use of Node.js LTS 8.x. Users of Node.js 6.x and 4.x should ensure they have the latest updates. Node-RED no longer supports Node.js 0.12.x or 0.10.x.

We have specific instructions available for certain hardware platforms and operating systems:

Linux and OSX users should install the packaged version of Node.js for your specific operating system, or get the latest Long Term Support (LTS) version from the download site.

To check your version of Node.js

node -v

Other download options are available here.

The easiest way to install Node-RED is to use the node package manager, npm, that comes with Node.js. Installing as a global module adds the command node-red to your system path:

sudo npm install -g --unsafe-perm node-red
Note: sudo is only required during the install when running on Linux or OS X. If running on Windows, see the Windows Install instructions.

Next

Once installed, you are ready to run Node-RED.


Alternative install methods

Download a release

You can download the latest release from here. The zip contains a top-level folder called node-red-X.Y.Z where X.Y.Z is the version number. Once extracted, from within that top-level folder, run the following command:

npm install --production

For Development - from GitHub

Running the code from GitHub is only intended for users who are happy to be using development code, or for developers wanting to contribute to the code.

You can clone the source repository directly from GitHub:

git clone https://github.com/node-red/node-red.git

Once cloned, the core pre-requisite modules must be installed :

cd node-red
npm install
Note: when running from a clone of the git repository, it is necessary to install all dependencies, not just the production level ones. This is why the --production option should not be used.

You will also need to install grunt-cli in order to build the application before you can use it. This must be done globally.

sudo npm install -g grunt-cli

You can then build and run the application

grunt build
node red

Next steps

Once installed, you are ready to run Node-RED.