feat: Network mode detection (#1036)

Refactor CPU string processing to remove 'th Gen' suffix.

.github/workflows/check.yml

@@ -17,7 +17,7 @@ jobs:
           SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2034 -e SC2064 -e SC2317 -e SC2153 -e SC2028
       - 
         name: Lint Dockerfile
-        uses: hadolint/hadolint-action@v3.2.0
+        uses: hadolint/hadolint-action@v3.3.0
         with:
           dockerfile: Dockerfile
           ignore: DL3008,DL3003,DL3006,DL3013

Dockerfile

@@ -28,6 +28,7 @@ RUN set -eu && \
         unzip \
         nginx \
         procps \
+        ethtool \
         python3 \
         python3-pip \
         python3-msgpack \
@@ -57,7 +58,7 @@ RUN set -eu && \
 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
+COPY --chmod=744 ./web/conf/nginx.conf /etc/nginx/default.conf
 ADD --chmod=775 https://raw.githubusercontent.com/sud0woodo/patology/refs/heads/main/patology.py /run/extract.py
 
 VOLUME /storage
@@ -65,7 +66,7 @@ EXPOSE 22 139 445 5000
 
 ENV RAM_SIZE="2G"
 ENV CPU_CORES="2"
-ENV DISK_SIZE="16G"
+ENV DISK_SIZE="256G"
 
 HEALTHCHECK --interval=60s --start-period=45s --retries=2 CMD /run/check.sh
 

compose.yml

@@ -3,7 +3,7 @@ services:
     container_name: dsm
     image: vdsm/virtual-dsm
     environment:
-      DISK_SIZE: "16G"
+      DISK_SIZE: "256G"
     devices:
       - /dev/kvm
       - /dev/net/tun

kubernetes.yml

@@ -8,7 +8,7 @@ spec:
   - ReadWriteOnce
   resources:
     requests:
-      storage: 16Gi
+      storage: 256Gi
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -31,7 +31,7 @@ spec:
         image: vdsm/virtual-dsm
         env:
         - name: DISK_SIZE
-          value: "16G"
+          value: "256G"
         ports:
           - containerPort: 5000
             name: http

readme.md

@@ -30,7 +30,7 @@ services:
     container_name: dsm
     image: vdsm/virtual-dsm
     environment:
-      DISK_SIZE: "16G"
+      DISK_SIZE: "256G"
     devices:
       - /dev/kvm
       - /dev/net/tun
@@ -47,7 +47,7 @@ services:
 ##### Via Docker CLI:
 
 ```bash
-docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/dsm:/storage" --stop-timeout 120 vdsm/virtual-dsm
+docker run -it --rm --name dsm -e "DISK_SIZE=256G" -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/dsm:/storage" --stop-timeout 120 vdsm/virtual-dsm
 ```
 
 ##### Via Kubernetes:
@@ -87,35 +87,24 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
  
 ### How do I change the size of the disk?
 
-  To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
+  To expand the default size of 256 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
 
   ```yaml
   environment:
-    DISK_SIZE: "128G"
+    DISK_SIZE: "512G"
   ```
   
 > [!TIP]
 > This can also be used to resize the existing disk to a larger capacity without any data loss.
 
-### How do I create a growable disk?
-
-  By default, the entire capacity of the disk will be reserved in advance.
-
-  To create a growable disk that only allocates space that is actually used, add the following environment variable:
-
-  ```yaml
-  environment:
-    DISK_FMT: "qcow2"
-  ```
-
 ### How do I add multiple disks?
 
   To create additional disks, modify your compose file like this:
   
   ```yaml
   environment:
-    DISK2_SIZE: "32G"
-    DISK3_SIZE: "64G"
+    DISK2_SIZE: "500G"
+    DISK3_SIZE: "750G"
   volumes:
     - ./example2:/storage2
     - ./example3:/storage3
@@ -263,14 +252,6 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   There are only two minor differences: the Virtual Machine Manager package is not available, and Surveillance Station will not include any free licenses.
 
-### How do I run Windows in a container?
-
-  You can use [dockur/windows](https://github.com/dockur/windows) for that. It shares many of the same features, and even has completely automatic installation.
-
-### How do I run a Linux desktop in a container?
-
-  You can use [qemus/qemu](https://github.com/qemus/qemu) in that case.
-
 ### Is this project legal?
 
   Yes, this project contains only open-source code and does not distribute any copyrighted material. Neither does it try to circumvent any copyright protection measures. So under all applicable laws, this project will be considered legal. 

src/disk.sh

@@ -507,12 +507,11 @@ addDevice () {
   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"
+    if [[ "$physical" != "512" ]]; then
+      sectors=",logical_block_size=$logical,physical_block_size=$physical"
+      if [[ "$physical" != "4096" && "$physical" != "32768" ]]; then
+        warn "Unknown physical sector size: $physical for $DISK_DEV"
       fi
-    else
-      warn "Unknown physical sector size: $physical for $DISK_DEV"
     fi
   else
     warn "Failed to determine the sector size for $DISK_DEV"
@@ -535,11 +534,7 @@ case "${DISK_TYPE,,}" in
 esac
 
 if [ -z "$ALLOCATE" ]; then
-  if [[ "${DISK_FMT,,}" == "raw" ]]; then
-    ALLOCATE="Y"
-  else
-    ALLOCATE="N"
-  fi
+  ALLOCATE="N"
 fi
 
 if [[ "$ALLOCATE" == [Nn]* ]]; then
@@ -554,7 +549,7 @@ DISK_OPTS+=$(createDevice "$BOOT" "$DISK_TYPE" "1" "0xa" "raw" "$DISK_IO" "$DISK
 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
+if [ ! -f "$DISK1_FILE.img" ] && [ -f "$STORAGE/data${DISK_SIZE}.img" ]; then
   # Fallback for legacy installs
   mv "$STORAGE/data${DISK_SIZE}.img" "$DISK1_FILE.img"
 fi

src/network.sh

@@ -67,6 +67,7 @@ configureDHCP() {
 
   while ! ip link set "$VM_NET_TAP" up; do
     info "Waiting for MAC address $VM_NET_MAC to become available..."
+    info "If you cloned this machine, please delete the 'dsm.mac' file to generate a different MAC address."
     sleep 2
   done
 
@@ -172,7 +173,7 @@ getUserPorts() {
 
 getHostPorts() {
 
-  local list=$1
+  local list="$1"
 
   [ -z "$list" ] && echo "" && return 0
 
@@ -392,6 +393,32 @@ getInfo() {
     error "$ADD_ERR -e \"VM_NET_DEV=NAME\" to specify another interface name." && exit 26
   fi
 
+  local result nic bus
+  result=$(ethtool -i "$VM_NET_DEV")
+  nic=$(grep -m 1 -i 'driver:' <<< "$result" | awk '{print $(2)}')
+  bus=$(grep -m 1 -i 'bus-info:' <<< "$result" | awk '{print $(2)}')
+
+  if [[ "${bus,,}" != "" && "${bus,,}" != "n/a" ]]; then
+    [[ "$DEBUG" == [Yy1]* ]] && info "Detected BUS: $bus"
+    error "This container does not support host mode networking!"
+    exit 29
+  fi
+
+  if [[ "$DHCP" == [Yy1]* ]]; then
+
+    if [[ "${nic,,}" == "ipvlan" ]]; then
+      error "This container does not support IPVLAN networking when DHCP=Y."
+      exit 29
+    fi
+
+    if [[ "${nic,,}" != "macvlan" ]]; then
+      [[ "$DEBUG" == [Yy1]* ]] && info "Detected NIC: $nic"
+      error "The container needs to be in a MACVLAN network when DHCP=Y."
+      exit 29
+    fi
+
+  fi
+
   BASE_IP="${VM_NET_IP%.*}."
 
   if [ "${VM_NET_IP/$BASE_IP/}" -lt "3" ]; then
@@ -488,10 +515,6 @@ if [[ "$DHCP" == [Yy1]* ]]; then
 
   checkOS
 
-  if [[ "$IP" == "172."* ]]; then
-    warn "container IP starts with 172.* which is often a sign that you are not on a macvlan network (required for DHCP)!"
-  fi
-
   # Configure for macvtap interface
   configureDHCP || exit 20
 
@@ -526,7 +549,7 @@ else
         msg="podman detected, $msg"
       fi
       warn "$msg"
-      [ -z "$USER_PORTS" ] && info "Notice: port mapping will not work without \"USER_PORTS\" now."
+      [ -z "$USER_PORTS" ] && info "Notice: when you want to expose ports in this mode, map them using this variable: \"USER_PORTS=5000,5001\"."
 
     fi
 

src/proc.sh

@@ -7,7 +7,6 @@ set -Eeuo pipefail
 : "${HOST_CPU:=""}"
 : "${CPU_FLAGS:=""}"
 : "${CPU_MODEL:=""}"
-: "${DEF_MODEL:="qemu64"}"
 
 CLOCKSOURCE="tsc"
 [[ "${ARCH,,}" == "arm64" ]] && CLOCKSOURCE="arch_sys_counter"
@@ -27,9 +26,13 @@ else
   esac
 fi
 
-if [[ "${ARCH,,}" != "amd64" ]]; then
-  KVM="N"
-  warn "your CPU architecture is ${ARCH^^} and cannot provide KVM acceleration for x64 instructions, this will cause a major loss of performance."
+if [[ "$KVM" == [Nn]* ]]; then
+  warn "KVM acceleration is disabled, this will cause the machine to run about 10 times slower!"
+else
+  if [[ "${ARCH,,}" != "amd64" ]]; then
+    KVM="N"
+    warn "your CPU architecture is ${ARCH^^} and cannot provide KVM acceleration for x64 instructions, so the machine will run about 10 times slower."
+  fi
 fi
 
 if [[ "$KVM" != [Nn]* ]]; then
@@ -52,7 +55,7 @@ if [[ "$KVM" != [Nn]* ]]; then
   if [ -n "$KVM_ERR" ]; 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."
+      warn "you are using macOS which has no KVM support, so the machine will run about 10 times slower."
     else
       kernel=$(uname -a)
       case "${kernel,,}" in
@@ -61,8 +64,8 @@ if [[ "$KVM" != [Nn]* ]]; then
         *"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)." ;;
+          error "KVM acceleration is not available $KVM_ERR, this will cause the machine to run about 10 times slower."
+          error "See the FAQ for possible causes, or disable acceleration by adding the \"KVM=N\" variable (not recommended)." ;;
       esac
       [[ "$DEBUG" != [Yy1]* ]] && exit 88
     fi
@@ -77,7 +80,7 @@ if [[ "$KVM" != [Nn]* ]]; then
 
   if ! grep -qw "sse4_2" <<< "$flags"; then
     info "Your CPU does not have the SSE4 instruction set that Virtual DSM requires, it will be emulated..."
-    [ -z "$CPU_MODEL" ] && CPU_MODEL="$DEF_MODEL"
+    [ -z "$CPU_MODEL" ] && CPU_MODEL="qemu64"
     CPU_FEATURES+=",+ssse3,+sse4.1,+sse4.2"
   fi
 
@@ -120,7 +123,7 @@ else
       CPU_MODEL="max"
       CPU_FEATURES+=",migratable=no"
     else
-      CPU_MODEL="$DEF_MODEL"
+      CPU_MODEL="qemu64"
     fi
   fi
 

src/reset.sh

@@ -48,6 +48,8 @@ else
   SOCKETS=$(lscpu | grep -m 1 -i 'socket(s)' | awk '{print $(2)}')
 fi
 
+CPU_CORES="${CPU_CORES// /}"
+[[ "${CPU_CORES,,}" == "max" ]] && CPU_CORES="$CORES"
 [ -n "${CPU_CORES//[0-9 ]}" ] && error "Invalid amount of CPU_CORES: $CPU_CORES" && exit 15
 
 if [ "$CPU_CORES" -gt "$CORES" ]; then
@@ -94,6 +96,12 @@ RAM_TOTAL=$(free -b | grep -m 1 Mem: | awk '{print $2}')
 RAM_SIZE="${RAM_SIZE// /}"
 [ -z "$RAM_SIZE" ] && error "RAM_SIZE not specified!" && exit 16
 
+if [[ "${RAM_SIZE,,}" == "max" ]]; then
+  RAM_WANTED=$(( RAM_AVAIL - RAM_SPARE - RAM_SPARE ))
+  RAM_WANTED=$(( RAM_WANTED / 1073741825 ))
+  RAM_SIZE="${RAM_WANTED}G"
+fi
+
 if [ -z "${RAM_SIZE//[0-9. ]}" ]; then
   [ "${RAM_SIZE%%.*}" -lt "130" ] && RAM_SIZE="${RAM_SIZE}G" || RAM_SIZE="${RAM_SIZE}M"
 fi
@@ -194,19 +202,22 @@ addPackage() {
   return 0
 }
 
+: "${WEB_PORT:="5000"}"    # Webserver port
+
 cp -r /var/www/* /run/shm
 html "Starting $APP for Docker..."
 
 if [[ "${WEB:-}" != [Nn]* ]]; then
 
+  mkdir -p /etc/nginx/sites-enabled
+  cp /etc/nginx/default.conf /etc/nginx/sites-enabled/web.conf
+
+  sed -i "s/listen 5000 default_server;/listen $WEB_PORT default_server;/g" /etc/nginx/sites-enabled/web.conf
+  
   # shellcheck disable=SC2143
   if [ -f /proc/net/if_inet6 ] && [ -n "$(ifconfig -a | grep inet6)" ]; then
 
-    sed -i "s/listen 5000 default_server;/listen [::]:5000 default_server ipv6only=off;/g" /etc/nginx/sites-enabled/web.conf
-
-  else
-
-    sed -i "s/listen [::]:5000 default_server ipv6only=off;/listen 5000 default_server;/g" /etc/nginx/sites-enabled/web.conf
+    sed -i "s/listen $WEB_PORT default_server;/listen [::]:$WEB_PORT default_server ipv6only=off;/g" /etc/nginx/sites-enabled/web.conf
 
   fi
   

src/utils.sh

@@ -126,8 +126,8 @@ cpu() {
   cpu="${cpu// [0-9] Core}"
   cpu="${cpu// [0-9][0-9] Core}"
   cpu="${cpu// [0-9][0-9][0-9] Core}"
-  cpu="${cpu// [0-9]th Gen}"
-  cpu="${cpu// [0-9][0-9]th Gen}"
+  cpu="${cpu//[0-9]th Gen }"
+  cpu="${cpu//[0-9][0-9]th Gen }"
   cpu="${cpu// Processor/}"
   cpu="${cpu// Quad core/}"
   cpu="${cpu// Dual core/}"