Merge pull request #591 from Paraphraser/20220708-nodered-old-menu

20220708 Node-RED - old-menu branch - PR 2 of 2

Author: Slyke

.templates/nodered/build.sh

@@ -12,7 +12,7 @@ node_selection=$(whiptail --title "Node-RED nodes" --checklist --separate-output
 	"node-red-configurable-ping" " " "ON" \
 	"node-red-node-openweathermap" " " "OFF" \
 	"node-red-contrib-discord" " " "OFF" \
-	"node-red-node-email" " " "on" \
+	"node-red-node-email" " " "OFF" \
 	"node-red-node-google" " " "OFF" \
 	"node-red-node-emoncms" " " "OFF" \
 	"node-red-node-geofence" " " "OFF" \
@@ -21,13 +21,16 @@ node_selection=$(whiptail --title "Node-RED nodes" --checklist --separate-output
 	"node-red-node-smooth" " " "OFF" \
 	"node-red-node-darksky" " " "OFF" \
 	"node-red-node-sqlite" " " "OFF" \
+	"node-red-node-serialport" " " "OFF" \
 	"node-red-contrib-config" " " "OFF" \
 	"node-red-contrib-grove" " " "OFF" \
 	"node-red-contrib-diode" " " "OFF" \
+	"node-red-contrib-sunevents" " " "OFF" \
 	"node-red-contrib-bigtimer" " " "OFF" \
 	"node-red-contrib-esplogin" " " "OFF" \
 	"node-red-contrib-timeout" " " "OFF" \
 	"node-red-contrib-moment" " " "OFF" \
+	"node-red-contrib-telegrambot" " " "OFF" \
 	"node-red-contrib-particle" " " "OFF" \
 	"node-red-contrib-web-worldmap" " " "OFF" \
 	"node-red-contrib-ramp-thermostat" " " "OFF" \
@@ -41,6 +44,13 @@ node_selection=$(whiptail --title "Node-RED nodes" --checklist --separate-output
 	"node-red-contrib-heater-controller" " " "OFF" \
 	"node-red-contrib-deconz" " " "OFF" \
 	"node-red-contrib-generic-ble" " " "OFF" \
+	"node-red-contrib-zigbee2mqtt" " " "OFF" \
+	"node-red-contrib-vcgencmd" " " "OFF" \
+	"node-red-contrib-themes/midnight-red" " " "OFF" \
+	"node-red-contrib-tf-function" " " "OFF" \
+	"node-red-contrib-tf-model" " " "OFF" \
+	"node-red-contrib-post-object-detection" " " "OFF" \
+	"node-red-contrib-bert-tokenizer" " " "OFF" \
 	3>&1 1>&2 2>&3)
 
 ##echo "$check_selection"
@@ -50,12 +60,33 @@ nr_dfile=./services/nodered/Dockerfile
 
 sqliteflag=0
 
-touch $nr_dfile
-echo "FROM nodered/node-red:latest-12" >$nr_dfile
+# initialise Dockerfile ('EOT' syntax avoids bash substitutions)
+cat <<-'EOT' >"$nr_dfile"
+# reference argument - omitted defaults to latest
+ARG DOCKERHUB_TAG=latest
 
-echo "USER root" >>$nr_dfile
-echo "RUN apk update && apk add --no-cache eudev-dev" >>$nr_dfile
-echo "USER node-red" >>$nr_dfile
+# Download base image
+FROM nodered/node-red:${DOCKERHUB_TAG}
+
+# reference argument - omitted defaults to null
+ARG EXTRA_PACKAGES
+ENV EXTRA_PACKAGES=${EXTRA_PACKAGES}
+
+# default user is node-red - need to be root to install packages
+USER root
+
+# install packages
+RUN apk update && apk add --no-cache eudev-dev ${EXTRA_PACKAGES}
+
+# switch back to default user
+USER node-red
+
+# variable not needed inside running container
+ENV EXTRA_PACKAGES=
+
+# add-on nodes follow
+
+EOT
 
 #node red install script inspired from https://tech.scargill.net/the-script/
 echo "RUN for addonnodes in \\" >>$nr_dfile

.templates/nodered/service.yml

@@ -1,6 +1,10 @@
   nodered:
     container_name: nodered
-    build: ./services/nodered/.
+    build:
+      context: ./services/nodered/.
+      args:
+      - DOCKERHUB_TAG=latest
+      - EXTRA_PACKAGES=
     restart: unless-stopped
     user: "0"
     env_file: ./services/nodered/nodered.env

scripts/nodered_list_installed_nodes.sh

@@ -1,41 +1,61 @@
 #!/usr/bin/env bash
 
-INTERNAL="/usr/src/node-red/node_modules"
-EXTERNAL="$HOME/IOTstack/volumes/nodered/data/node_modules"
-
-echo -e "\nNodes installed by Dockerfile INSIDE the container at $INTERNAL"
-
-CANDIDATES=$(docker exec nodered bash -c "ls -1d $INTERNAL/node-red-*")
-
-for C in $CANDIDATES; do
-
-   NODE=$(basename "$C")
-
-   # is a node of the same name also present externally
-   if [ -d "$EXTERNAL/$NODE" ] ; then
-
-      # yes! the internal node is blocked by the external node
-      echo " BLOCKED: $NODE"
-
-   else
-
-      # no! so that means it's active
-      echo "  ACTIVE: $NODE"
-
+# where Dockerfile installs components INSIDE the container
+DOCKERFILE="/usr/src/node-red"
+
+# paths to the persistent store
+PERSISTENT_INTERNAL="/data"
+PERSISTENT_EXTERNAL="$HOME/IOTstack/volumes/nodered/data"
+
+# the folder in each case containing node modules
+MODULES="node_modules"
+
+# assume no modules are blocked
+unset BLOCKED
+
+# start the command hint
+UNBLOCK="docker exec -w /data nodered npm uninstall"
+
+# fetch what npm knows about components that form part of the image
+echo -e "\nFetching list of candidates installed via Dockerfile"
+CANDIDATES=$(docker exec nodered bash -c "cd \"$DOCKERFILE\" ; npm list --depth=0 --parseable 2>/dev/null")
+
+# report
+echo -e "\nComponents built into the image (via Dockerfile)"
+PARENT=$(basename "$DOCKERFILE")
+for CANDIDATE in $CANDIDATES; do
+   COMPONENT=$(basename "$CANDIDATE")
+   if [ "$COMPONENT" != "$PARENT" ] ; then
+      if [ -d "$PERSISTENT_EXTERNAL/$MODULES/$COMPONENT" ] ; then
+         # yes! the internal node is blocked by the external node
+         echo "  BLOCKED: $COMPONENT"
+         BLOCKED=true
+         UNBLOCK="$UNBLOCK $COMPONENT"
+      else
+         # no! so that means it's active
+         echo "   ACTIVE: $COMPONENT"
+      fi
    fi
-
 done
 
-echo -e "\nNodes installed by Manage Palette OUTSIDE the container at $EXTERNAL"
-
-CANDIDATES=$(ls -1d "$EXTERNAL/node-red-"*)
-
-for C in $CANDIDATES; do
-
-   NODE=$(basename "$C")
-
-   echo " $NODE"
-
+# fetch what npm knows about components that are in the persistent store
+echo -e "\nFetching list of candidates installed via Manage Palette or npm"
+CANDIDATES=$(docker exec nodered bash -c "cd \"$PERSISTENT_INTERNAL\" ; npm list --depth=0 --parseable")
+
+# report
+echo -e "\nComponents in persistent store at\n $PERSISTENT_EXTERNAL/$MODULES"
+PARENT=$(basename "$PERSISTENT_INTERNAL")
+for CANDIDATE in $CANDIDATES; do
+   COMPONENT=$(basename "$CANDIDATE")
+   if [ "$COMPONENT" != "$PARENT" ] ; then
+      echo "  $COMPONENT"
+   fi
 done
 
 echo ""
+
+if [ -n "$BLOCKED" ] ; then
+   echo "Blocking nodes can be removed by running the following commands"
+   echo "\$ $UNBLOCK"
+   echo "\$ docker-compose -f ~/IOTstack/docker-compose.yml restart nodered"
+fi