Update install.sh

.github/workflows/check.yml

@@ -20,5 +20,5 @@ jobs:
         uses: hadolint/hadolint-action@v3.1.0
         with:
           dockerfile: Dockerfile
-          ignore: DL3008,DL3003,DL3006,DL3013
+          ignore: DL3008,DL3003,DL3006
           failure-threshold: warning

Dockerfile

@@ -15,12 +15,13 @@ ARG DEBCONF_NOWARNINGS="yes"
 ARG DEBIAN_FRONTEND="noninteractive"
 ARG DEBCONF_NONINTERACTIVE_SEEN="true"
 
-RUN set -eu && \
+RUN set -eu && extra="" && \
     apt-get update && \
     apt-get --no-install-recommends -y install \
         jq \
         tini \
         curl \
+        cpio \
         wget \
         fdisk \
         unzip \
@@ -44,7 +45,7 @@ RUN set -eu && \
         netcat-openbsd \
         qemu-system-x86 && \
     apt-get clean && \
-    pip3 install --no-cache-dir --break-system-packages --root-user-action=ignore dissect.cstruct && \
+    pip3 install --no-cache-dir --break-system-packages dissect.cstruct && \
     mkdir -p /etc/qemu && \
     echo "allow br0" > /etc/qemu/bridge.conf && \
     unlink /etc/nginx/sites-enabled/default && \
@@ -56,7 +57,8 @@ COPY --chmod=755 ./src /run/
 COPY --chmod=755 ./web /var/www/
 COPY --chmod=755 --from=builder /qemu-host.bin /run/host.bin
 COPY --chmod=744 ./web/conf/nginx.conf /etc/nginx/sites-enabled/web.conf
-ADD --chmod=775 https://raw.githubusercontent.com/sud0woodo/patology/refs/heads/main/patology.py /run/extract.py
+
+ADD https://raw.githubusercontent.com/sud0woodo/patology/refs/heads/main/patology.py /run/patology.py
 
 VOLUME /storage
 EXPOSE 22 139 445 5000

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://codespaces.new/vdsm/virtual-dsm)
+[`Click here to launch this container in the cloud!`](https://github.com/codespaces/new?skip_quickstart=true&machine=basicLinux32gb&repo=619260050&ref=master&devcontainer_path=.devcontainer.json)
 
 ## FAQ 💬
 
@@ -123,15 +123,21 @@ 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 disk devices or partitions directly by adding them to your compose file in this way:
+   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 management. For use with physical disks this method provides little advantage and is not recommended.
+   
+   You can add the virtual device to your compose file like this:
 
   ```yaml
   devices:
-    - /dev/sdb:/disk1
-    - /dev/sdc1:/disk2
+    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/disk2
   ```
 
-  Make sure it is totally empty (without any filesystem), otherwise DSM may not format it as a volume.
+  The device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
+  
+  Make sure to bind the disk via its UUID (obtainable via `lsblk -o name,uuid`) instead of its name (`/dev/sdc`), to prevent ever binding the wrong disk when the drive letters happen to change. 
+ 
+> [!CAUTION]
+> Do NOT use this feature with the goal of sharing files from the host, they might all get lost without warning when DSM creates the volume.
 
 ### How do I change the amount of CPU or RAM?
 
@@ -250,14 +256,14 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   With this method, it is even possible to switch back and forth between versions while keeping your file data intact.
 
-  Alternatively, you can also skip the download and use a local file instead, by binding it in your compose file in this way:
-  
+  If you don't have internet access, it's also possible to skip the download by setting `URL` to:
+
   ```yaml
-  volumes:
-    - ./DSM_VirtualDSM_42218.pat:/boot.pat
+  environment:
+    URL: "DSM_VirtualDSM_42218.pat"
   ```
 
-  Replace the example path `./DSM_VirtualDSM_42218.pat` with the filename of your desired `.pat` file. The value of `URL` will be ignored in this case.
+  after placing a copy of [DSM_VirtualDSM_42218.pat](https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat) in the root of your `/storage` folder.
 
 ### What are the differences compared to the standard DSM?
 

src/disk.sh

@@ -368,8 +368,6 @@ 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=""
@@ -383,29 +381,29 @@ createDevice () {
       ;;
     "usb" )
       result+=",if=none \
-      -device usb-storage,drive=${DISK_ID}${index}${DISK_SERIAL}${DISK_SECTORS}"
+      -device usb-storage,drive=${DISK_ID}${index}"
       echo "$result"
       ;;
     "nvme" )
       result+=",if=none \
-      -device nvme,drive=${DISK_ID}${index},serial=deadbeaf${DISK_INDEX}${DISK_SERIAL}${DISK_SECTORS}"
+      -device nvme,drive=${DISK_ID}${index},serial=deadbeaf${DISK_INDEX}"
       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}${DISK_SERIAL}${DISK_SECTORS}"
+      -device ide-hd,drive=${DISK_ID},bus=ahci$DISK_INDEX.0,rotation_rate=$DISK_ROTATION${index}"
       echo "$result"
       ;;
     "blk" | "virtio-blk" )
       result+=",if=none \
-      -device virtio-blk-pci,drive=${DISK_ID},bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}${DISK_SERIAL}${DISK_SECTORS}"
+      -device virtio-blk-pci,drive=${DISK_ID},bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}"
       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}${DISK_SERIAL}${DISK_SECTORS}"
+      -device scsi-hd,drive=${DISK_ID},bus=${DISK_ID}b.0,channel=0,scsi-id=0,lun=0,rotation_rate=$DISK_ROTATION${index}"
       echo "$result"
       ;;
   esac
@@ -484,7 +482,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
 }
@@ -499,26 +497,7 @@ 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
 
