Welcome to the Node-RED documentation.

Getting Started

This guide will help you get Node-RED installed and running in just a few minutes.

Raspberry Pi users should head straight here.

Using Node-RED

This guide covers how to configure and use Node-RED.


Node-RED can be run on a variety of platforms, from edge of network devices, to the cloud. Here are some quick start guides for a number of such platforms.

Creating Nodes

This guide covers how to create your own nodes and get them added to the palette.

Other places to get help

If you have a question, suggestion or just want to say hello, there are various places you can do so:

When reporting bugs or difficulties, please try to include information about the operating system and both the Node.js and Node-RED versions you are using. These can be found in the console output when Node-RED is started:

01 Jan 12:00:00 - [info] Node-RED version: v0.13.3
01 Jan 12:00:00 - [info] Node.js  version: v4.2.6