Installer Node-RED sur macOS ou Windows 10, démarrage automatique avec PM2 • Domotique et objets connectés à faire soi-même

Installer Node-RED sur Windows ou macOS

Node-RED peut être utilisé sur toutes les plateformes pouvant faire fonctionner Node.js. Dans ce tutoriel, nous allons apprendre comment installer Node-RED sur macOS ou un PC Windows. Il existe plusieurs méthodes d’installation. Pour écrire ce tutoriel, je suis resté fidèle à la méthode d’installation officielle. L’installation sur Mac a été faite sur macOS El Captain (10.11.6) mais l’installation sur un version supérieure ne devrait pas être différente.

Installer node.js pour macOS ou Windows

Node-RED supporte node.js 0.10.x ou plus récent. Il est recommandé d’utilisé la version LTS (maintenance à long terme) de node.js

Allez récupérer et puis installez node.js 4.x LTS qui correspond à votre plateforme

Toutes les autres versions de node.js sont disponibles ici https://nodejs.org/en/download/package-manager/

Lancez l’exécutable pour démarrer l’installation.

L’opération est très rapide. L’installeur vous indique les répertoires d’installation à la fin de l’opération.

Installer Node-RED sur macOS

Sur macOS, l’installation de Node-RED est identique à Linux (ou Raspian). Il faut faire précédé la commande npm d’un sudo. Le -g signifie que les sources seront téléchargées dans le répertoire npm et seront disponibles pour tous les projets node.js. –unsafe-perm permet de continuer l’installation en cas d’erreur.

sudo npm install -g --unsafe-perm node-red

L’installation est terminée

Il ne reste plus qu’à lancer démarrer avec la commande node-red. Au premier démarrage, les répertoires et les fichiers nécessaires vont être créés automatiquement :

Fichier / répertoire Localisation
Modules /usr/local/lib/node_modules
Répertoire utilisateur (User Directory) /Users//.node-red
Fichier de configuration (Settings File) /Users//.node-red/settings.js
Fichiers Flows (Flows File) /Users//.node-red/flows_.json
Executable Lien symbolique /usr/local/bin/node-red vers /usr/local/lib/node_modules/node-red/red.js

Le point (.) devant le répertoire signifie qu’il est invisible. Pour le rendre visible dans le Finder, ouvrez un Terminal et exécutez la commande suivante

defaults write com.apple.finder AppleShowAllFiles YES

Ensuite, relancez le Finder avec la commande

killall Finder

Saisissez l’adresse ip du serveur indiqué. Par défaut ce sera 127.0.0.1:1880

Voilà, à vous de jouer !

Démarrer Node-RED à l’ouverture de session avec PM2

Il existe plusieurs solutions pour démarrer automatiquement NR sous Mac (ou Windows). Ici, je vous propose d’utiliser PM2, un gestionnaire de processus pour Node.js. L’avantage, c’est que cette solution fonctionne sur toutes les plateformes. Pratique, si vous avez un jour l’envie de développer sur Raspberry Pi.

sudo npm install -g pm2

Si vous ne connaissez pas le chemin de Node-RED, exécutez cette commande

which node-red

Sur macOS, il est devrait se trouver dans /usr/local/bin/node-red.

Pour lancer NodeRED, exécutez cette commande PM2

pm2 start /usr/local/bin/node-red -- -v

On enregistre la configuration et on active le démarrage automatique

pm2 save
pm2 startup

Installer Node-RED sur Windows 10

Il n’y a pas de Terminal sous Windows, mais il y a PowerShell qui reconnait la plupart des commandes de base Linux. Depuis Cortana, saisissez les premières lettres Power pour trouver et lancer PowerShell.

Vérifions que npm et Nodejs sont bien installés. Exécutez npm -v puis node -v comme sur un système Linux. Tout est bien installé, vous pouvez continuer.

Avec PowerShell, on va installer Node-RED comme sur macOS ou Linux. La commande sudo ne doit pas être ajoutée.

npm install -g --unsafe-perm node-red

Sur Windows 10, les fichiers sont installés dans le répertoire.

c:\\Users\\AppData\Roaming\npm\node_modules

Quelque soit votre version de Windows (actuelle ou future), le chemin d’installation est indiqué par npm dans le résumé de l’installation (à la fin de l’installation).

Démarrer manuellement Node-Red

Pour démarrer manuellement NR, placez vous dans le répertoire d’installation

cd C:\Users\\AppData\Roaming\npm\node_modules\node-red

Puis exécutez la commande commande

node red.js

Au premier démarrage, vous devrez ajouter une nouvelle règle au pare-feu Windows.

Voilà, tout fonctionne comme sur les autres plateformes.

Démarrer Node-RED automatiquement au lancement de Windows avec PM2

Comme pour macOS, nous allons utiliser MP2 pour lancer automatiquement Node-RED au lancement de Windows. Ouvrez PowerShell et exécutez cette commande pour installer PM2.

npm install -g pm2

Pour démarrer manuellement NodeRED, exécutez cette commande en adaptant le chemin vers le fichier red.js. Remplacez Utilisateur par votre nom dans la commande avant de l’exécuter.

pm2 start C:\Users\\AppData\Roaming\npm\node_modules\node-red\red.js -- -v

A la fin de démarrage, PM2 indique le nom de l’application et son IDentifiant et son nom (App name). Ici 0 et red.

NodeRED fonctionne maintenant en arrière plan. Voici quelques commandes utiles. Vous pouvez indiquer aussi bien l’IDentifiant ou le nom de l’application. C’est le nom de l’application lancée par PM2 (ici red).

  • pm2 restart ID|NOM : relance NR.
  • pm2 stop ID|NOM : arrête NodeRED
  • pm2 log ID|NOM : affiche le journal d’exécution en temps réel du programme indiqué. C’est très pratique pour suivre l’exécution de NodeRED.
  • pm2 status ID|NOM
  • pm2 info ID|NOM : affiche de nombreuses infos utiles (état, chemins, versions…)

Maintenant, on va ajouter les packages nécessaires pour permettre à PM2 de se lancer automatiquement. Exécutez

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

Il ne reste plus qu’à enregistrer la configuration

pm2 save

Au prochain démarrage, PM2 lancera automatiquement Node-RED à l’ouverture de session ! Après l’ouverture de session, ouvrez PowerShell et  exécutez la commande pm2 status pour vérifier.

Mises à jour

1/08/2019 Actualisation des liens vers l’installeur Nodejs.

Avez-vous aimé cet article ?