-  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")
+  DISK_OPTS+=$(createDevice "$DISK_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
 
   return 0
 }
@@ -550,8 +529,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

@@ -12,31 +12,19 @@ else
   BASE="DSM_VirtualDSM_42962"
 fi
 
-FN="boot.pat"
-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" ] && [ ! -s "$FILE" ] && [ ! -d "$DIR" ]; then
+if [ -n "$URL" ]; 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
-    [ ! -s "$STORAGE/$BASE.pat" ] && error "Invalid URL:  $URL" && exit 65
-    URL="file://$STORAGE/$BASE.pat"
+  if [[ "${URL,,}" != "http"* ]]; then
+    if [ -s "$STORAGE/$BASE.pat" ]; then
+      URL="file://$STORAGE/$BASE.pat"
+    else
+      error "File $STORAGE/$BASE.pat does not exist!" && exit 65
+    fi
   fi
 fi
 
@@ -63,11 +51,9 @@ if [ -z "$URL" ]; then
   URL="$DL/release/7.2.2/72806/DSM_VirtualDSM_72806.pat"
 fi
 
-if [ ! -s "$FILE" ]; then
-  BASE=$(basename "${URL%%\?*}" .pat)
-  : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
-  BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
-fi
+BASE=$(basename "${URL%%\?*}" .pat)
+: "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
 
 if [[ "$URL" != "file://$STORAGE/$BASE.pat" ]]; then
   rm -f "$STORAGE/$BASE.pat"
@@ -128,15 +114,10 @@ else
   PROGRESS="--progress=dot:giga"
 fi
 
-if [[ "$URL" == "file://"* ]]; then
-  MSG="Copying DSM"
-  ERR="Failed to copy ${URL:7}"
-  info "Install: Copying installation image..."
-else
-  MSG="Downloading DSM"
-  ERR="Failed to download $URL"
-  info "Install: Downloading $BASE.pat..."
-fi
+info "Install: Downloading $BASE.pat..."
+
+MSG="Downloading DSM"
+ERR="Failed to download $URL"
 
 html "$MSG..."
 
@@ -145,10 +126,6 @@ rm -f "$PAT"
 
 if [[ "$URL" == "file://"* ]]; then
 
-  if [ ! -f "${URL:7}" ]; then
-    error "File '${URL:7}' does not exist!" && exit 65
-  fi
-
   cp "${URL:7}" "$PAT"
 
 else
@@ -179,7 +156,7 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
-MSG="Extracting installation image..."
+MSG="Extracting downloaded image..."
 info "Install: $MSG" && html "$MSG"
 
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
@@ -188,18 +165,16 @@ if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
 else
 
-  { (cd "$TMP" && python3 /run/extract.py -i "$PAT" -d 2>/run/extract.log); rc=$?; } || :
-
-  if (( rc != 0 )); then
-    cat /run/extract.log
-    error "Failed to extract PAT file, reason $rc" && exit 63
-  fi
+  { (cd "$TMP" && python3 /run/patology.py -i "$PAT" -d >/dev/null); rc=$?; } || :
+  (( rc != 0 )) && error "Failed to extract PAT file, reason $rc" && exit 63
 
 fi
 
 MSG="Preparing system partition..."
 info "Install: $MSG" && html "$MSG"
 
+ls -lh $TMP
+
 BOOT=$(find "$TMP" -name "*.bin.zip")
 [ ! -s "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
 
@@ -270,9 +245,12 @@ 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"
@@ -280,12 +258,22 @@ OFFSET="1048576"    # 2048 * 512
 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"
+if [[ "$ROOT" != [Nn]* ]]; then
+
+  tar xpfJ "$HDA.txz" --absolute-names --skip-old-files -C "$MOUNT/"
+
+  info "Install: $MSG" && html "$MSG"
+
+  mke2fs -q -t ext4 -b 4096 -d "$MOUNT/" -L "$LABEL" -F -E "offset=$OFFSET" "$SYSTEM" "$NUMBLOCKS"
+
+else
+
+  fakeroot -- bash -c "set -Eeu;\
+        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"
+
+fi
 
 rm -rf "$MOUNT"
 echo "$BASE" > "$STORAGE/dsm.ver"

src/network.sh

@@ -338,17 +338,17 @@ closeNetwork() {
 
 checkOS() {
 
-  local kernel
+  local name
   local os=""
   local if="macvlan"
-  kernel=$(uname -a)
+  name=$(uname -a)
 
-  [[ "${kernel,,}" == *"darwin"* ]] && os="Docker Desktop for macOS"
-  [[ "${kernel,,}" == *"microsoft"* ]] && os="Docker Desktop for Windows"
+  [[ "${name,,}" == *"darwin"* ]] && os="Docker Desktop for macOS"
+  [[ "${name,,}" == *"microsoft"* ]] && os="Docker Desktop for Windows"
 
   if [[ "$DHCP" == [Yy1]* ]]; then
     if="macvtap"
-    [[ "${kernel,,}" == *"synology"* ]] && os="Synology Container Manager"
+    [[ "${name,,}" == *"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="(/dev/kvm is missing)"
+    KVM_ERR="(device file missing)"
   else
     if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
-      KVM_ERR="(/dev/kvm is unwriteable)"
+      KVM_ERR="(no write access)"
     else
       flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
       if ! grep -qw "vmx\|svm" <<< "$flags"; then
-        KVM_ERR="(not enabled in BIOS)"
+        KVM_ERR="(vmx/svm disabled)"
       fi
     fi
   fi
@@ -53,17 +53,9 @@ 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      
-      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
+    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)."
       [[ "$DEBUG" != [Yy1]* ]] && exit 88
     fi
   fi