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

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

This will not work if the directory or username have a space in it. It will run, but if you look at the log, it creates new folder after where the space will be. Anyone have solution? Thanks.

Update:
Don't run this:
nssm set Node-RED AppParameters "-u c:\Users\"%USERNAME%".node-red > c:\temp\node-red.log"

run: nssm edit Node-Red
and make sure the parameters is blank and and it worked for me.

Hi, i'm trying to lock windows workstation by executing "rundll32.exe user32.dll,LockWorkStation". I'm using exec node.
In case of nodered is running as service it's failing.
Could someone tell me why ?
https://msdn.microsoft.com/en-us/library/windows/desktop/aa376875(v=vs.85).aspx

The LockWorkStation function is callable only by processes running on the interactive desktop. In addition, the user must be logged on, and the workstation cannot already be locked.

Could someone tell me about alternative ways ?

Hi,
i got it running with nssm and the redirection of the output. I used the following Node-Red AppParameters:
-u c:\Users"%USERNAME%".node-red 2> C:\temp\node-red.log 1>&2
In this case at first stderr will be redirected after that stdout will be redirected to the same file as stderr.

see also: https://support.microsoft.com/de-de/help/110930/redirecting-error-messages-from-command-prompt-stderr-stdout

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

thanks, works well

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

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

on W10 that won't work unless preceded by -- hence that becomes

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

My flavor to running node-red as a service was the combination of pm2 and pm2-windows-service

• pm2-windows-service actually handles only the pm2 as a visible windows service.
• after that pm2 kicks in and handles it's own configuration.

Sorry to have jumped in on an thread that has to do with the NSSM manager !

Hey, I setup the PM2 service described above by @bloggie. Thank you BTW for your solution!

When I was running from the command prompt and I went to safely shut down ie.. ctrl+C, sometimes it would take a good few seconds before it shut down or I'd even have to hit ctrl+c a couple of times before it shut down.

When I stop the service using:
cmd /k pm2 stop C:\Users\ubiquitous\AppData\Roaming\npm\node_modules\node-red\red.js pause
It stops the service almost instantly every single time.
I'm just wondering if the way I am stopping the service is the right way for it to be "safe"

thanks it is working for me
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"

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. 👌