fix typo

add error handling for user scripts

.VERSION

@@ -1 +1 @@
-v9.0.1
+v9.1.0-beta.2

CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Changelog
 
+### v9.1.0-beta.2 (coming soon)
+* enhance logging/ fix typos
+* add env PACKAGES_UPDATE and remove automatic package updates on first container start
+* improve setuid/setgid handling during startup ([#397](https://github.com/buanet/ioBroker.docker/issues/397))
+* move maintenance script registration to dockerfile ([#390](https://github.com/buanet/ioBroker.docker/issues/390))
+* v9.1.0-beta.1 (03.11.2023)
+  * improve maintenance command by symlinking ([#390](https://github.com/buanet/ioBroker.docker/issues/390))
+  * fix restore/ adding backup file selection ([#394](https://github.com/buanet/ioBroker.docker/issues/394))
+  * fix calling iob start|stop with parameters
+  * enhance logging in iobroker_startup.sh
+  * add error handling for user scripts
+
 ### v9.0.1 (10.10.2023)
 * fix issue with avahi setup ([#384](https://github.com/buanet/ioBroker.docker/issues/384); [#385 by @z1r0](https://github.com/buanet/ioBroker.docker/pull/385))
 * add silent cleanup to setup_avahi.sh

debian12/Dockerfile

@@ -75,6 +75,10 @@ RUN apt-get update && apt-get upgrade -y \
     && chown -R iobroker:iobroker /opt/scripts /opt/userscripts \
     && chmod 755 /opt/scripts/*.sh \
     && chmod 755 /opt/userscripts/*.sh \
+    # register maintenance command
+    && ln -s /opt/scripts/maintenance.sh /bin/maintenance \
+    && ln -s /opt/scripts/maintenance.sh /bin/maint \
+    && ln -s /opt/scripts/maintenance.sh /bin/m \
     # Clean up installation cache
     && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
     && apt-get autoclean -y \

debian12/scripts/iobroker.sh

@@ -39,27 +39,48 @@ iob_diag () {
   fi
 }
 
-if [ "$1" = "fix" ]; then # call iobroker fixer
-  iob_fix
-elif [ "$1" = "node fix" ]; then # call iobroker node fixer
-  echo "The execution of this command is blocked as your ioBroker is running inside a Docker container!"
-  echo "To fix any issues with nodejs, please pull the latest version of the Docker image and recreate your container."
-elif [ "$1" = "diag" ]; then # call iobroker diag script
-  iob_diag
-elif [ "$1" = "start" ] || [ "$1" = "stop" ] || [ "$1" = "restart" ]; then # block execution of iobroker start | stop | restart
-  echo "The execution of this command is blocked as your ioBroker is running inside a Docker container!"
-  echo "For more details see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs/) or use the maintenance script 'maintenance --help'."
-elif [ "$1" = "m" ] || [ "$1" = "maint" ] || [ "$1" = "maintenance" ]; then # call iobroker maintenance script
+# run iobroker maintenance script
+iob_maint() {
   shift
-  if [ "$(id -u)" -eq 0 ]; then # check for execution as root
+  if [ "$(id -u)" -eq 0 ]; then
     gosu iobroker bash /opt/scripts/maintenance.sh "$@"
   else
     bash /opt/scripts/maintenance.sh "$@"
   fi
-else # passing all other parameters to iobroker.js
-  if [ "$(id -u)" -eq 0 ]; then # check for execution as root
+}
+
+# pass parameters and run iobroker.js
+iob_run() {
+  if [ "$(id -u)" -eq 0 ]; then
     gosu iobroker node /opt/iobroker/node_modules/iobroker.js-controller/iobroker.js "$@"
   else
     node /opt/iobroker/node_modules/iobroker.js-controller/iobroker.js "$@"
   fi
+}
+
+if [ "$1" = "fix" ]; then
+  # call iobroker fixer
+  iob_fix
+elif [ "$1" = "node fix" ]; then
+  # call iobroker node fixer
+  echo "The execution of this command is blocked as your ioBroker is running inside a Docker container!"
+  echo "To fix any issues with nodejs, please pull the latest version of the Docker image and recreate your container."
+elif [ "$1" = "diag" ]; then
+  # call iobroker diag script
+  iob_diag
+elif [ "$1" = "start" ] || [ "$1" = "stop" ] || [ "$1" = "restart" ]; then
+  # block execution of iobroker start | stop | restart but pass start | stop for adapters
+  if [ ! "$2" ]; then
+    echo "The execution of this command is blocked as your ioBroker is running inside a Docker container!"
+    echo "For more details see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs/) or use the maintenance script 'maintenance --help'."
+  else
+    # passing all other parameters to iobroker.js but check for execution as root
+    iob_run "$@"
+  fi
+elif [ "$1" = "m" ] || [ "$1" = "maint" ] || [ "$1" = "maintenance" ]; then
+  # call iobroker maintenance script but check for execution as root
+  iob_maint "$@"
+else
+  # passing all other parameters to iobroker.js but check for execution as root
+  iob_run "$@"
 fi

debian12/scripts/iobroker_startup.sh

@@ -17,17 +17,18 @@ offlinemode=$OFFLINE_MODE
 objectsdbhost=$IOB_OBJECTSDB_HOST
 objectsdbport=$IOB_OBJECTSDB_PORT
 objectsdbtype=$IOB_OBJECTSDB_TYPE
-objectsdbname=$IOB_OBJECTSDB_NAME # new for sentinel support
-objectsdbpass=$IOB_OBJECTSDB_PASS # new for auth support
+objectsdbname=$IOB_OBJECTSDB_NAME
+objectsdbpass=$IOB_OBJECTSDB_PASS
 packages=$PACKAGES
+packagesupdate=$PACKAGES_UPDATE
 permissioncheck=$PERMISSION_CHECK
 setgid=$SETGID
 setuid=$SETUID
 statesdbhost=$IOB_STATESDB_HOST
 statesdbport=$IOB_STATESDB_PORT
 statesdbtype=$IOB_STATESDB_TYPE
-statesdbname=$IOB_STATESDB_NAME # new for sentinel support
-statesdbpass=$IOB_STATESDB_PASS # new for auth support
+statesdbname=$IOB_STATESDB_NAME
+statesdbpass=$IOB_STATESDB_PASS
 usbdevices=$USBDEVICES
 set -u
 
@@ -99,6 +100,7 @@ if [[ "$statesdbname" != "" ]]; then echo -n "-----                    " && echo
 if [[ "$statesdbpass" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" IOB_STATESDB_PASS: "***")" && echo " -----"; fi
 if [[ "$offlinemode" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" OFFLINE_MODE: "$offlinemode")" && echo " -----"; fi
 if [[ "$packages" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" PACKAGES: "$packages")" && echo " -----"; fi
+if [[ "$packagesupdate" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" PACKAGES_UPDATE: "$packagesupdate")" && echo " -----"; fi
 if [[ "$permissioncheck" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" PERMISSION_CHECK: "$permissioncheck")" && echo " -----"; fi
 if [[ "$setgid" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" SETGID: "$setgid")" && echo " -----"; fi
 if [[ "$setuid" != "" ]]; then echo -n "-----                    " && echo -n "$(printf "%-20s %-28s" SETUID: "$setuid")" && echo " -----"; fi
@@ -123,7 +125,7 @@ fi
 # STEP 1 - Preparing container
 #####
 echo "$(printf -- '-%.0s' {1..80})"
-echo "-----                   Step 1 of 5: Preparing container                   -----"
+echo "-----                   Step 1 of 5: Preparing Container                   -----"
 echo "$(printf -- '-%.0s' {1..80})"
 echo " "
 
@@ -132,39 +134,27 @@ if [[ -f /opt/.docker_config/.first_run ]]; then
   # Updating Linux packages
   if [[ "$offlinemode" = "true" ]]; then
     echo "OFFLINE_MODE is \"true\". Skipping Linux package updates on first run."
-  else
-    if bash /opt/scripts/setup_packages.sh -update; then
     echo " "
-    else
-      echo "Error: Updating failed."
-    fi
-  fi
+  elif [[ "$packagesupdate" = "true" ]]; then
+    if ! bash /opt/scripts/setup_packages.sh -update; then echo "Failed."; fi
     echo " "
+  fi
+
   # Installing packages from ENV
   if [[ "$packages" != "" && "$offlinemode" = "true" ]]; then
     echo "PACKAGES is set, but OFFLINE_MODE is \"true\". Skipping Linux package installation."
   elif [[ "$packages" != "" ]]; then
     echo "PACKAGES is set. Installing the following additional Linux packages: ""$packages"
-      if bash /opt/scripts/setup_packages.sh -install; then
-        echo " "
-      else
-        echo "Error: Installation failed."
-      fi
+    if ! bash /opt/scripts/setup_packages.sh -install; then echo "Failed."; fi
   fi
   echo " "
-  # Register maintenance script
-  echo -n "Registering maintenance script as command... "
-  echo "alias maintenance='/opt/scripts/maintenance.sh'" >> /etc/bash.bashrc
-  echo "alias maint='/opt/scripts/maintenance.sh'" >> /etc/bash.bashrc
-  echo "alias m='/opt/scripts/maintenance.sh'" >> /etc/bash.bashrc
-  echo "Done."
 else
   echo "This is not the first run of this container. Skipping first run preparation."
 fi
 echo " "
 
 # Setting UID and/ or GID
-if [[ "$setgid" != "$(cat /etc/group | grep 'iobroker:' | cut -d':' -f3)" || "$setuid" != "$(cat /etc/passwd | grep 'iobroker:' | cut -d':' -f3)" ]]; then
+if [[ "$setgid" != "$(id -u iobroker)" || "$setuid" != "$(id -g iobroker)" ]]; then
   echo "SETUID and/ or SETGID are set to custom values."
   echo -n "Changing UID to \"""$setuid""\" and GID to \"""$setgid""\"... "
     usermod -u "$setuid" iobroker
@@ -180,7 +170,7 @@ cd /opt/iobroker
 # STEP 2 - Detecting ioBroker-Installation
 #####
 echo "$(printf -- '-%.0s' {1..80})"
-echo "-----             Step 2 of 5: Detecting ioBroker installation             -----"
+echo "-----             Step 2 of 5: Detecting ioBroker Installation             -----"
 echo "$(printf -- '-%.0s' {1..80})"
 echo " "
 
@@ -194,10 +184,10 @@ elif [[ -f /opt/iobroker/iobroker ]]; then
 elif [[ "$(ls *_backupiobroker.tar.gz 2> /dev/null | wc -l)" != "0" && "$(tar -ztvf /opt/iobroker/*_backupiobroker.tar.gz "backup/backup.json" 2> /dev/null | wc -l)" != "0" ]]; then
   echo "IoBroker backup file detected in /opt/iobroker."
   if [[ "$debug" == "true" ]]; then echo "[DEBUG] Backup file name: " "$(ls *_backupiobroker.tar.gz)"; fi
-  echo "Since Docker Image v8, automatic initial restore is no longer supported!"
+  echo "Since Docker image v8, automatic initial restore is no longer supported!"
   echo "IoBroker will start with a fresh installation, while your backup file will be copied into the backup directory."
   echo "You will be able to restore your backup file manually by using the backitup adapter or the containers maintenance script."
-  echo "For more information see ioBroker Docker Image Docs (https://docs.buanet.de/iobroker-docker-image/docs/)."
+  echo "For more information see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs/)."
   echo " "
   echo -n "Copying backup file and restoring initial ioBroker installation... "
     mv /opt/iobroker/*.tar.gz /opt/
@@ -222,11 +212,11 @@ echo " "
 # STEP 3 - Checking ioBroker-Installation
 #####
 echo "$(printf -- '-%.0s' {1..80})"
-echo "-----             Step 3 of 5: Checking ioBroker installation              -----"
+echo "-----             Step 3 of 5: Checking ioBroker Installation              -----"
 echo "$(printf -- '-%.0s' {1..80})"
 echo " "
 
-# Backing up original iobroker executable to fix sudo bug with gosu
+# Backing up and replace original iobroker executable to fix sudo bug with gosu
 if [[ -n $(cmp /opt/scripts/iobroker.sh /opt/iobroker/iobroker) ]]; then
   echo -n "Replacing ioBroker executable to fix sudo bug... "
   cp -a /opt/iobroker/iobroker /opt/iobroker/iobroker.bak
@@ -307,7 +297,7 @@ elif [[ "$multihost" == "" || "$multihost" == "false" ]]; then
 else
   echo "IOB_MULTIHOST is set, but the value is not valid. Please check your configuration."
   if [[ "$debug" == "true" ]]; then echo "[DEBUG] IOB_MULTIHOST = ""$multihost"; fi
-  echo "For more information see ioBroker Docker Image Docs (https://docs.buanet.de/iobroker-docker-image/docs/#environment-variables-env)."
+  echo "For more information see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs/#environment-variables-env)."
   stop_on_error
 fi
 
@@ -329,7 +319,7 @@ if [[ -f /opt/iobroker/.fresh_install && "$multihost" != "slave" ]]; then
   echo "Done."
   echo " "
 else
-  echo -n "Checking Database connection... "
+  echo -n "Checking database connection... "
   set +e
   if gosu iobroker iob uuid &> /dev/null; then
     echo "Done."
@@ -342,7 +332,7 @@ else
       echo "$errormsg"
     fi
     echo "Please check your configuration and try again."
-    echo "For more information see ioBroker Docker Image Docs (https://docs.buanet.de/iobroker-docker-image/docs)."
+    echo "For more information see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs)."
     stop_on_error
   fi
   set -e
@@ -429,12 +419,12 @@ fi
 # STEP 4 - Setting up special sessting for ioBroker-adapters
 #####
 echo "$(printf -- '-%.0s' {1..80})"
-echo "-----                Step 4 of 5: Applying special settings                -----"
+echo "-----                Step 4 of 5: Applying Special Settings                -----"
 echo "$(printf -- '-%.0s' {1..80})"
 echo " "
 
 echo "Some adapters have special requirements/ settings which can be activated by the use of environment variables."
-echo "For more information see ioBroker Docker Image Docs (https://docs.buanet.de/iobroker-docker-image/docs/)."
+echo "For more information see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs/)."
 echo " "
 
 # Checking ENV for Adminport
@@ -486,7 +476,7 @@ if [[ "$usbdevices" != "" && "$usbdevices" != "none" ]]; then
       else
         echo "Looks like the device \"""$i""\" does not exist."
         echo "Did you mount it correctly by using the \"--device\" option?"
-        echo "For more information see ioBroker Docker Image Docs (https://docs.buanet.de/iobroker-docker-image/docs/#mounting-usb-devices)."
+        echo "For more information see ioBroker Docker image docs (https://docs.buanet.de/iobroker-docker-image/docs/#mounting-usb-devices)."
         stop_on_error
       fi
     done
@@ -505,17 +495,24 @@ elif [[ -f /opt/userscripts/userscript_firststart.sh || -f /opt/userscripts/user
     echo "Userscript for first start detected and this is the first start of a new container."
     echo "Running userscript_firststart.sh... "
       chmod 755 /opt/userscripts/userscript_firststart.sh
-      bash /opt/userscripts/userscript_firststart.sh
+      if ! bash /opt/userscripts/userscript_firststart.sh; then
+        echo "Failed."
+      else
         echo "Done."
       fi
+  fi
   if [[ -f /opt/userscripts/userscript_everystart.sh ]]; then
     echo "Userscript for every start detected. Running userscript_everystart.sh... "
       chmod 755 /opt/userscripts/userscript_everystart.sh
-      bash /opt/userscripts/userscript_everystart.sh
+      if ! bash /opt/userscripts/userscript_everystart.sh; then
+        echo "Failed."
+      else
         echo "Done."
       fi
+  fi
+  echo " "
 fi
-echo " "
+
 
 # Removing first run an fresh install markers when exists
 if [[ -f /opt/.docker_config/.first_run ]]; then rm -f /opt/.docker_config/.first_run; fi
@@ -525,7 +522,7 @@ if [[ -f /opt/iobroker/.fresh_install ]]; then rm -f /opt/iobroker/.fresh_instal
 # STEP 5 - Starting ioBroker
 #####
 echo "$(printf -- '-%.0s' {1..80})"
-echo "-----                    Step 5 of 5: ioBroker startup                     -----"
+echo "-----                    Step 5 of 5: ioBroker Startup                     -----"
 echo "$(printf -- '-%.0s' {1..80})"
 echo " "
 echo "Starting ioBroker... "

debian12/scripts/maintenance.sh

@@ -165,12 +165,12 @@ stop_iob() {
 
   if [[ "$killbyname" != yes ]]; then
     # pgrep exits with status 1 when there are no matches
-    while pgrep -u iobroker -f 'io.' > /dev/null; (( $? != 1 )); do
+    while pgrep -u iobroker -f 'io\..' > /dev/null; (( $? != 1 )); do
       if (($(date +%s) > timeout)); then
         echo -e "\nTimeout reached. Killing remaining processes..."
-        pgrep --list-full -u iobroker
-        pkill --signal SIGKILL -u iobroker -f 'io.'
-        echo "\nDone."
+        pgrep --list-full -u iobroker -f 'io\..'
+        pkill --signal SIGKILL -u iobroker -f 'io\..'
+        echo "Done."
         return
       fi
       sleep 1
@@ -184,6 +184,7 @@ stop_iob() {
   fi
 
   echo -e "Done."
+  echo " "
 }
 
 # restart container
@@ -219,35 +220,63 @@ restore_iobroker() {
   echo "During the restore process, the container will automatically switch into maintenance mode and stop ioBroker."
   echo "Depending on the restart policy, your container will be stopped or restarted automatically after the restore."
   
+  # check autoconfirm
   if [[ "$autoconfirm" != yes ]]; then
     local reply
 
     read -rp 'Do you want to continue [yes/no]? ' reply
-    if [[ "$reply" == y || "$reply" == Y || "$reply" == yes ]]; then
-      : # continue
-    else
+    if [[ "$reply" != y && "$reply" != Y && "$reply" != yes ]]; then
         return 1
     fi
   fi
+  echo " "
 
+  # check startup script running
   if check_starting > /dev/null; then
     echo "Startup script is still running."
     echo "Please check container log and wait until ioBroker is sucessfully started."
-    echo "Then try again."
     return 1
   fi
 
+  # check mainenance mode
   if ! maintenance_enabled > /dev/null; then
     autoconfirm=yes
     enable_maintenance
   fi
 
-  echo -n "Restoring ioBroker... "
+  # list backup files
+  backup_dir="/opt/iobroker/backups"
+  backup_files=($(find $backup_dir -type f))
+  backup_count=${#backup_files[@]}
+
+  if [[ $backup_count -eq 0 ]]; then
+      echo "Ther are no backup files in $backup_dir."
+      echo "Please check and try again."
+      return 1
+  elif [[ $backup_count -eq 1 ]]; then
+      selected_backup=$(basename "${backup_files[0]}")
+      echo "There is one backup file in $backup_dir."
+  else
+      # more than one backup file found, ask user to select
+      echo "There is more than one backup file in $backup_dir."
+      echo "Please select file for restore:"
+      for ((i=0; i<$backup_count; i++)); do
+        echo "$i: $(basename "${backup_files[$i]}")"
+      done
+      echo
+
+      read -rp "Enter the number of the backup to restore (0-$((backup_count - 1))): " selected_number
+      selected_backup=$(basename "${backup_files[$selected_number]}")
+  fi
+
+  # restoe backup
+  echo -n "Restoring ioBroker from $selected_backup... "
   set +e
-  bash iobroker restore 0 > /opt/iobroker/log/restore.log 2>&1
-  return=$?
+  bash iobroker restore "$selected_backup" > /opt/iobroker/log/restore.log 2>&1
+  return_value=$?
   set -e
-  if [[ "$return" -ne 0 ]]; then
+
+  if [[ "$return_value" -ne 0 ]]; then
       echo "Failed."
       echo "For more details see \"/opt/iobroker/log/restore.log\"."
       echo "Please check backup file location and permissions and try again."
@@ -265,8 +294,8 @@ restore_iobroker() {
   echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
   sleep 10
   echo "Container will be stopped or restarted in 10 seconds..."
-  sleep 10
   echo "stopping" > "$healthcheck"
+  sleep 10
   pkill -u iobroker
 }
 

debian12/scripts/setup_packages.sh

@@ -58,7 +58,7 @@ if [[ "$1" == "-install" ]]; then
     fi
   done
 elif [[ "$1" == "-update" ]]; then
-  echo -n "Updating Linux packages on first run... "
+  echo -n "PACKAGES_UPDATE is set. Updating Linux packages on first run... "
   apt-get -q update >> /opt/scripts/setup_packages.log 2>&1
   return1=$?
   apt-get -q -y upgrade >> /opt/scripts/setup_packages.log 2>&1

docs/README_docker_hub_buanet.md

@@ -124,6 +124,7 @@ You could use environment variables to auto configure your ioBroker container on
 * `LC_ALL` (optional, default: de_DE.UTF-8) The following locales are pre-generated: de_DE.UTF-8, en_US.UTF-8
 * `OFFLINE_MODE` (optional) Set `true` if your container has no or limited internet connection
 * `PACKAGES` (optional) Install additional Linux packages to your container, packages should be separated by whitespace like this: `package1 package2 package3`.
+* `PACKAGES_UPDATE` (optional) Set `true` if you want to apply Linux package updates at the first start of a new container.
 * `PERMISSION_CHECK` (optional, default: true) Set "false" to skip checking and correcting all relevant permissions on container startup (Use at own risk!!!)
 * `SETGID` (default: 1000) In some cases it might be useful to specify the gid of the containers iobroker user to match an existing group on the docker host
 * `SETUID` (default: 1000) In some cases it might be useful to specify the uid of the containers iobroker user to match an existing user on the docker host

docs/README_docker_hub_iobroker.md

@@ -126,6 +126,7 @@ You could use environment variables to auto configure your ioBroker container on
 * `LC_ALL` (optional, default: de_DE.UTF-8) The following locales are pre-generated: de_DE.UTF-8, en_US.UTF-8
 * `OFFLINE_MODE` (optional) Set `true` if your container has no or limited internet connection
 * `PACKAGES` (optional) Install additional Linux packages to your container, packages should be separated by whitespace like this: `package1 package2 package3`.
+* `PACKAGES_UPDATE` (optional) Set `true` if you want to apply Linux package updates at the first start of a new container.
 * `PERMISSION_CHECK` (optional, default: true) Set "false" to skip checking and correcting all relevant permissions on container startup (Use at own risk!!!)
 * `SETGID` (default: 1000) In some cases it might be useful to specify the gid of the containers iobroker user to match an existing group on the docker host
 * `SETUID` (default: 1000) In some cases it might be useful to specify the uid of the containers iobroker user to match an existing user on the docker host