Merge pull request #407 from buanet/dependabot/github_actions/beta/actions/checkout-4.1.1

Bump actions/checkout from 4.1.0 to 4.1.1

.VERSION

@@ -1 +1 @@
-v9.1.0-beta.1
+v9.1.0-beta.3

.github/dependabot.yml

@@ -5,4 +5,4 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
-    target-branch: "main"
+    target-branch: "beta"

.github/workflows/build-debian12-beta.yml

@@ -24,7 +24,7 @@ jobs:
         run: echo "RELEASE_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
 
       - name: Checkout repo
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.1
         with:
           repository: 'buanet/ioBroker.docker'
           ref: ${{ env.RELEASE_TAG }}
@@ -96,7 +96,7 @@ jobs:
           run: echo "RELEASE_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
 
         - name: Checkout repo
-          uses: actions/checkout@v4.1.0
+          uses: actions/checkout@v4.1.1
           with:
             repository: 'buanet/ioBroker.docker'
             ref: ${{ env.RELEASE_TAG }}

.github/workflows/build-debian12-dev.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.1
         with:
           repository: 'buanet/ioBroker.docker'
 
@@ -85,7 +85,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.1
         with:
           repository: 'buanet/ioBroker.docker'
 

.github/workflows/build-debian12-latest.yml

@@ -18,7 +18,7 @@ jobs:
           echo "RELEASE_TAG=$LATESTRELEASE" >> $GITHUB_ENV
 
       - name: Checkout repo
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.1
         with:
           repository: 'buanet/ioBroker.docker'
           ref: ${{ env.RELEASE_TAG }}
@@ -94,7 +94,7 @@ jobs:
           echo "RELEASE_TAG=$LATESTRELEASE" >> $GITHUB_ENV
 
       - name: Checkout repo
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.1
         with:
           repository: 'buanet/ioBroker.docker'
           ref: ${{ env.RELEASE_TAG }}

.github/workflows/update-docker-readme.yml

@@ -12,7 +12,7 @@ jobs:
   update-docker-readme:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4.1.0
+    - uses: actions/checkout@v4.1.1
 
     - name: Update Docker Hub Readme (buanet)
       uses: peter-evans/dockerhub-description@v3.4.2

.github/workflows/version-checks.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v4.1.0
+        uses: actions/checkout@v4.1.1
         with:
           repository: 'buanet/ioBroker.docker'
           token: ${{ secrets.ACTIONS_PAT }}

CHANGELOG.md

@@ -1,11 +1,19 @@
 ## Changelog
 
-### 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.1.0-beta.3 (23.11.2023)
+* add --force to restore in maintenance script
+* improve shebang in scripts for downgrade and portability
+* v9.1.0-beta.2 (06.11.2023)
+  * 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))

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/healthcheck.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Script checks health of running container
 

debian12/scripts/iobroker.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/bash
+#!/usr/bin/env bash
 
 # run iob fix
 iob_fix () {

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,10 +134,12 @@ 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
+    echo " "
+  elif [[ "$packagesupdate" = "true" ]]; then
     if ! bash /opt/scripts/setup_packages.sh -update; then echo "Failed."; fi
+    echo " "
   fi
-  echo " "
+
   # Installing packages from ENV
   if [[ "$packages" != "" && "$offlinemode" = "true" ]]; then
     echo "PACKAGES is set, but OFFLINE_MODE is \"true\". Skipping Linux package installation."
@@ -144,19 +148,13 @@ if [[ -f /opt/.docker_config/.first_run ]]; then
     if ! bash /opt/scripts/setup_packages.sh -install; then echo "Failed."; fi
   fi
   echo " "
-  # Register maintenance script
-  echo -n "Registering maintenance script as 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
-  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
@@ -172,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 " "
 
@@ -186,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/
@@ -214,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
@@ -299,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
 
@@ -321,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."
@@ -334,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
@@ -421,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
@@ -478,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
@@ -524,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

@@ -272,7 +272,7 @@ restore_iobroker() {
   # restoe backup
   echo -n "Restoring ioBroker from $selected_backup... "
   set +e
-  bash iobroker restore "$selected_backup" > /opt/iobroker/log/restore.log 2>&1
+  bash iobroker restore "$selected_backup" --force > /opt/iobroker/log/restore.log 2>&1
   return_value=$?
   set -e
 

debian12/scripts/setup_avahi.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 if [ -e /usr/sbin/avahi-daemon ] && [ -e /var/run/dbus ]
 then

debian12/scripts/setup_iob_db.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # reading env
 debug=$DEBUG

debian12/scripts/setup_packages.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # bash strict mode
 set -euo pipefail
@@ -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