build: Add root-user-action flag (#968)

Dockerfile

@@ -44,7 +44,7 @@ RUN set -eu && \
         netcat-openbsd \
         qemu-system-x86 && \
     apt-get clean && \
-    pip3 install --no-cache-dir --break-system-packages dissect.cstruct && \
+    pip3 install --no-cache-dir --break-system-packages --root-user-action=ignore dissect.cstruct && \
     mkdir -p /etc/qemu && \
     echo "allow br0" > /etc/qemu/bridge.conf && \
     unlink /etc/nginx/sites-enabled/default && \

readme.md

@@ -58,7 +58,7 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
 ##### Via Github Codespaces:
 
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?repo=619260050&machine=basicLinux32gb)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/vdsm/virtual-dsm)
 
 ## FAQ 💬
 
@@ -123,16 +123,15 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
 ### How do I pass-through a disk?
 
-   It is possible to pass-through a disk device directly, which can be useful when your host is a virtual machine, as it removes an extra layer and allows for easier image management on the host.
-   
-   For use with physical disks this method provides little advantage over using an image and is not recommended. You can add the device to your compose file like this:
+   It is possible to pass-through disk devices or partitions directly by adding them to your compose file in this way:
 
   ```yaml
   devices:
-    - /dev/sdc:/disk1
+    - /dev/sdb:/disk1
+    - /dev/sdc1:/disk2
   ```
 
-  Replace `/dev/sdc` with the name of the disk. It needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
+  Make sure it is totally empty (without any filesystem), otherwise DSM may not format it as a volume.
 
 ### How do I change the amount of CPU or RAM?
 

src/disk.sh

@@ -368,6 +368,8 @@ createDevice () {
   local DISK_FMT=$5
   local DISK_IO=$6
   local DISK_CACHE=$7
+  local DISK_SERIAL=$8
+  local DISK_SECTORS=$9
   local DISK_ID="data$DISK_INDEX"
 
   local index=""
@@ -381,29 +383,29 @@ createDevice () {
       ;;
     "usb" )
       result+=",if=none \
-      -device usb-storage,drive=${DISK_ID}${index}"
+      -device usb-storage,drive=${DISK_ID}${index}${DISK_SERIAL}${DISK_SECTORS}"
       echo "$result"
       ;;
     "nvme" )
       result+=",if=none \
-      -device nvme,drive=${DISK_ID}${index},serial=deadbeaf${DISK_INDEX}"
+      -device nvme,drive=${DISK_ID}${index},serial=deadbeaf${DISK_INDEX}${DISK_SERIAL}${DISK_SECTORS}"
       echo "$result"
       ;;
     "ide" | "sata" )
       result+=",if=none \
       -device ich9-ahci,id=ahci${DISK_INDEX},addr=$DISK_ADDRESS \
-      -device ide-hd,drive=${DISK_ID},bus=ahci$DISK_INDEX.0,rotation_rate=$DISK_ROTATION${index}"
+      -device ide-hd,drive=${DISK_ID},bus=ahci$DISK_INDEX.0,rotation_rate=$DISK_ROTATION${index}${DISK_SERIAL}${DISK_SECTORS}"
       echo "$result"
       ;;
     "blk" | "virtio-blk" )
       result+=",if=none \
-      -device virtio-blk-pci,drive=${DISK_ID},bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}"
+      -device virtio-blk-pci,drive=${DISK_ID},bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}${DISK_SERIAL}${DISK_SECTORS}"
       echo "$result"
       ;;
     "scsi" | "virtio-scsi" )
       result+=",if=none \
       -device virtio-scsi-pci,id=${DISK_ID}b,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2 \
-      -device scsi-hd,drive=${DISK_ID},bus=${DISK_ID}b.0,channel=0,scsi-id=0,lun=0,rotation_rate=$DISK_ROTATION${index}"
+      -device scsi-hd,drive=${DISK_ID},bus=${DISK_ID}b.0,channel=0,scsi-id=0,lun=0,rotation_rate=$DISK_ROTATION${index}${DISK_SERIAL}${DISK_SECTORS}"
       echo "$result"
       ;;
   esac
