-
Notifications
You must be signed in to change notification settings - Fork 151
Installation
status: work in progress
Changes considered:
- add sections specific to popular desktop operating systems (Windows, Mac, Linux) on how to install Node.js and Node-RED
We recommend the use of node.js LTS 6.x. Node-RED no longer supports node.js 0.10.x or 0.12.x.
You can get the latest Long Term Support (LTS) version of Node 6.x from the nodejs download site.
It is often easiest to use a packaged version specifically for your operating system.
We also have specific instructions available for certain hardware platforms:
Other download options are available here.
The easiest way to install Node-RED is to use node's
package manager, npm. Installing it as a global module adds the command node-red
to your system path:
sudo npm install -g --unsafe-perm node-red
Note: sudo is required if running as a non-root user on Linux/OS X. If
running on Windows, you will need to run in a command shell as Administrator,
without the sudo command.
Note: During the install some errors may be reported by the node-gyp
command. These are typically non-fatal errors and are related to optional dependencies
that require a compiler in order to build them. Node-RED will work without these
optional dependencies, but you may find additional node modules that require the
ability to compile native code. You can find out how to install the node-gyp
compiler dependencies here.
Once installed, you are ready to run Node-RED.
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
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
--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
Once installed, you are ready to run Node-RED.