necessary conditions
To install Node-RED locally, you need a supported version of Node.js.
Install Node-RED using npm
To install Node-RED you can use the command included with npmnode.js:
sudo npm install -g –unsafe-perm node-red
If you are using Windows, do not sudo.
This command installs Node-RED and its dependencies as global modules.
You can confirm that it was successful if the command output ends up similar to the following:
node-red@1.1.0
added 332 packages from 341 contributors in 18.494s
found 0 vulnerabilities
Install Node-RED using npm
To run it in Docker in its simplest form, just run:
docker run -it -p 1880:1880 –name mynodered nodered/node-red
For more details, see Node-RED’s docker guide.
Install using snap
If your operating system supports Snap, you can install Node-RED:
sudo snap install node-red
When installed as a Snap package, it will run in a secure container that does not have access to some extra facilities you may need to use, such as:
· Access main system storage. Only the local home directory can be read/written.
· gcc – any binary components needed to compile node for installation
· git – required if you want to use project features
· Direct access to gpio hardware
· Access any external commands that your flow wants to use with the Exec node (for example).
· If you need access to system hardware or add nodes that require compilation, we recommend using a full installation of Node-RED rather than using snaps.
Get started with Node-RED
Once installed as a global module, you can start Node-RED in the terminal using the node-red command. You can stop Node-RED using Ctrl-C or closing the terminal window.
$node-red
Welcome to Node-RED====================
30 Jun 23:43:39 – [info] Node-RED version: v1.3.5
30 Jun 23:43:39 – [info] Node.jsversion: v14.7.2
30 Jun 23:43:39 – [info] Darwin 19.6.0 x64 LE
30 Jun 23:43:39 – [info] Loading palette nodes
30 Jun 23:43:44 – [warn] rpi-gpio : Raspberry Pi specific node set inactive
30 Jun 23:43:44 – [info] Settings file: /Users/nol/.node-red/settings.js
30 Jun 23:43:44 – [info] HTTP Static: /Users/nol/node-red/web
30 Jun 23:43:44 – [info] Context store: ‘default’ [module=localfilesystem]
30 Jun 23:43:44 – [info] User directory : /Users/nol/.node-red
30 Jun 23:43:44 – [warn] Projects disabled : set editorTheme.projects.enabled=true to enable
30 Jun 23:43:44 – [info] Creating new flows file : flows_noltop.json
30 Jun 23:43:44 – [info] Starting flows
30 Jun 23:43:44 – [info] Started flows
30 Jun 23:43:44 – [info] Server now running at http://127.0.0.1:1880/red/
You can then access the Node-RED editor by pointing your browser to http://localhost:1880.
The log output provides you with various information:
· Node-RED and Node.js versions
· Any errors encountered while trying to load the palette node
· The location of your settings files and user directories
· The name of the stream file it is using.
Node-REDflows_
Utilisation de la ligne de commande
Node-RED Vous pouvez démarrer node-red à l'aide de la commande. Cette commande peut prendre différents paramètres :
node-red [-v] [- ?] [-settings settings.js] [-userDir DIR]
[-port PORT] [-title TITLE] [-safe] [flows.json|nomduprojet]
[-DX=Y|@file]
| Options | décrire |
| -p,-port PORT | Définit le port TCP sur lequel le runtime écoute. Valeur par défaut : 1880 |
| -Sûr | Démarrer Node-RED sans démarrer un flux. Cela vous permet d'ouvrir le flux dans l'éditeur et d'apporter des modifications sans que le flux ne soit en cours d'exécution. Lorsque vous déployez vos modifications, le processus démarre. |
| -s,-settings FILE | Définit le fichier de configuration à utiliser. Par défaut : settings.js dans userDir |
| -TitreTITL | Définir le titre de la fenêtre du processus |
| -u,-userDir DIR | Définit le répertoire utilisateur à utiliser. Valeur par défaut : ~/.node-red |
| -v | Activer la sortie verbeuse |
| -DX=Y|@fichier | Remplacer les réglages individuels |
| - ?,-help | Afficher l'aide à l'utilisation de la ligne de commande et quitter |
| flows.json|nomduprojet | Cette option définit le fichier de flux que vous souhaitez utiliser si la fonction de projet n'est pas activée. Si la fonction Projets est activée, elle détermine le projet à lancer. |
Node-REDflows_
Remplacer les réglages individuels
Démarrage à partir de Node-RED 1.1.0
-D Vous pouvez remplacer des paramètres individuels sur la ligne de commande à l'aide de l'option (ou -define).
Par exemple, pour modifier le niveau de journalisation, vous pouvez utiliser :
-D logging.console.level=trace
Vous pouvez également fournir des paramètres personnalisés sous forme de fichier :
-D @./custom-settings.txt
Le fichier doit contenir une liste de paramètres à remplacer :
logging.console.level=trace
logging.console.audit=true
Transmettre des paramètres au processus Node.js sous-jacent
Il est parfois nécessaire de transmettre des paramètres au processus Node.js sous-jacent. Par exemple, lors de l'exécution sur un appareil à mémoire limitée, tel qu'un Raspberry Pi ou un BeagleBone Black.
Pour ce faire, vous devez utiliser le script de démarrage node-red-pi au lieu de node-red. Note : Ce script n'est pas disponible sous Windows.
Si vous utilisez la commande node pour exécuter Node-RED, vous devez fournir des arguments au processus node avant de spécifier red.js ainsi que les arguments à passer à Node-RED lui-même.
Les deux commandes suivantes illustrent les deux méthodes :
node-red-pi -max-old-space-size=128 -userDir /home/user/node-red-data/
node -max-old-space-size=128 red.js -userDir /home/user/node-red-data/
Mise à jour de Node-RED
Si vous avez installé Node-RED en tant que paquetage global npm, vous pouvez mettre à jour vers la dernière version en utilisant la commande suivante :
sudo npm install -g –unsafe-perm node-red
If you are using Windows, do not sudo.