Upgrade Docker image to Node.js 20 and Debian Bookworm - closes #3185

Author: benfrancis

Dockerfile

@@ -1,10 +1,9 @@
-FROM node:12-buster-slim
+FROM node:20-bookworm-slim
 
 EXPOSE 8080 4443
 
 ARG DEBIAN_FRONTEND=noninteractive
 RUN set -x && \
-    echo "deb http://deb.debian.org/debian buster-backports main" >> /etc/apt/sources.list && \
     apt update && \
     apt dist-upgrade -y && \
     apt install -y \
@@ -15,19 +14,21 @@ RUN set -x && \
         git \
         iputils-ping \
         libcap2-bin \
+        libdbus-1-dev \
         libffi-dev \
         libnss-mdns \
         libpng-dev \
         libtool \
         lsb-release \
         mosquitto \
         net-tools \
+        pipx \
         pkg-config \
-        python \
-        python-six \
         python3 \
         python3-pip \
         python3-setuptools \
+        python3-six \
+        python-is-python3 \
         sudo \
         zlib1g-dev && \
     apt clean && \
@@ -37,7 +38,9 @@ RUN set -x && \
     echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
 
 COPY --chown=node:node . /home/node/webthings/gateway/
-RUN pip3 install -r /home/node/webthings/gateway/requirements.txt
+RUN pipx install cookiecutter && \
+    pipx runpip cookiecutter install -r \
+    /home/node/webthings/gateway/requirements.txt
 
 USER node
 WORKDIR /home/node/webthings/gateway

README.docker.md

@@ -1,6 +1,6 @@
 # WebThings Gateway
 
-Docker image based on Debian Buster for running the
+Docker image based on Debian Bookworm for running the
 [WebThings Gateway](https://github.com/WebThingsIO/gateway). The image
 is built for AMD64, ARMv7, and ARMv8 (AArch64).
 

README.md

@@ -58,8 +58,8 @@ $ sudo apt install \
     libudev-dev \
     libusb-1.0-0-dev \
     pkg-config \
-    python-six \
-    python3-pip
+    python3-six \
+    python3-pip \
 $ sudo -H python3 -m pip install git+https://github.com/WebThingsIO/gateway-addon-python#egg=gateway_addon
 ```
 

docker/init.sh

@@ -11,15 +11,21 @@ ln -sf "/usr/share/zoneinfo/$TZ" /etc/localtime
 # Run avahi-daemon in the background
 /usr/sbin/avahi-daemon -s -D
 
-# Run the gateway
-export WEBTHINGS_HOME=/home/node/.webthings
+# If legacy .mozilla-iot directory exists, then move it to .webthings
+if [[ "$WEBTHINGS_HOME" == "$HOME/.webthings" &&
+      -d "$HOME/.mozilla-iot" &&
+      ! -e "$HOME/.webthings" ]]; then
+  mv "$HOME/.mozilla-iot" "$HOME/.webthings"
+fi
 
-if [[ -d /home/node/.mozilla-iot && ! -e /home/node/.webthings ]]; then
-    pushd /home/node
-    ln -sf .mozilla-iot .webthings
-    chown -R node:node .mozilla-iot
-    popd
+# If .webthings directory doesn't exist then create it
+if [[ ! -e /home/node/.webthings ]]; then
+    mkdir -p /home/node/.webthings
 fi
 
-chown -R node:node "${WEBTHINGS_HOME}"
+# Give the Node user access to the .webthings data directory
+chown -R node:node /home/node/.webthings
+
+# Run the gateway
+export WEBTHINGS_HOME=/home/node/.webthings
 su node -c "cd /home/node/webthings/gateway && ./run-app.sh"

run-app.sh

@@ -45,6 +45,13 @@ run_app() {
   npm run "${start_task}" -- $args
 }
 
+# If legacy .mozilla-iot directory exists, then move it to .webthings
+if [[ "$WEBTHINGS_HOME" == "$HOME/.webthings" &&
+      -d "$HOME/.mozilla-iot" &&
+      ! -e "$HOME/.webthings" ]]; then
+  mv "$HOME/.mozilla-iot" "$HOME/.webthings"
+fi
+
 if ! is_container; then
   if [ ! -f .post_upgrade_complete ]; then
     ./tools/post-upgrade.sh
@@ -53,20 +60,12 @@ else
   _node_version=$(node --version | egrep -o '[0-9]+' | head -n1)
   if [[ ! -f "${WEBTHINGS_HOME}/.node_version" ||
         "$(< "${WEBTHINGS_HOME}/.node_version")" != "${_node_version}" ]]; then
-    cd "${HOME}/webthings/gateway"
     mkdir -p "${WEBTHINGS_HOME}/config"
+    cd "${HOME}/webthings/gateway"
     ./tools/update-addons.sh
-    cd -
-    echo "${_node_version}" > "${WEBTHINGS_HOME}/.node_version"
   fi
 fi
 
-if [[ "$WEBTHINGS_HOME" == "$HOME/.webthings" &&
-      -d "$HOME/.mozilla-iot" &&
-      ! -e "$HOME/.webthings" ]]; then
-  mv "$HOME/.mozilla-iot" "$HOME/.webthings"
-fi
-
 mkdir -p "${WEBTHINGS_HOME}/log"
 
 if [ -f "${WEBTHINGS_HOME}/log/run-app.log" ]; then

tools/update-addons.js

@@ -1,8 +1,8 @@
-const migrate = require('../build/migrate').default;
-const db = require('../build/db').default;
+const migrate = require('../build/migrate');
+const db = require('../build/db');
 db.open();
 
-const AddonManager = require('../build/addon-manager').default;
+const AddonManager = require('../build/addon-manager');
 
 migrate()
   .then(() => {

tools/update-addons.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 
+set -e -x
+
 export NVM_DIR="$HOME/.nvm"
+
 [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
 
+
 node "$(readlink -f "$(dirname "$0")")/update-addons.js"