@@ -482,7 +484,7 @@ addDisk () {
 
   fi
 
-  DISK_OPTS+=$(createDevice "$DISK_FILE" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE")
+  DISK_OPTS+=$(createDevice "$DISK_FILE" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" "" "")
 
   return 0
 }
@@ -497,7 +499,26 @@ addDevice () {
   [ -z "$DISK_DEV" ] && return 0
   [ ! -b "$DISK_DEV" ] && error "Device $DISK_DEV cannot be found! Please add it to the 'devices' section of your compose file." && exit 55
 
-  DISK_OPTS+=$(createDevice "$DISK_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
+  local sectors=""
+  local result logical physical
+  result=$(fdisk -l "$DISK_DEV" | grep -m 1 -o "(logical/physical): .*" | cut -c 21-)
+  logical="${result%% *}"
+  physical=$(echo "$result" | grep -m 1 -o "/ .*" | cut -c 3-)
+  physical="${physical%% *}"
+
+  if [ -n "$physical" ]; then
+    if [[ "$physical" == "512" ]] || [[ "$physical" == "4096" ]]; then
+      if [[ "$physical" == "4096" ]]; then
+        sectors=",logical_block_size=$logical,physical_block_size=$physical"
+      fi
+    else
+      warn "Unknown physical sector size: $physical for $DISK_DEV"
+    fi
+  else
+    warn "Failed to determine the sector size for $DISK_DEV"
+  fi
+
+  DISK_OPTS+=$(createDevice "$DISK_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE" "" "$sectors")
 
   return 0
 }
@@ -529,8 +550,8 @@ else
   DISK_ALLOC="preallocation=falloc"
 fi
 
-DISK_OPTS+=$(createDevice "$BOOT" "$DISK_TYPE" "1" "0xa" "raw" "$DISK_IO" "$DISK_CACHE")
-DISK_OPTS+=$(createDevice "$SYSTEM" "$DISK_TYPE" "2" "0xb" "raw" "$DISK_IO" "$DISK_CACHE")
+DISK_OPTS+=$(createDevice "$BOOT" "$DISK_TYPE" "1" "0xa" "raw" "$DISK_IO" "$DISK_CACHE" "" "")
+DISK_OPTS+=$(createDevice "$SYSTEM" "$DISK_TYPE" "2" "0xb" "raw" "$DISK_IO" "$DISK_CACHE" "" "")
 
 DISK1_FILE="$STORAGE/${DISK_NAME}"
 if [[ ! -f "$DISK1_FILE.img" ]] && [[ -f "$STORAGE/data${DISK_SIZE}.img" ]]; then

src/install.sh

@@ -13,28 +13,30 @@ else
 fi
 
 FN="boot.pat"
-if [ -d "/$FN" ]; then
-  error "The file /$FN does not exist, please check that you mapped it to a valid path!" && exit 65
+DIR=$(find / -maxdepth 1 -type d -iname "$FN" | head -n 1)
+[ ! -d "$DIR" ] && DIR=$(find "$STORAGE" -maxdepth 1 -type d -iname "$FN" | head -n 1)
+
+if [ -d "$DIR" ]; then
+  BASE="DSM_VirtualDSM" && URL="file://$DIR" 
+  if [[ ! -s "$STORAGE/$BASE.boot.img" ]] || [[ ! -s "$STORAGE/$BASE.system.img" ]]; then
+    error "The bind $DIR maps to a file that does not exist!" && exit 65
+  fi
 fi
 
 FILE=$(find / -maxdepth 1 -type f -iname "$FN" | head -n 1)
 [ ! -s "$FILE" ] && FILE=$(find "$STORAGE" -maxdepth 1 -type f -iname "$FN" | head -n 1)
 [ -s "$FILE" ] && BASE="DSM_VirtualDSM" && URL="file://$FILE" 
 
-if [ -n "$URL" ]; then
-  if [ ! -s "$FILE" ]; then
-    BASE=$(basename "$URL" .pat)
-    if [ ! -s "$STORAGE/$BASE.system.img" ]; then
-      BASE=$(basename "${URL%%\?*}" .pat)
-      : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
-      BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
-    fi
+if [ -n "$URL" ] && [ ! -s "$FILE" ] && [ ! -d "$DIR" ]; then
+  BASE=$(basename "$URL" .pat)
+  if [ ! -s "$STORAGE/$BASE.system.img" ]; then
+    BASE=$(basename "${URL%%\?*}" .pat)
+    : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+    BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
   fi
   if [[ "${URL,,}" != "http"* ]] && [[ "${URL,,}" != "file:"* ]] ; then
-    URL="file:///$BASE.pat"
-    if [ ! -s "/$BASE.pat" ]; then
-      error "File '$BASE.pat' does not exist!" && exit 65
-    fi
+    [ ! -s "$STORAGE/$BASE.pat" ] && error "Invalid URL:  $URL" && exit 65
+    URL="file://$STORAGE/$BASE.pat"
   fi
 fi
 
@@ -268,12 +270,9 @@ mv "$HDA.tgz" "$HDA.txz"
 [ -d "$PKG" ] && mv "$PKG/" "$MOUNT/.SynoUpgradePackages/"
 rm -f "$MOUNT/.SynoUpgradePackages/ActiveInsight-"*
 
-[ -s "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
-
 if [ -s "$IDB.txz" ]; then
-  INDEX_DB="$MOUNT/usr/syno/synoman/indexdb/"
+  INDEX_DB="$MOUNT/usr/syno/synoman/indexdb"
   mkdir -p "$INDEX_DB"
-  tar xpfJ "$IDB.txz" --absolute-names -C "$INDEX_DB"
 fi
 
 LABEL="1.44.1-42218"
@@ -282,6 +281,8 @@ NUMBLOCKS="2097152" # (16777216 * 512) / 4096
 MSG="Installing system partition..."
 
 fakeroot -- bash -c "set -Eeu;\
+  [ -s $HDP.txz ] && tar xpfJ $HDP.txz --absolute-names -C $MOUNT/;\
+  [ -s $IDB.txz ] && tar xpfJ $IDB.txz --absolute-names -C $INDEX_DB/;\
   tar xpfJ $HDA.txz --absolute-names --skip-old-files -C $MOUNT/;\
   printf '%b%s%b' '\E[1;34m❯ \E[1;36m' 'Install: $MSG' '\E[0m\n';\
   mke2fs -q -t ext4 -b 4096 -d $MOUNT/ -L $LABEL -F -E offset=$OFFSET $SYSTEM $NUMBLOCKS"

src/network.sh

@@ -338,17 +338,17 @@ closeNetwork() {
 
 checkOS() {
 
-  local name
+  local kernel
   local os=""
   local if="macvlan"
-  name=$(uname -a)
+  kernel=$(uname -a)
 
-  [[ "${name,,}" == *"darwin"* ]] && os="Docker Desktop for macOS"
-  [[ "${name,,}" == *"microsoft"* ]] && os="Docker Desktop for Windows"
+  [[ "${kernel,,}" == *"darwin"* ]] && os="Docker Desktop for macOS"
+  [[ "${kernel,,}" == *"microsoft"* ]] && os="Docker Desktop for Windows"
 
   if [[ "$DHCP" == [Yy1]* ]]; then
     if="macvtap"
-    [[ "${name,,}" == *"synology"* ]] && os="Synology Container Manager"
+    [[ "${kernel,,}" == *"synology"* ]] && os="Synology Container Manager"
   fi
 
   if [ -n "$os" ]; then

src/proc.sh

@@ -37,14 +37,14 @@ if [[ "$KVM" != [Nn]* ]]; then
   KVM_ERR=""
 
   if [ ! -e /dev/kvm ]; then
-    KVM_ERR="(device file missing)"
+    KVM_ERR="(/dev/kvm is missing)"
   else
     if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
-      KVM_ERR="(no write access)"
+      KVM_ERR="(/dev/kvm is unwriteable)"
     else
       flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
       if ! grep -qw "vmx\|svm" <<< "$flags"; then
-        KVM_ERR="(vmx/svm disabled)"
+        KVM_ERR="(not enabled in BIOS)"
       fi
     fi
   fi
@@ -53,9 +53,17 @@ if [[ "$KVM" != [Nn]* ]]; then
     KVM="N"
     if [[ "$OSTYPE" =~ ^darwin ]]; then
       warn "you are using macOS which has no KVM support, this will cause a major loss of performance."
-    else
-      error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
-      error "See the FAQ on how to diagnose the cause, or continue without KVM by setting KVM=N (not recommended)."
+    else      
+      kernel=$(uname -a)
+      case "${kernel,,}" in
+        *"microsoft"* )
+          error "Please bind '/dev/kvm' as a volume in the optional container settings when using Docker Desktop." ;;
+        *"synology"* )
+          error "Please make sure that Synology VMM (Virtual Machine Manager) is installed and that '/dev/kvm' is binded to this container." ;;
+        *)
+          error "KVM acceleration is not available $KVM_ERR, this will cause a major loss of performance."
+          error "See the FAQ for possible causes, or continue without it by adding KVM: \"N\" (not recommended)." ;;
+      esac
       [[ "$DEBUG" != [Yy1]* ]] && exit 88
     fi
   fi