Running Node-RED as a service on Windows using NSSM

nssm.md

Running Node-RED as a service on Windows using NSSM

These instructions assume you installed Node-RED from an administrator enabled command prompt using the npm install -g node-red command to do so.

As an administrator, install nssm from https://nssm.cc/download

And then from the directory where you installed nssm, run the commands

mkdir c:\temp
nssm install Node-RED "c:\Users\\"%USERNAME%"\AppData\Roaming\npm\node-red.cmd"
nssm set Node-RED AppDirectory "c:\Users\\"%USERNAME%"\.node-red"
nssm set Node-RED AppParameters "-u c:\Users\\"%USERNAME%"\.node-red > c:\temp\node-red.log"
nssm set Node-RED Description "A wiring tool for the Internet of Things"

You can edit the service using the GUI to the configuration, add extra parameters, etc.

nssm edit Node-RED

The log will be written to c:\temp\node-red.log (see line 3)

For further options read the nssm usage page.

Another way for autostarting NodeRed in PM2 as a Serivce in Windows:

Everything in command-line as Admin:

Install node-red

npm install -g node-red

Install pm2

npm install pm2 -g

Install and config pm2-windows-startup package :

npm install pm2-windows-startup -g
pm2-startup install
pm2 save

Locate the Node-Red red.js File and add it to pm2:

pm2 start C:\Users\<USER-NAME>\AppData\Roaming\npm\node_modules\node-red\red.js --save

thank you so much

@bloigge does the PM2 method autorestart Node-RED if it crashes?

@matteoangrisano - I am not using pm2 anymore - but I think there a several strategies regarding restarting an app: https://pm2.keymetrics.io/docs/usage/restart-strategies/

Note: Running this from a Powershell prompt will not work. Escaping of quotes will fail and the commands will all get borked.

If you intend to use nssm and installation by Powershell you can execute something like:

$NssmDir = "<your_path_to_nssm>"
$NodeRedDir = "C:\Users\$($env:USERNAME)\AppData\Roaming\npm\node-red.cmd"
$ServiceName = "Node-RED"
Set-Location $NssmDir
.\nssm.exe install $($ServiceName) $NodeRedDir -Wait
.\nssm.exe set $($ServiceName) AppDirectory "C:\Users\$($env:USERNAME)\.node-red"
.\nssm.exe set $($ServiceName) AppParameters "-u c:\Users\$($env:USERNAME)\.node-red > c:\Users\$($env:USERNAME)\.node-red\log.log"
.\nssm.exe set $($ServiceName) Description "A wiring tool for the Internet of Things"
Start-Service $ServiceName

Another way for autostarting NodeRed in PM2 as a Serivce in Windows:

Everything in command-line as Admin:

Install node-red

npm install -g node-red

Install pm2

npm install pm2 -g

Install and config pm2-windows-startup package :

npm install pm2-windows-startup -g pm2-startup install pm2 save

Locate the Node-Red red.js File and add it to pm2:

pm2 start C:\Users\<USER-NAME>\AppData\Roaming\npm\node_modules\node-red\red.js --save

Yes, thanks. 👌