feat: New disk pass-through method (#714)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.dockerignore

@@ -6,7 +6,10 @@
 .gitmodules
 Dockerfile
 Dockerfile.archive
+compose.yml
+compose.yaml
 docker-compose.yml
+docker-compose.yaml
 
 *.md
 

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -0,0 +1,64 @@
+name: "\U0001F41E Bug Report"
+description: Create a report to help us improve the container
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+      - label: I have searched the existing issues
+        required: true
+  - type: input
+    id: cpu
+    attributes:
+      label: Machine specifications
+      description: The processor and RAM amount in your machine.
+      placeholder: e.g. Intel N5105 / 16 GB 
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: The Linux distribution and kernel version as shown by `uname -a`.
+      placeholder: e.g. Ubuntu 24.04 / Kernel 6.8.0-22-generic
+    validations:
+      required: true
+  - type: input
+    id: docker
+    attributes:
+      label: Docker version
+      description: The Docker version as shown by `docker -v`.
+      placeholder: e.g. Docker version 26.0.1, build d260a54
+    validations:
+      required: true
+  - type: textarea
+    id: summary
+    attributes:
+      label: Description
+      description: A clear and concise description of the problem.
+    validations:
+      required: true
+  - type: textarea
+    id: compose
+    attributes:
+      label: Docker compose
+      description: The Docker compose file (or otherwise `run` command).
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Docker log
+      description: The Docker logfile of the container.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: Screenshots (optional)
+      description: Screenshots of the problem.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

@@ -0,0 +1,44 @@
+name: "\U0001F680 Feature request"
+description: Suggest an idea for improving the container
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing feature request for this?
+      description: Please search to see if the feature request already exists.
+      options:
+      - label: I have searched the existing feature requests
+        required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your proposal related to a problem?
+      description: |
+        Provide a clear and concise description of what the problem is.
+        For example, "I'm always frustrated when..."
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like.
+      description: |
+        Provide a clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered.
+      description: |
+        Let us know about other solutions you've tried or researched.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: |
+        Is there anything else you can add about the proposal?
+        You might want to link to related issues here, if you haven't already.

.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -0,0 +1,16 @@
+name: "? Question"
+description: General questions about the container
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please do not use this form for technical issues, and make sure to check the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md) first!
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What's the question you have about the container?
+    validations:
+      required: true

.github/workflows/build.yml

@@ -8,6 +8,10 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.yml'
+      - '**/*.js'
+      - '**/*.css'
+      - '**/*.html'
+      - 'web/**'
       - '.gitignore'
       - '.dockerignore'
       - '.github/**'
@@ -74,7 +78,7 @@ jobs:
           context: .
           push: true
           provenance: false
-          platforms: linux/amd64,linux/arm64,linux/arm
+          platforms: linux/amd64,linux/arm64
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           annotations: ${{ steps.meta.outputs.annotations }}
@@ -99,3 +103,15 @@ jobs:
           url: ${{ secrets.GITLAB_URL }}
           token: ${{ secrets.GITLAB_TOKEN }}
           username: ${{ secrets.GITLAB_USERNAME }}
+      -
+        name: Send mail
+        uses: action-pack/send-mail@v1
+        with:
+          to: ${{secrets.MAILTO}}
+          from: Github Actions <${{secrets.MAILTO}}>
+          connection_url: ${{secrets.MAIL_CONNECTION}}
+          subject: Build of ${{ github.event.repository.name }} v${{ steps.meta.outputs.version }} completed
+          body: |
+              The build job of ${{ github.event.repository.name }} v${{ steps.meta.outputs.version }} was completed successfully! 
+              
+              See https://github.com/${{ github.repository }}/actions for more information.

.github/workflows/check.yml

@@ -7,8 +7,18 @@ jobs:
     name: shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - 
-      - name: Run ShellCheck
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master
-env:
+        env:
-        SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2002 -e SC2223 -e SC2034 -e SC2064 -e SC2317 -e SC2028 -e SC2153 -e SC2004 
+          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.1.0
+        with:
+          dockerfile: Dockerfile
+          ignore: DL3008,DL3003,DL3006
+          failure-threshold: warning

.github/workflows/hub.yml

@@ -15,7 +15,7 @@ jobs:
     - uses: actions/checkout@v4
     - 
       name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v3
+      uses: peter-evans/dockerhub-description@v4
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_TOKEN }}

.github/workflows/test.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     paths:
       - '**/*.sh'
+      - 'Dockerfile'
       - '.github/workflows/test.yml'
       - '.github/workflows/check.yml'
 

Dockerfile

@@ -1,8 +1,8 @@
-FROM qemux/qemu-host as builder
+FROM qemux/qemu-host:2.04 as builder
 
 #  FROM golang as builder
 #  WORKDIR /
-#  RUN git clone https://github.com/qemu-tools/qemu-host.git
+#  RUN git clone https://github.com/qemus/qemu-host.git
 #  WORKDIR /qemu-host/src
 #  RUN go mod download
 #  RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o /qemu-host.bin .
@@ -10,12 +10,13 @@ FROM qemux/qemu-host as builder
 FROM debian:trixie-slim
 
 ARG TARGETPLATFORM
-ARG DEBCONF_NOWARNINGS="yes"
+ARG DEBCONF_NOWARNINGS "yes"
-ARG DEBIAN_FRONTEND noninteractive
+ARG DEBIAN_FRONTEND "noninteractive"
+ARG DEBCONF_NONINTERACTIVE_SEEN "true"
 
-RUN apt-get update && apt-get -y upgrade \
+RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi && \
-    && if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
+    apt-get update && \
-    && apt-get --no-install-recommends -y install \
+    apt-get --no-install-recommends -y install \
         jq \
         tini \
         curl \
@@ -23,38 +24,40 @@ RUN apt-get update && apt-get -y upgrade \
         wget \
         fdisk \
         unzip \
-        socat \
+        nginx \
         procps \
         xz-utils \
         iptables \
         iproute2 \
+        apt-utils \
         dnsmasq \
+        fakeroot \
         net-tools \
         qemu-utils \
         ca-certificates \
         netcat-openbsd \
         qemu-system-x86 \
-        "$extra" \
+        "$extra" && \
-    && apt-get clean \
+    apt-get clean && \
-    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+    unlink /etc/nginx/sites-enabled/default && \
+    sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 COPY ./src /run/
+COPY ./web /var/www/
 COPY --from=builder /qemu-host.bin /run/host.bin
+
 RUN chmod +x /run/*.sh && chmod +x /run/*.bin
+RUN mv /var/www/nginx.conf /etc/nginx/sites-enabled/web.conf 
 
 VOLUME /storage
-
+EXPOSE 22 139 445 5000
-EXPOSE 22
-EXPOSE 80
-EXPOSE 139
-EXPOSE 445
-EXPOSE 5000
 
 ENV RAM_SIZE "1G"
 ENV DISK_SIZE "16G"
 ENV CPU_CORES "1"
 
-ARG VERSION_ARG="0.0"
+ARG VERSION_ARG "0.0"
 RUN echo "$VERSION_ARG" > /run/version
 
 HEALTHCHECK --interval=60s --start-period=45s --retries=2 CMD /run/check.sh

agent/agent.sh

@@ -1,140 +0,0 @@
-#!/usr/bin/env bash
-set -u
-
-VERSION="9"
-HEADER="VirtualDSM Agent"
-
-# Functions
-
-error () { echo -e "\E[1;31m❯ ERROR: $1\E[0m" ; }
-info () { echo -e "\E[1;34m❯\E[1;36m $1\E[0m" ; }
-
-finish() {
-
-  echo "❯ $HEADER: Shutting down.."
-  exit
-
-}
-
-function checkNMI {
-
-  local nmi
-  nmi=$(cat /proc/interrupts | grep NMI | sed 's/[^1-9]*//g')
-
-  if [ "$nmi" != "" ]; then
-
-    info "Received shutdown request through NMI.."
-
-    /usr/syno/sbin/synoshutdown -s > /dev/null
-    finish
-
-  fi
-}
-
-function downloadUpdate {
-
-  TMP="/tmp/agent.sh"
-  rm -f "${TMP}"
-
-  # Auto update the agent
-
-  URL="https://raw.githubusercontent.com/vdsm/virtual-dsm/master/agent/agent.sh"
-  
-  remote_size=$(curl -sIk -m 4 "${URL}" | grep -i "content-length:" | tr -d " \t" | cut -d ':' -f 2)
-  remote_size=${remote_size//$'\r'}
-
-  [[ "$remote_size" == "" || "$remote_size" == "0" ]] && return
-
-  remote_size=$(($remote_size+0))
-  ((remote_size<100)) && return
-
-  SCRIPT=$(readlink -f "${BASH_SOURCE[0]}")
-  local_size=$(stat -c%s "$SCRIPT")
-  local_size=$(($local_size+0))
-
-  [[ remote_size -eq local_size ]] && return
-
-  if ! curl -sfk -m 10 -o "${TMP}" "${URL}"; then
-    error "$HEADER: curl error ($?)" && return
-  fi
-
-  if [ ! -f "${TMP}" ]; then
-    error "$HEADER: update error, file not found.." && return
-  fi
-
-  line=$(head -1 "${TMP}")
-
-  if [[ "$line" != "#!/usr/bin/env bash" ]]; then
-    error "$HEADER: update error, invalid header: $line" && return
-  fi
-
-  if cmp --silent -- "${TMP}" "${SCRIPT}"; then
-    error "$HEADER: update file is already equal? (${local_size} / ${remote_size})" && return
-  fi
-
-  mv -f "${TMP}" "${SCRIPT}"
-  chmod 755 "${SCRIPT}"
-
-  info "$HEADER: succesfully installed update..."
-
-}
-
-function installPackages {
-
-  for filename in /usr/local/packages/*.spk; do
-    if [ -f "$filename" ]; then
-
-      BASE=$(basename "$filename" .spk)
-      BASE="${BASE%%-*}"
-
-      [[ $BASE == "ActiveInsight" ]] && continue
-
-      info "Installing package ${BASE}.."
-
-      /usr/syno/bin/synopkg install "$filename" > /dev/null
-      /usr/syno/bin/synopkg start "$BASE" > /dev/null &
-
-      rm "$filename"
-
-    fi
-  done
-
-}
-
-trap finish SIGINT SIGTERM
-
-ts=$(date +%s%N)
-
-echo ""
-echo "❯ Started $HEADER v$VERSION..."
-
-checkNMI
-
-# Install packages 
-
-first_run=false
-
-for filename in /usr/local/packages/*.spk; do
-  if [ -f "$filename" ]; then
-    first_run=true
-  fi
-done
-
-if [ "$first_run" = true ]; then
-
-  installPackages
-
-else
-
-  downloadUpdate
-
-fi
-
-# Wait for NMI interrupt as a shutdown signal
-
-while true; do
-
-  checkNMI
-  sleep 2 & wait $!
-
-done

agent/service.sh

@@ -1,87 +0,0 @@
-#!/bin/bash
-
-PIDFILE="/var/run/agent.pid"
-SCRIPT="/usr/local/bin/agent.sh"
-
-error () { echo -e "\E[1;31m❯ ERROR: $1\E[0m" ; }
-info () { echo -e "\E[1;34m❯\E[1;36m $1\E[0m" ; }
-
-status() {
-
-  if [ -f "$PIDFILE" ] && kill -0 "$(cat "$PIDFILE")"; then
-    echo 'Service running'
-    return 1
-  fi
-
-  return 0
-}
-
-start() {
-
-  if [ -f "$PIDFILE" ] && kill -0 "$(cat "$PIDFILE")"; then
-    echo 'Service already running'
-    return 1
-  fi
-
-  echo 'Starting agent service...'
-  chmod 666 /dev/ttyS0
-
-  if [ ! -f "$SCRIPT" ]; then
-
-    URL="https://raw.githubusercontent.com/vdsm/virtual-dsm/master/agent/agent.sh"
-
-    if ! curl -sfk -m 10 -o "${SCRIPT}" "${URL}"; then
-      error 'Failed to download agent script.' > /dev/ttyS0
-      rm -f "${SCRIPT}"
-      return 1
-    else
-      info 'Agent script was missing?' > /dev/ttyS0
-    fi
-
-    chmod 755 "${SCRIPT}"
-
-  fi
-
-  echo "-" > /var/lock/subsys/agent.sh
-  "$SCRIPT" &> /dev/ttyS0 & echo $! > "$PIDFILE"
-
-  return 0
-}
-
-stop() {
-
-  if [ ! -f "$PIDFILE" ] || ! kill -0 "$(cat "$PIDFILE")"; then
-    echo 'Service not running'
-    return 1
-  fi
-
-  echo 'Stopping agent service...'
-
-  chmod 666 /dev/ttyS0
-  info 'Stopping agent service...' > /dev/ttyS0
-
-  kill -15 "$(cat "$PIDFILE")" && rm -f "$PIDFILE"
-  rm -f /var/lock/subsys/agent.sh
-
-  echo 'Service stopped'
-  return 0
-}
-
-case "$1" in
-  start)
-    start
-    ;;
-  stop)
-    stop
-    ;;
-  status)
-    status
-    ;;
-  restart)
-    stop
-    start
-    ;;
-  *)
-    echo "Usage: $0 {start|stop|restart}"
-    exit 1
-esac

compose.yml

@@ -5,16 +5,10 @@ services:
         image: vdsm/virtual-dsm:latest
         environment:
             DISK_SIZE: "16G"
-            RAM_SIZE: "1G"
-            CPU_CORES: "1"
         devices:
             - /dev/kvm
-            - /dev/net/tun
-            - /dev/vhost-net
-        device_cgroup_rules:
-            - 'c *:* rwm'
         cap_add:
-            - NET_ADMIN        
+            - NET_ADMIN
         ports:
             - 5000:5000
         volumes:

readme.md

@@ -1,6 +1,6 @@
-<h1 align="center">Virtual DSM for Docker<br />
+<h1 align="center">Virtual DSM<br />
 <div align="center">
-<img src="https://github.com/vdsm/virtual-dsm/raw/master/.github/screen.jpg" title="Screenshot" style="max-width:100%;" width="432" />
+<a href="https://github.com/vdsm/virtual-dsm"><img src="https://github.com/vdsm/virtual-dsm/raw/master/.github/screen.jpg" title="Screenshot" style="max-width:100%;" width="432" /></a>
 </div>
 <div align="center">
 
@@ -11,25 +11,24 @@
 
 </div></h1>
 
-Virtual DSM in a docker container.
+Virtual DSM in a Docker container.
 
 ## Features
 
  - Multiple disks
  - KVM acceleration
- - GPU passthrough
  - Upgrades supported
  
 ## Usage
 
-Via `docker-compose.yml`
+Via Docker Compose:
 
 ```yaml
 version: "3"
 services:
   dsm:
     container_name: dsm
-    image: vdsm/virtual-dsm:latest
+    image: vdsm/virtual-dsm
     environment:
       DISK_SIZE: "16G"
     devices:
@@ -44,172 +43,198 @@ services:
     stop_grace_period: 2m
 ```
 
-Via `docker run`
+Via Docker CLI:
 
 ```bash
-docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 60 vdsm/virtual-dsm:latest
+docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
 ```
 
 ## FAQ
 
-  * ### How do I change the size of the virtual disk?
+* ### How do I use it?
 
-    To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
+  Very simple! These are the steps:
+  
+  - Start the container and connect to [port 5000](http://localhost:5000) using your web browser.
 
-    ```yaml
+  - Wait until DSM is ready, choose an username and password, and you will be taken to the desktop.
-    environment:
+  
-      DISK_SIZE: "128G"
+  Enjoy your brand new machine, and don't forget to star this repo!
-    ```
-    
-    This can also be used to resize the existing disk to a larger capacity without any data loss. 
 
-  * ### How do I change the location of the virtual disk?
+* ### How do I change the size of the disk?
 
-    To change the location of the virtual disk, include the following bind mount in your compose file:
+  To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
 
-    ```yaml
+  ```yaml
-    volumes:
+  environment:
-      - /var/dsm:/storage
+    DISK_SIZE: "128G"
-    ```
+  ```
+  
+  This can also be used to resize the existing disk to a larger capacity without any data loss. 
 
-    Replace the example path `/var/dsm` with the desired storage folder.
+* ### How do I change the storage location?
 
-  * ### How do I add multiple disks?
+  To change the storage location, include the following bind mount in your compose file:
 
-    To create additional disks, modify your compose file like this:
+  ```yaml
-    
+  volumes:
-    ```yaml
+    - /var/dsm:/storage
-    environment:
+  ```
-      DISK2_SIZE: "32G"
-      DISK3_SIZE: "64G"
-    volumes:
-      - /home/example:/storage2
-      - /mnt/data/example:/storage3
-    ```
 
-  * ### How do I create a growable disk?
+  Replace the example path `/var/dsm` with the desired storage folder.
 
-    By default, the entire capacity of the disk is reserved in advance.
+* ### How do I create a growable disk?
 
-    To create a growable disk that only allocates space that is actually used, add the following environment variables:
+  By default, the entire capacity of the disk is reserved in advance.
 
-    ```yaml
+  To create a growable disk that only allocates space that is actually used, add the following environment variable:
-    environment:
-      ALLOCATE: "N"
-      DISK_FMT: "qcow2"
-    ```
 
-    Please note that this may reduce the write performance of the disk.
+  ```yaml
+  environment:
+    DISK_FMT: "qcow2"
+  ```
 
-  * ### How do I increase the amount of CPU or RAM?
+  Please note that this may reduce the write performance of the disk.
 
-    By default, a single core and 1 GB of RAM are allocated to the container.
+* ### How do I add multiple disks?
 
-    To increase this, add the following environment variables:
+  To create additional disks, modify your compose file like this:
+  
+  ```yaml
+  environment:
+    DISK2_SIZE: "32G"
+    DISK3_SIZE: "64G"
+  volumes:
+    - /home/example:/storage2
+    - /mnt/data/example:/storage3
+  ```
 
-    ```yaml
+* ### How do I pass-through a disk?
-    environment:
-      RAM_SIZE: "4G"
-      CPU_CORES: "4"
-    ```
 
-  * ### How do I verify if my system supports KVM?
+   It is possible to pass-through disk devices directly by adding them to your compose file in this way:
 
-    To verify if your system supports KVM, run the following commands:
+  ```yaml
+  devices:
+    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/dev/disk2
+    - /dev/disk/by-uuid/45678-45678-45678-45678-45678:/dev/disk3
+  ```
 
-    ```bash
+  Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
-    sudo apt install cpu-checker
-    sudo kvm-ok
-    ```
 
-    If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check your BIOS settings.
+  Do NOT use this feature with the goal of sharing files from the host, they will all be lost without warning when DSM creates the volume.
 
-  * ### How do I assign an individual IP address to the container?
+* ### How do I increase the amount of CPU or RAM?
 
-    By default, the container uses bridge networking, which shares the IP address with the host. 
+  By default, a single CPU core and 1 GB of RAM are allocated to the container.
 
-    If you want to assign an individual IP address to the container, you can create a macvlan network as follows:
+  To increase this, add the following environment variables:
 
-    ```bash
+  ```yaml
-    docker network create -d macvlan \
+  environment:
-        --subnet=192.168.0.0/24 \
+    RAM_SIZE: "4G"
-        --gateway=192.168.0.1 \
+    CPU_CORES: "4"
-        --ip-range=192.168.0.100/28 \
+  ```
-        -o parent=eth0 vdsm
-    ```
-    
-    Be sure to modify these values to match your local subnet. 
 
-    Once you have created the network, change your compose file to look as follows:
+* ### How do I verify if my system supports KVM?
 
-    ```yaml
+  To verify if your system supports KVM, run the following commands:
-    services:
-      dsm:
-        container_name: dsm
-        ..<snip>..
-        networks:
-          vdsm:
-            ipv4_address: 192.168.0.100
 
-    networks:
+  ```bash
-      vdsm:
+  sudo apt install cpu-checker
-        external: true
+  sudo kvm-ok
-    ```
+  ```
-   
-    An added benefit of this approach is that you won't have to perform any port mapping anymore since all ports will be exposed by default.
 
-    Please note that this IP address won't be accessible from the Docker host due to the design of macvlan, which doesn't permit communication between the two. If this is a concern, you need to create a [second macvlan](https://blog.oddbit.com/post/2018-03-12-using-docker-macvlan-networks/#host-access) as a workaround.
+  If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check the virtualization settings in the BIOS.
 
-  * ### How can the container acquire an IP address from my router?
+* ### How do I assign an individual IP address to the container?
 
-    After configuring the container for macvlan (see above), it is possible for DSM to become part of your home network by requesting an IP from your router, just like your other devices.
+  By default, the container uses bridge networking, which shares the IP address with the host. 
 
-    To enable this feature, add the following lines to your compose file:
+  If you want to assign an individual IP address to the container, you can create a macvlan network as follows:
 
-    ```yaml
+  ```bash
-    environment:
+  docker network create -d macvlan \
-      DHCP: "Y"
+      --subnet=192.168.0.0/24 \
-    devices:
+      --gateway=192.168.0.1 \
-      - /dev/vhost-net
+      --ip-range=192.168.0.100/28 \
-    device_cgroup_rules:
+      -o parent=eth0 vdsm
-      - 'c *:* rwm'
+  ```
-    ```
+  
+  Be sure to modify these values to match your local subnet. 
 
-    Please note that even if you don't want DHCP, it's still recommended to enable this feature as it prevents NAT issues and increases performance by using a `macvtap` interface. In that case just set a static IP from the DSM control panel after you enabled this mode.
+  Once you have created the network, change your compose file to look as follows:
 
-  * ### How do I passthrough the GPU?
+  ```yaml
+  services:
+    dsm:
+      container_name: dsm
+      ..<snip>..
+      networks:
+        vdsm:
+          ipv4_address: 192.168.0.100
 
-    To passthrough your Intel GPU, add the following lines to your compose file:
+  networks:
+    vdsm:
+      external: true
+  ```
+ 
+  An added benefit of this approach is that you won't have to perform any port mapping anymore, since all ports will be exposed by default.
 
-    ```yaml
+  Please note that this IP address won't be accessible from the Docker host due to the design of macvlan, which doesn't permit communication between the two. If this is a concern, you need to create a [second macvlan](https://blog.oddbit.com/post/2018-03-12-using-docker-macvlan-networks/#host-access) as a workaround.
-    environment:
-      GPU: "Y"
-    devices:
-      - /dev/dri
-    ```
 
-    This can be used to enable the facial recognition function in Synology Photos for example.
+* ### How can DSM acquire an IP address from my router?
 
-  * ### How do I install a specific version of vDSM?
+  After configuring the container for macvlan (see above), it is possible for DSM to become part of your home network by requesting an IP from your router, just like your other devices.
 
-    By default, version 7.2.1 will be installed, but if you prefer an older version, you can add its download URL to your compose file as follows:
+  To enable this mode, add the following lines to your compose file:
 
-    ```yaml
+  ```yaml
-    environment:
+  environment:
-      URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
+    DHCP: "Y"
-    ```
+  devices:
+    - /dev/vhost-net
+  device_cgroup_rules:
+    - 'c *:* rwm'
+  ```
 
-    With this method, it is even possible to switch between different versions while keeping all your file data intact.
+  Please note that even if you don't need DHCP, it's still recommended to enable this mode, as it prevents NAT issues and increases performance by using a `macvtap` interface. You can just set a static IP from the DSM control panel afterwards.
 
-  * ### What are the differences compared to the standard DSM?
+* ### How do I pass-through the GPU?
 
-    There are only two minor differences: the Virtual Machine Manager package is not available, and Surveillance Station will not include any free licenses.
+  To pass-through your Intel GPU, add the following lines to your compose file:
-    
-  * ### 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 would be considered legal. 
+  ```yaml
-    
+  environment:
-    However, by installing Synology's Virtual DSM, you must accept their end-user license agreement, which does not permit installation on non-Synology hardware. So only run this project on an official Synology NAS, as any other use will be a violation of their terms and conditions.
+    GPU: "Y"
+  devices:
+    - /dev/dri
+  ```
+
+  This can be used to enable the facial recognition function in Synology Photos for example.
+
+* ### How do I install a specific version of vDSM?
+
+  By default, version 7.2 will be installed, but if you prefer an older version, you can add its download URL to your compose file as follows:
+
+  ```yaml
+  environment:
+    URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
+  ```
+
+  With this method, it is even possible to switch between different versions while keeping all your file data intact.
+
+* ### What are the differences compared to the standard DSM?
+
+  There are only two minor differences: the Virtual Machine Manager package is not available, and Surveillance Station will not include any free licenses.
+  
+* ### 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 would be considered legal. 
+  
+  However, by installing Synology's Virtual DSM, you must accept their end-user license agreement, which does not permit installation on non-Synology hardware. So only run this container on an official Synology NAS, as any other use will be a violation of their terms and conditions.
+
+## Stars
+[![Stars](https://starchart.cc/vdsm/virtual-dsm.svg?variant=adaptive)](https://starchart.cc/vdsm/virtual-dsm)
 
 ## Disclaimer
 
@@ -221,5 +246,5 @@ Only run this container on Synology hardware, any other use is not permitted by
 
 [Build]: https://github.com/vdsm/virtual-dsm/actions/workflows/build.yml/badge.svg
 [Size]: https://img.shields.io/docker/image-size/vdsm/virtual-dsm/latest?color=066da5&label=size
-[Pulls]: https://img.shields.io/docker/pulls/kroese/virtual-dsm.svg?style=flat&label=pulls&logo=docker
+[Pulls]: https://img.shields.io/docker/pulls/vdsm/virtual-dsm.svg?style=flat&label=pulls&logo=docker
 [Version]: https://img.shields.io/docker/v/vdsm/virtual-dsm/latest?arch=amd64&sort=semver&color=066da5

src/check.sh

@@ -1,16 +1,32 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-[ ! -f "/run/qemu.pid" ] && echo "QEMU not running yet.." && exit 0
+: "${NETWORK:="Y"}"
-[ -f "/run/qemu.count" ] && echo "QEMU is shutting down.." && exit 1
 
-file="/run/dsm.url"
+[ -f "/run/shm/qemu.end" ] && echo "QEMU is shutting down.." && exit 1
-[ ! -f  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+[ ! -s "/run/shm/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
+[[ "$NETWORK" != [Yy1]* ]] && echo "Networking is disabled.." && exit 0
 
-location=$(cat "$file")
+file="/run/shm/dsm.url"
+address="/run/shm/qemu.ip"
+
+[ ! -s  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+
+location=$(<"$file")
 
 if ! curl -m 20 -ILfSs "http://$location/" > /dev/null; then
-  echo "Failed to reach page at http://$location" && exit 1
+
+  if [[ "$location" == "20.20"* ]]; then
+    ip="20.20.20.1"
+    port="${location##*:}"
+    echo "Failed to reach DSM at port $port"
+  else
+    echo "Failed to reach DSM at http://$location"
+    ip=$(<"$address")
+  fi
+
+  echo "You might need to whitelist IP $ip in the DSM firewall." && exit 1
+
 fi
 
 echo "Healthcheck OK"

src/config.sh

@@ -1,20 +1,15 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-DEF_OPTS="-nographic -nodefaults -boot strict=on -display none"
+DEF_OPTS="-nodefaults -boot strict=on"
 RAM_OPTS=$(echo "-m $RAM_SIZE" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
-CPU_OPTS="-cpu $CPU_MODEL -smp $CPU_CORES,sockets=1,dies=1,cores=$CPU_CORES,threads=1"
+CPU_OPTS="-cpu $CPU_FLAGS -smp $CPU_CORES,sockets=1,dies=1,cores=$CPU_CORES,threads=1"
-MAC_OPTS="-machine type=q35,usb=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
+MAC_OPTS="-machine type=q35,usb=off,vmport=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
-EXTRA_OPTS="-device virtio-balloon-pci,id=balloon0,bus=pcie.0,addr=0x4"
+DEV_OPTS="-device virtio-balloon-pci,id=balloon0,bus=pcie.0,addr=0x4"
-EXTRA_OPTS="$EXTRA_OPTS -object rng-random,id=objrng0,filename=/dev/urandom"
+DEV_OPTS="$DEV_OPTS -object rng-random,id=objrng0,filename=/dev/urandom"
-EXTRA_OPTS="$EXTRA_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
+DEV_OPTS="$DEV_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
 
-if [[ "$GPU" == [Yy1]* ]] && [[ "$ARCH" == "amd64" ]]; then
+ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $DEV_OPTS $ARGUMENTS"
-  DEF_OPTS="-nodefaults -boot strict=on -display egl-headless,rendernode=/dev/dri/renderD128"
-  DEF_OPTS="$DEF_OPTS -device virtio-vga,id=video0,max_outputs=1,bus=pcie.0,addr=0x1"
-fi
-
-ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $EXTRA_OPTS $ARGUMENTS"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')
 
 return 0

src/cpu.sh

@@ -1,61 +0,0 @@
-#!/usr/bin/env bash
-set -Eeuo pipefail
-
-# Docker environment variables
-
-: ${HOST_CPU:=''}
-: ${CPU_MODEL:='host'}
-: ${CPU_FEATURES:='+ssse3,+sse4.1,+sse4.2'}
-
-KVM_ERR=""
-KVM_OPTS=""
-
-if [[ "$ARCH" == "amd64" && "$KVM" != [Nn]* ]]; then
-
-  if [ -e /dev/kvm ] && sh -c 'echo -n > /dev/kvm' &> /dev/null; then
-    if ! grep -q -e vmx -e svm /proc/cpuinfo; then
-      KVM_ERR="(vmx/svm disabled)"
-    fi
-  else
-    [ -e /dev/kvm ] && KVM_ERR="(no write access)" || KVM_ERR="(device file missing)"
-  fi
-
-  if [ -n "$KVM_ERR" ]; then
-    error "KVM acceleration not detected $KVM_ERR, this will cause a major loss of performance."
-    error "See the FAQ on how to enable it, or skip this error by setting KVM=N (not recommended)."
-    [[ "$DEBUG" != [Yy1]* ]] && exit 88
-    [[ "$CPU_MODEL" == "host"* ]] && CPU_MODEL="max,$CPU_FEATURES"
-  else
-    KVM_OPTS=",accel=kvm -enable-kvm"
-  fi
-
-  if [ -n "$KVM_OPTS" ]; then
-    if ! grep -qE '^flags.* (sse4_2)' /proc/cpuinfo; then
-      error "Your host CPU does not have the SSE4.2 instruction set that Virtual DSM requires to boot."
-      error "Disable KVM by setting KVM=N to emulate a compatible CPU, at the cost of performance."
-      [[ "$DEBUG" != [Yy1]* ]] && exit 89
-    fi
-  fi
-
-else
-
-  [[ "$CPU_MODEL" == "host"* ]] && CPU_MODEL="max,$CPU_FEATURES"
-
-fi
-
-if [ -z "$HOST_CPU" ]; then
-  HOST_CPU=$(lscpu | grep 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
-fi
-
-if [ -n "$HOST_CPU" ]; then
-  HOST_CPU="${HOST_CPU%%,*},,"
-else
-  HOST_CPU="QEMU, Virtual CPU,"
-  if [ "$ARCH" == "amd64" ]; then
-    HOST_CPU="$HOST_CPU X86_64"
-  else
-    HOST_CPU="$HOST_CPU $ARCH"
-  fi
-fi
-
-return 0

src/disk.sh

@@ -3,25 +3,25 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${DISK_IO:='native'}          # I/O Mode, can be set to 'native', 'threads' or 'io_turing'
+: "${DISK_IO:="native"}"          # I/O Mode, can be set to 'native', 'threads' or 'io_turing'
-: ${DISK_FMT:='raw'}            # Disk file format, 'raw' by default for best performance
+: "${DISK_FMT:="raw"}"            # Disk file format, 'raw' by default for best performance
-: ${DISK_CACHE:='none'}         # Caching mode, can be set to 'writeback' for better performance
+: "${DISK_FLAGS:=""}"             # Specifies the options for use with the qcow2 disk format
-: ${DISK_DISCARD:='on'}         # Controls whether unmap (TRIM) commands are passed to the host.
+: "${DISK_CACHE:="none"}"         # Caching mode, can be set to 'writeback' for better performance
-: ${DISK_ROTATION:='1'}         # Rotation rate, set to 1 for SSD storage and increase for HDD
+: "${DISK_DISCARD:="on"}"         # Controls whether unmap (TRIM) commands are passed to the host.
-: ${DISK_FLAGS:='nocow=on'}     # Specifies the options for use with the qcow2 disk format
+: "${DISK_ROTATION:="1"}"         # Rotation rate, set to 1 for SSD storage and increase for HDD
 
 BOOT="$STORAGE/$BASE.boot.img"
 SYSTEM="$STORAGE/$BASE.system.img"
 
-[ ! -f "$BOOT" ] && error "Virtual DSM boot-image does not exist ($BOOT)" && exit 81
+[ ! -s "$BOOT" ] && error "Virtual DSM boot-image does not exist ($BOOT)" && exit 81
-[ ! -f "$SYSTEM" ] && error "Virtual DSM system-image does not exist ($SYSTEM)" && exit 82
+[ ! -s "$SYSTEM" ] && error "Virtual DSM system-image does not exist ($SYSTEM)" && exit 82
 
 DISK_OPTS="\
-    -object iothread,id=io1 -object iothread,id=io2 \
+    -object iothread,id=io2 \
-    -device virtio-scsi-pci,id=hw-synoboot,iothread=io1,bus=pcie.0,addr=0xa \
+    -device virtio-scsi-pci,id=hw-synoboot,iothread=io2,bus=pcie.0,addr=0xa \
     -drive file=$BOOT,if=none,id=drive-synoboot,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
     -device scsi-hd,bus=hw-synoboot.0,channel=0,scsi-id=0,lun=0,drive=drive-synoboot,id=synoboot0,rotation_rate=$DISK_ROTATION,bootindex=1 \
-    -device virtio-scsi-pci,id=hw-synosys,iothread=io1,bus=pcie.0,addr=0xb \
+    -device virtio-scsi-pci,id=hw-synosys,iothread=io2,bus=pcie.0,addr=0xb \
     -drive file=$SYSTEM,if=none,id=drive-synosys,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
     -device scsi-hd,bus=hw-synosys.0,channel=0,scsi-id=0,lun=0,drive=drive-synosys,id=synosys0,rotation_rate=$DISK_ROTATION,bootindex=2"
 
@@ -61,8 +61,8 @@ getSize() {
   local DISK_FILE=$1
   local DISK_EXT DISK_FMT
 
-  DISK_EXT="$(echo "${DISK_FILE//*./}" | sed 's/^.*\.//')"
+  DISK_EXT=$(echo "${DISK_FILE//*./}" | sed 's/^.*\.//')
-  DISK_FMT="$(ext2fmt "$DISK_EXT")"
+  DISK_FMT=$(ext2fmt "$DISK_EXT")
 
   case "${DISK_FMT,,}" in
     raw)
@@ -77,15 +77,38 @@ getSize() {
   esac
 }
 
+isCow() {
+  local FS=$1
+
+  if [[ "${FS,,}" == "btrfs" ]]; then
+    return 0
+  fi
+
+  return 1
+}
+
+supportsDirect() {
+  local FS=$1
+
+  if [[ "${FS,,}" == "ecryptfs" ]] || [[ "${FS,,}" == "tmpfs" ]]; then
+    return 1
+  fi
+
+  return 0
+}
+
 createDisk() {
   local DISK_FILE=$1
   local DISK_SPACE=$2
   local DISK_DESC=$3
   local DISK_FMT=$4
-  local DATA_SIZE DIR SPACE
+  local FS=$5
+  local DATA_SIZE DIR SPACE FA
 
   DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
 
+  rm -f "$DISK_FILE"
+
   if [[ "$ALLOCATE" != [Nn]* ]]; then
 
     # Check free diskspace
@@ -99,11 +122,21 @@ createDisk() {
     fi
   fi
 
-  info "Creating a $DISK_TYPE $DISK_DESC image in $DISK_FMT format with a size of $DISK_SPACE..."
+  html "Creating a $DISK_DESC image..."
+  info "Creating a $DISK_SPACE $DISK_TYPE $DISK_DESC image in $DISK_FMT format..."
+
   local FAIL="Could not create a $DISK_TYPE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
+
+      if isCow "$FS"; then
+        if ! touch "$DISK_FILE"; then
+          error "$FAIL" && exit 77
+        fi
+        { chattr +C "$DISK_FILE"; } || :
+      fi
+
       if [[ "$ALLOCATE" == [Nn]* ]]; then
 
         # Create an empty file
@@ -125,15 +158,25 @@ createDisk() {
       fi
       ;;
     qcow2)
-      local DISK_OPTS="$DISK_ALLOC"
+
-      [ -n "$DISK_FLAGS" ] && DISK_OPTS="$DISK_OPTS,$DISK_FLAGS"
+      local DISK_PARAM="$DISK_ALLOC"
-      if ! qemu-img create -f "$DISK_FMT" -o "$DISK_OPTS" -- "$DISK_FILE" "$DATA_SIZE" ; then
+      isCow "$FS" && DISK_PARAM="$DISK_PARAM,nocow=on"
+      [ -n "$DISK_FLAGS" ] && DISK_PARAM="$DISK_PARAM,$DISK_FLAGS"
+
+      if ! qemu-img create -f "$DISK_FMT" -o "$DISK_PARAM" -- "$DISK_FILE" "$DATA_SIZE" ; then
         rm -f "$DISK_FILE"
         error "$FAIL" && exit 70
       fi
       ;;
   esac
 
+  if isCow "$FS"; then
+    FA=$(lsattr "$DISK_FILE")
+    if [[ "$FA" != *"C"* ]]; then
+      error "Failed to disable COW for $DISK_DESC image $DISK_FILE on ${FS^^} filesystem (returned $FA)"
+    fi
+  fi
+
   return 0
 }
 
@@ -142,6 +185,7 @@ resizeDisk() {
   local DISK_SPACE=$2
   local DISK_DESC=$3
   local DISK_FMT=$4
+  local FS=$5
   local CUR_SIZE DATA_SIZE DIR SPACE
 
   CUR_SIZE=$(getSize "$DISK_FILE")
@@ -163,11 +207,14 @@ resizeDisk() {
   fi
 
   local GB=$(( (CUR_SIZE + 1073741823)/1073741824 ))
-  info "Resizing $DISK_DESC from ${GB}G to $DISK_SPACE..."
+  MSG="Resizing $DISK_DESC from ${GB}G to $DISK_SPACE..."
+  info "$MSG" && html "$MSG"
+
   local FAIL="Could not resize the $DISK_TYPE $DISK_FMT $DISK_DESC image from ${GB}G to $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
+
       if [[ "$ALLOCATE" == [Nn]* ]]; then
 
         # Resize file by changing its length
@@ -187,9 +234,11 @@ resizeDisk() {
       fi
       ;;
     qcow2)
+
       if ! qemu-img resize -f "$DISK_FMT" "--$DISK_ALLOC" "$DISK_FILE" "$DATA_SIZE" ; then
         error "$FAIL" && exit 72
       fi
+
       ;;
   esac
 
@@ -203,16 +252,18 @@ convertDisk() {
   local DST_FMT=$4
   local DISK_BASE=$5
   local DISK_DESC=$6
-  local CONV_FLAGS="-p"
+  local FS=$7
-  local DISK_OPTS="$DISK_ALLOC"
-  local TMP_FILE="$DISK_BASE.tmp"
-  local DIR CUR_SIZE SPACE
 
   [ -f "$DST_FILE" ] && error "Conversion failed, destination file $DST_FILE already exists?" && exit 79
   [ ! -f "$SOURCE_FILE" ] && error "Conversion failed, source file $SOURCE_FILE does not exists?" && exit 79
 
+  local TMP_FILE="$DISK_BASE.tmp"
+  rm -f "$TMP_FILE"
+
   if [[ "$ALLOCATE" != [Nn]* ]]; then
 
+    local DIR CUR_SIZE SPACE
+
     # Check free diskspace
     DIR=$(dirname "$TMP_FILE")
     CUR_SIZE=$(getSize "$SOURCE_FILE")
@@ -225,28 +276,32 @@ convertDisk() {
     fi
   fi
 
+  html "Converting $DISK_DESC to $DST_FMT..."
   info "Converting $DISK_DESC to $DST_FMT, please wait until completed..."
 
+  local CONV_FLAGS="-p"
+  local DISK_PARAM="$DISK_ALLOC"
+  isCow "$FS" && DISK_PARAM="$DISK_PARAM,nocow=on"
+
   if [[ "$DST_FMT" != "raw" ]]; then
       if [[ "$ALLOCATE" == [Nn]* ]]; then
         CONV_FLAGS="$CONV_FLAGS -c"
       fi
-      [ -n "$DISK_FLAGS" ] && DISK_OPTS="$DISK_OPTS,$DISK_FLAGS"
+      [ -n "$DISK_FLAGS" ] && DISK_PARAM="$DISK_PARAM,$DISK_FLAGS"
   fi
 
-  rm -f "$TMP_FILE"
-
   # shellcheck disable=SC2086
-  if ! qemu-img convert -f "$SOURCE_FMT" $CONV_FLAGS -o "$DISK_OPTS" -O "$DST_FMT" -- "$SOURCE_FILE" "$TMP_FILE"; then
+  if ! qemu-img convert -f "$SOURCE_FMT" $CONV_FLAGS -o "$DISK_PARAM" -O "$DST_FMT" -- "$SOURCE_FILE" "$TMP_FILE"; then
     rm -f "$TMP_FILE"
     error "Failed to convert $DISK_TYPE $DISK_DESC image to $DST_FMT format in $DIR, is there enough space available?" && exit 79
   fi
 
   if [[ "$DST_FMT" == "raw" ]]; then
       if [[ "$ALLOCATE" != [Nn]* ]]; then
+        # Work around qemu-img bug
         CUR_SIZE=$(stat -c%s "$TMP_FILE")
         if ! fallocate -l "$CUR_SIZE" "$TMP_FILE"; then
-            info "Failed to allocate $CUR_SIZE bytes for $TMP_FILE"
+            error "Failed to allocate $CUR_SIZE bytes for $DISK_DESC image $TMP_FILE"
         fi
       fi
   fi
@@ -254,45 +309,91 @@ convertDisk() {
   rm -f "$SOURCE_FILE"
   mv "$TMP_FILE" "$DST_FILE"
 
+  if isCow "$FS"; then
+    FA=$(lsattr "$DST_FILE")
+    if [[ "$FA" != *"C"* ]]; then
+      error "Failed to disable COW for $DISK_DESC image $DST_FILE on ${FS^^} filesystem (returned $FA)"
+    fi
+  fi
+
+  html "Conversion of $DISK_DESC completed..."
   info "Conversion of $DISK_DESC to $DST_FMT completed succesfully!"
 
   return 0
 }
 
-addDisk () {
+checkFS () {
-  local DISK_ID=$1
+  local FS=$1
-  local DISK_BASE=$2
+  local DISK_FILE=$2
-  local DISK_EXT=$3
+  local DISK_DESC=$3
-  local DISK_DESC=$4
+  local DIR FA
-  local DISK_SPACE=$5
-  local DISK_INDEX=$6
-  local DISK_ADDRESS=$7
-  local DISK_FMT=$8
-  local DISK_FILE="$DISK_BASE.$DISK_EXT"
-  local DIR FS FA DATA_SIZE PREV_FMT PREV_EXT CUR_SIZE
 
   DIR=$(dirname "$DISK_FILE")
   [ ! -d "$DIR" ] && return 0
 
-  FS=$(stat -f -c %T "$DIR")
+  if [[ "${FS,,}" == "overlay"* ]]; then
-  if [[ "$FS" == "overlay"* ]]; then
     info "Warning: the filesystem of $DIR is OverlayFS, this usually means it was binded to an invalid path!"
   fi
-  if [[ "$FS" == "btrfs"* ]]; then
+
-    if [ -f "$DISK_FILE" ] ; then
+  if [[ "${FS,,}" == "fuse"* ]]; then
+    info "Warning: the filesystem of $DIR is FUSE, this extra layer will negatively affect performance!"
+  fi
+
+  if ! supportsDirect "$FS"; then
+    info "Warning: the filesystem of $DIR is $FS, which does not support O_DIRECT mode, adjusting settings..."
+  fi
+
+  if isCow "$FS"; then
+    if [ -f "$DISK_FILE" ]; then
       FA=$(lsattr "$DISK_FILE")
-      [[ "$FA" == *"C"* ]] && FA=$(lsattr -d "$DIR")
+      if [[ "$FA" != *"C"* ]]; then
-    else
+        info "Warning: COW (copy on write) is not disabled for $DISK_DESC image file $DISK_FILE, this is recommended on ${FS^^} filesystems!"
-      FA=$(lsattr -d "$DIR")
+      fi
-    fi
-    if [[ "$FA" != *"C"* ]]; then
-      info "Warning: the filesystem of $DIR is BTRFS, and COW (copy on write) is not disabled for that folder!"
-      info "This will negatively affect write performance, please empty the folder and disable COW (chattr +C <path>)."
     fi
   fi
 
+  return 0
+}
+
+createDevice () {
+
+  local DISK_ID=$1
+  local DISK_FILE=$2
+  local DISK_INDEX=$3
+  local DISK_ADDRESS=$4
+  local DISK_FMT=$5
+  local DISK_IO=$6
+  local DISK_CACHE=$7
+
+  local result="-drive file=$DISK_FILE,if=none,id=drive-$DISK_ID,format=$DISK_FMT,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on"
+
+  result="$result \
+    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+    -device scsi-hd,bus=hw-$DISK_ID.0,channel=0,scsi-id=0,lun=0,drive=drive-$DISK_ID,id=$DISK_ID,rotation_rate=$DISK_ROTATION,bootindex=$DISK_INDEX"
+
+  echo "$result"
+  return 0
+}
+
+addDisk () {
+  local DISK_BASE=$1
+  local DISK_EXT=$2
+  local DISK_DESC=$3
+  local DISK_SPACE=$4
+  local DISK_INDEX=$5
+  local DISK_ADDRESS=$6
+  local DISK_FMT=$7
+  local DISK_IO=$8
+  local DISK_CACHE=$9
+  local DISK_ID="userdata$DISK_INDEX"
+  local DISK_FILE="$DISK_BASE.$DISK_EXT"
+  local DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE OPTS
+
+  DIR=$(dirname "$DISK_FILE")
+  [ ! -d "$DIR" ] && return 0
+
   [ -z "$DISK_SPACE" ] && DISK_SPACE="16G"
-  DISK_SPACE=$(echo "$DISK_SPACE" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+  DISK_SPACE=$(echo "${DISK_SPACE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
   DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
 
   if (( DATA_SIZE < 6442450944 )); then
@@ -303,43 +404,77 @@ addDisk () {
     fi
   fi
 
-  if ! [ -f "$DISK_FILE" ] ; then
+  FS=$(stat -f -c %T "$DIR")
+  checkFS "$FS" "$DISK_FILE" "$DISK_DESC" || exit $?
+
+  if ! supportsDirect "$FS"; then
+    DISK_IO="threads"
+    DISK_CACHE="writeback"
+  fi
+
+  if ! [ -s "$DISK_FILE" ] ; then
 
     if [[ "${DISK_FMT,,}" != "raw" ]]; then
       PREV_FMT="raw"
     else
       PREV_FMT="qcow2"
     fi
-    PREV_EXT="$(fmt2ext "$PREV_FMT")"
+    PREV_EXT=$(fmt2ext "$PREV_FMT")
 
-    if [ -f "$DISK_BASE.$PREV_EXT" ] ; then
+    if [ -s "$DISK_BASE.$PREV_EXT" ] ; then
-      convertDisk "$DISK_BASE.$PREV_EXT" "$PREV_FMT" "$DISK_FILE" "$DISK_FMT" "$DISK_BASE" "$DISK_DESC" || exit $?
+      convertDisk "$DISK_BASE.$PREV_EXT" "$PREV_FMT" "$DISK_FILE" "$DISK_FMT" "$DISK_BASE" "$DISK_DESC" "$FS" || exit $?
     fi
   fi
 
-  if [ -f "$DISK_FILE" ]; then
+  if [ -s "$DISK_FILE" ]; then
 
     CUR_SIZE=$(getSize "$DISK_FILE")
 
     if (( DATA_SIZE > CUR_SIZE )); then
-      resizeDisk "$DISK_FILE" "$DISK_SPACE" "$DISK_DESC" "$DISK_FMT" || exit $?
+      resizeDisk "$DISK_FILE" "$DISK_SPACE" "$DISK_DESC" "$DISK_FMT" "$FS" || exit $?
     fi
 
   else
 
-    createDisk "$DISK_FILE" "$DISK_SPACE" "$DISK_DESC" "$DISK_FMT" || exit $?
+    createDisk "$DISK_FILE" "$DISK_SPACE" "$DISK_DESC" "$DISK_FMT" "$FS" || exit $?
 
   fi
 
-  DISK_OPTS="$DISK_OPTS \
+  OPTS=$(createDevice "$DISK_ID" "$DISK_FILE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE")
-    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+  DISK_OPTS="$DISK_OPTS $OPTS"
-    -drive file=$DISK_FILE,if=none,id=drive-$DISK_ID,format=$DISK_FMT,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
-    -device scsi-hd,bus=hw-$DISK_ID.0,channel=0,scsi-id=0,lun=0,drive=drive-$DISK_ID,id=$DISK_ID,rotation_rate=$DISK_ROTATION,bootindex=$DISK_INDEX"
 
   return 0
 }
 
-DISK_EXT="$(fmt2ext "$DISK_FMT")" || exit $?
+addDevice () {
+
+  local DISK_DEV=$1
+  local DISK_DESC=$2
+  local DISK_INDEX=$3
+  local DISK_ADDRESS=$4
+  local DISK_ID="userdata$DISK_INDEX"
+
+  [ -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 OPTS
+  OPTS=$(createDevice "$DISK_ID" "$DISK_DEV" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
+  DISK_OPTS="$DISK_OPTS $OPTS"
+
+  return 0
+}
+
+html "Initializing disks..."
+
+DISK_EXT=$(fmt2ext "$DISK_FMT")
+
+if [ -z "$ALLOCATE" ]; then
+  if [[ "${DISK_FMT,,}" == "raw" ]]; then
+    ALLOCATE="Y"
+  else
+    ALLOCATE="N"
+  fi
+fi
 
 if [[ "$ALLOCATE" == [Nn]* ]]; then
   DISK_TYPE="growable"
@@ -382,52 +517,44 @@ if [ ! -f "$DISK3_FILE.img" ]; then
 fi
 
 DISK4_FILE="/storage4/data4"
-DISK5_FILE="/storage5/data5"
-DISK6_FILE="/storage6/data6"
 
-: ${DISK2_SIZE:=''}
+: "${DISK2_SIZE:=""}"
-: ${DISK3_SIZE:=''}
+: "${DISK3_SIZE:=""}"
-: ${DISK4_SIZE:=''}
+: "${DISK4_SIZE:=""}"
-: ${DISK5_SIZE:=''}
-: ${DISK6_SIZE:=''}
 
-addDisk "userdata" "$DISK1_FILE" "$DISK_EXT" "disk" "$DISK_SIZE" "3" "0xc" "$DISK_FMT" || exit $?
+: "${DEVICE:=""}"        # Docker variables to passthrough a block device, like /dev/vdc1.
-addDisk "userdata2" "$DISK2_FILE" "$DISK_EXT" "disk2" "$DISK2_SIZE" "4" "0xd" "$DISK_FMT" || exit $?
+: "${DEVICE2:=""}"
-addDisk "userdata3" "$DISK3_FILE" "$DISK_EXT" "disk3" "$DISK3_SIZE" "5" "0xe" "$DISK_FMT" || exit $?
+: "${DEVICE3:=""}"
-addDisk "userdata4" "$DISK4_FILE" "$DISK_EXT" "disk4" "$DISK4_SIZE" "9" "0x7" "$DISK_FMT" || exit $?
+: "${DEVICE4:=""}"
-addDisk "userdata5" "$DISK5_FILE" "$DISK_EXT" "disk5" "$DISK5_SIZE" "10" "0x8" "$DISK_FMT" || exit $?
-addDisk "userdata6" "$DISK6_FILE" "$DISK_EXT" "disk6" "$DISK6_SIZE" "11" "0x9" "$DISK_FMT" || exit $?
 
-addDevice () {
+[ -z "$DEVICE" ] && [ -b "/dev/disk1" ] && DEVICE="/dev/disk1"
+[ -z "$DEVICE2" ] && [ -b "/dev/disk2" ] && DEVICE2="/dev/disk2"
+[ -z "$DEVICE3" ] && [ -b "/dev/disk3" ] && DEVICE3="/dev/disk3"
+[ -z "$DEVICE4" ] && [ -b "/dev/disk4" ] && DEVICE4="/dev/disk4"
 
-  local DISK_ID=$1
+if [ -n "$DEVICE" ]; then
-  local DISK_DEV=$2
+  addDevice "$DEVICE" "device" "3" "0xc" || exit $?
-  local DISK_INDEX=$3
+else
-  local DISK_ADDRESS=$4
+  addDisk "$DISK1_FILE" "$DISK_EXT" "disk" "$DISK_SIZE" "3" "0xc" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+fi
 
-  [ -z "$DISK_DEV" ] && return 0
+if [ -n "$DEVICE2" ]; then
-  [ ! -b "$DISK_DEV" ] && error "Device $DISK_DEV cannot be found! Please add it to the 'devices' section of your compose file." && exit 55
+  addDevice "$DEVICE2" "device2" "4" "0xd" || exit $?
+else
+  addDisk "$DISK2_FILE" "$DISK_EXT" "disk2" "$DISK2_SIZE" "4" "0xd" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+fi
 
-  DISK_OPTS="$DISK_OPTS \
+if [ -n "$DEVICE3" ]; then
-    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+  addDevice "$DEVICE3" "device3" "5" "0xe" || exit $?
-    -drive file=$DISK_DEV,if=none,id=drive-$DISK_ID,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
+else
-    -device scsi-hd,bus=hw-$DISK_ID.0,channel=0,scsi-id=0,lun=0,drive=drive-$DISK_ID,id=$DISK_ID,rotation_rate=$DISK_ROTATION,bootindex=$DISK_INDEX"
+  addDisk "$DISK3_FILE" "$DISK_EXT" "disk3" "$DISK3_SIZE" "5" "0xe" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+fi
 
-  return 0
+if [ -n "$DEVICE4" ]; then
-}
+  addDevice "$DEVICE4" "device4" "6" "0xf" || exit $?
-
+else
-: ${DEVICE:=''}        # Docker variable to passthrough a block device, like /dev/vdc1.
+  addDisk "$DISK4_FILE" "$DISK_EXT" "disk4" "$DISK4_SIZE" "6" "0xf" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
-: ${DEVICE2:=''}
+fi
-: ${DEVICE3:=''}
-: ${DEVICE4:=''}
-: ${DEVICE5:=''}
-: ${DEVICE6:=''}
-
-addDevice "userdata7" "$DEVICE" "6" "0xf" || exit $?
-addDevice "userdata8" "$DEVICE2" "7" "0x5" || exit $?
-addDevice "userdata9" "$DEVICE3" "8" "0x6" || exit $?
-addDevice "userdata4" "$DEVICE4" "9" "0x7" || exit $?
-addDevice "userdata5" "$DEVICE5" "10" "0x8" || exit $?
-addDevice "userdata6" "$DEVICE6" "11" "0x9" || exit $?
 
+html "Initialized disks successfully..."
 return 0

src/display.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Docker environment variables
+
+: "${GPU:="N"}"         # GPU passthrough
+: "${VGA:="virtio"}"    # VGA adaptor
+: "${DISPLAY:="none"}"  # Display type
+
+if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
+
+  [[ "${DISPLAY,,}" == "none" ]] && VGA="none"
+  DISPLAY_OPTS="-display $DISPLAY -vga $VGA"
+  return 0
+
+fi
+
+DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128"
+DISPLAY_OPTS="$DISPLAY_OPTS -vga $VGA"
+
+[ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
+
+if [ ! -c /dev/dri/card0 ]; then
+  if mknod /dev/dri/card0 c 226 0; then
+    chmod 666 /dev/dri/card0
+  fi
+fi
+
+if [ ! -c /dev/dri/renderD128 ]; then
+  if mknod /dev/dri/renderD128 c 226 128; then
+    chmod 666 /dev/dri/renderD128
+  fi
+fi
+
+addPackage "xserver-xorg-video-intel" "Intel GPU drivers"
+addPackage "qemu-system-modules-opengl" "OpenGL module"
+
+return 0

src/entry.sh

@@ -1,34 +1,36 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-echo "❯ Starting Virtual DSM for Docker v$(</run/version)..."
+APP="Virtual DSM"
-echo "❯ For support visit https://github.com/vdsm/virtual-dsm/"
+SUPPORT="https://github.com/vdsm/virtual-dsm"
 
 cd /run
 
 . reset.sh      # Initialize system
 . install.sh    # Run installation
 . disk.sh       # Initialize disks
+. display.sh    # Initialize graphics
 . network.sh    # Initialize network
-. gpu.sh        # Initialize graphics
+. proc.sh       # Initialize processor
-. cpu.sh        # Initialize processor
 . serial.sh     # Initialize serialport
 . power.sh      # Configure shutdown
 . config.sh     # Configure arguments
 
 trap - ERR
 
+info "Booting ${APP}..."
+[[ "$DEBUG" == [Yy1]* ]] && echo "Arguments: $ARGS" && echo
+
 if [[ "$CONSOLE" == [Yy]* ]]; then
-  exec qemu-system-x86_64 -pidfile "$QEMU_PID" ${ARGS:+ $ARGS}
+  exec qemu-system-x86_64 ${ARGS:+ $ARGS}
-  exit $?
 fi
 
-set -m
+{ qemu-system-x86_64 ${ARGS:+ $ARGS} >"$QEMU_OUT" 2>"$QEMU_LOG"; rc=$?; } || :
-(
+(( rc != 0 )) && error "$(<"$QEMU_LOG")" && exit 15
-  [[ "$DEBUG" == [Yy1]* ]] && info "$VERS" && set -x
-  qemu-system-x86_64 ${ARGS:+ $ARGS} & echo $! > "$QEMU_PID"
-  { set +x; } 2>/dev/null
-)
-set +m
 
-tail --pid "$(cat "$QEMU_PID")" --follow /dev/null & wait $!
+terminal
+tail -fn +0 "$QEMU_LOG" 2>/dev/null &
+cat "$QEMU_TERM" 2>/dev/null & wait $! || :
+
+sleep 1 & wait $!
+finish 0

src/gpu.sh

@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-set -Eeuo pipefail
-
-if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
-  return 0
-fi
-
-[ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
-
-if [ ! -c /dev/dri/card0 ]; then
-  mknod /dev/dri/card0 c 226 0
-fi
-
-if [ ! -c /dev/dri/renderD128 ]; then
-  mknod /dev/dri/renderD128 c 226 128
-fi
-
-chmod 666 /dev/dri/card0
-chmod 666 /dev/dri/renderD128
-
-addPackage "xserver-xorg-video-intel" "Intel GPU drivers"
-addPackage "qemu-system-modules-opengl" "OpenGL module"
-
-return 0

src/install.sh

@@ -1,24 +1,30 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-: ${URL:=''}    # URL of the PAT file to be downloaded.
+: "${URL:=""}"    # URL of the PAT file to be downloaded.
-: ${DEV:='Y'}   # Controls whether device nodes are created.
 
-if [ -f "$STORAGE"/dsm.ver ]; then
+if [ -f "$STORAGE/dsm.ver" ]; then
-  BASE=$(cat "$STORAGE/dsm.ver")
+  BASE=$(<"$STORAGE/dsm.ver")
+  [ -z "$BASE" ] && BASE="DSM_VirtualDSM_69057"
 else
   # Fallback for old installs
   BASE="DSM_VirtualDSM_42962"
 fi
 
-[ -n "$URL" ] && BASE=$(basename "$URL" .pat)
+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
+fi
 
-if [[ -f "$STORAGE/$BASE.boot.img" ]] && [[ -f "$STORAGE/$BASE.system.img" ]]; then
+if [[ -s "$STORAGE/$BASE.boot.img" ]] && [[ -s "$STORAGE/$BASE.system.img" ]]; then
   return 0  # Previous installation found
 fi
 
-# Display wait message
+html "Please wait while Virtual DSM is being installed..."
-/run/server.sh 5000 install &
 
 DL=""
 DL_CHINA="https://cndl.synology.cn/download/DSM"
@@ -35,61 +41,63 @@ fi
 
 [ -z "$URL" ] && URL="$DL/release/7.2.1/69057-1/DSM_VirtualDSM_69057.pat"
 
-BASE=$(basename "$URL" .pat)
+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
+  rm -f "$STORAGE/$BASE.pat"
 fi
 
-rm -f "$STORAGE"/"$BASE".agent
+rm -f "$STORAGE/$BASE.agent"
-rm -f "$STORAGE"/"$BASE".boot.img
+rm -f "$STORAGE/$BASE.boot.img"
-rm -f "$STORAGE"/"$BASE".system.img
+rm -f "$STORAGE/$BASE.system.img"
 
 [[ "$DEBUG" == [Yy1]* ]] && set -x
 
 # Check filesystem
-MIN_ROOT=471859200
-MIN_SPACE=6442450944
 FS=$(stat -f -c %T "$STORAGE")
 
-if [[ "$FS" == "overlay"* ]]; then
+if [[ "${FS,,}" == "overlay"* ]]; then
   info "Warning: the filesystem of $STORAGE is OverlayFS, this usually means it was binded to an invalid path!"
 fi
-if [[ "$FS" == "btrfs"* ]]; then
+
-  FA=$(lsattr -d "$STORAGE")
+if [[ "${FS,,}" == "fuse"* ]]; then
-  if [[ "$FA" != *"C"* ]]; then
+  info "Warning: the filesystem of $STORAGE is FUSE, this extra layer will negatively affect performance!"
-    info "Warning: the filesystem of $STORAGE is BTRFS, and COW (copy on write) is not disabled for that folder!"
-    info "This will negatively affect write performance, please empty the folder and disable COW (chattr +C <path>)."
-  fi
 fi
 
-if [[ "$FS" != "fat"* && "$FS" != "vfat"* && "$FS" != "exfat"* && \
+if [[ "${FS,,}" == "ecryptfs" ]] || [[ "${FS,,}" == "tmpfs" ]]; then
-        "$FS" != "ntfs"* && "$FS" != "fuse"* && "$FS" != "msdos"* ]]; then
+  info "Warning: the filesystem of $STORAGE is $FS, which does not support O_DIRECT mode, adjusting settings..."
+fi
+
+if [[ "${FS,,}" == "fat"* || "${FS,,}" == "vfat"* || "${FS,,}" == "msdos"* ]]; then
+  error "Unable to install on $FS filesystems, please use a different filesystem for /storage." && exit 61
+fi
+
+if [[ "${FS,,}" != "exfat"* && "${FS,,}" != "ntfs"* && "${FS,,}" != "unknown"* ]]; then
   TMP="$STORAGE/tmp"
 else
   TMP="/tmp/dsm"
+  TMP_SPACE=2147483648
   SPACE=$(df --output=avail -B 1 /tmp | tail -n 1)
-  if (( MIN_SPACE > SPACE )); then
+  SPACE_MB=$(( (SPACE + 1048575)/1048576 ))
-    TMP="$STORAGE/tmp"
+  if (( TMP_SPACE > SPACE )); then
-    info "Warning: the $FS filesystem of $STORAGE does not support UNIX permissions.."
+    error "Not enough free space inside the container, have $SPACE_MB MB available but need at least 2 GB." && exit 93
   fi
 fi
 
 rm -rf "$TMP" && mkdir -p "$TMP"
 
 # Check free diskspace
+ROOT_SPACE=536870912
 SPACE=$(df --output=avail -B 1 / | tail -n 1)
-(( MIN_ROOT > SPACE )) && error "Not enough free space in container root, need at least 450 MB available." && exit 96
+SPACE_MB=$(( (SPACE + 1048575)/1048576 ))
+(( ROOT_SPACE > SPACE )) && error "Not enough free space inside the container, have $SPACE_MB MB available but need at least 500 MB." && exit 96
 
-SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
+MIN_SPACE=8589934592
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
 SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-(( MIN_SPACE > SPACE )) && error "Not enough free space for installation in $STORAGE, have $SPACE_GB GB available but need at least 6 GB." && exit 95
+(( MIN_SPACE > SPACE )) && error "Not enough free space for installation in $STORAGE, have $SPACE_GB GB available but need at least 8 GB." && exit 94
-
-if [[ "$TMP" != "$STORAGE/tmp" ]]; then
-  SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
-  SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-  (( MIN_SPACE > SPACE )) && error "Not enough free space for installation in $STORAGE, have $SPACE_GB GB available but need at least 6 GB." && exit 94
-fi
 
 # Check if output is to interactive TTY
 if [ -t 1 ]; then
@@ -100,30 +108,48 @@ fi
 
 # Download the required files from the Synology website
 
+ROOT="Y"
 RDC="$STORAGE/dsm.rd"
 
-if [ ! -f "$RDC" ]; then
+if [ ! -s "$RDC" ]; then
 
-  info "Install: Downloading installer..."
+  MSG="Downloading installer..."
+  PRG="Downloading installer ([P])..."
+  info "Install: $MSG" && html "$MSG"
 
   RD="$TMP/rd.gz"
   POS="65627648-71021835"
   VERIFY="b4215a4b213ff5154db0488f92c87864"
   LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
 
+  rm -f "$RD"
+  rm -f "$RDC"
+  /run/progress.sh "$RD" "$PRG" &
   { curl -r "$POS" -sfk -S -o "$RD" "$LOC"; rc=$?; } || :
-  (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
 
-  SUM=$(md5sum "$RD" | cut -f 1 -d " ")
+  fKill "progress.sh"
+
+  if (( rc != 0 )); then
+    if (( rc != 22 )) && (( rc != 56 )); then
+      error "Failed to download $LOC, reason: $rc" && exit 60
+    fi
+    SUM="skip"
+  else
+    SUM=$(md5sum "$RD" | cut -f 1 -d " ")
+  fi
 
   if [ "$SUM" != "$VERIFY" ]; then
 
     PAT="/install.pat"
-    rm "$RD"
+    rm -f "$RD"
     rm -f "$PAT"
 
+    html "$MSG"
+    /run/progress.sh "$PAT" "$PRG" &
     { wget "$LOC" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
-    (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
+
+    fKill "progress.sh"
+    (( rc != 0 )) && error "Failed to download $LOC , reason: $rc" && exit 60
 
     tar --extract --file="$PAT" --directory="$(dirname "$RD")"/. "$(basename "$RD")"
     rm "$PAT"
@@ -137,19 +163,17 @@ fi
 if [ -f "$RDC" ]; then
 
   { xz -dc <"$RDC" >"$TMP/rd" 2>/dev/null; rc=$?; } || :
-  (( rc != 1 )) && error "Failed to unxz $RDC, reason $rc" && exit 91
+  (( rc != 1 )) && error "Failed to unxz $RDC on $FS, reason $rc" && exit 91
 
-  if [[ "$DEV" == [Nn]* ]]; then
+  { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-    # Exclude dev/ from cpio extract
+
-    { (cd "$TMP" && cpio -it < "$TMP/rd" | grep -Ev 'dev/' | while read -r entry; do cpio -idm "$entry" < "$TMP/rd" 2>/dev/null; done); rc=$?; } || :
+  if (( rc != 0 )); then
-    (( rc != 0 )) && error "Failed to extract $RDC, reason $rc" && exit 92
+    ROOT="N"
-  else
+    { (cd "$TMP" && fakeroot cpio -idmu <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-    { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
+    (( rc != 0 )) && error "Failed to extract $RDC on $FS, reason $rc" && exit 92
-    (( rc != 0 )) && error "Failed to extract $RDC, reason $rc"
-    (( rc != 0 )) && error "If the container runs unprivileged, please set DEV=N to exclude device nodes." && exit 92
   fi
 
-  mkdir -p /run/extract
+  rm -rf /run/extract && mkdir -p /run/extract
   for file in $TMP/usr/lib/libcurl.so.4 \
               $TMP/usr/lib/libmbedcrypto.so.5 \
               $TMP/usr/lib/libmbedtls.so.13 \
@@ -175,7 +199,11 @@ fi
 
 rm -rf "$TMP" && mkdir -p "$TMP"
 
-info "Install: Downloading $(basename "$URL")..."
+info "Install: Downloading $BASE.pat..."
+
+MSG="Downloading DSM..."
+PRG="Downloading DSM ([P])..."
+html "$MSG"
 
 PAT="/$BASE.pat"
 rm -f "$PAT"
@@ -186,12 +214,16 @@ if [[ "$URL" == "file://"* ]]; then
 
 else
 
+  /run/progress.sh "$PAT" "$PRG" &
+
   { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
-  (( rc != 0 )) && error "Failed to download $URL, reason: $rc" && exit 69
+
+  fKill "progress.sh"
+  (( rc != 0 )) && error "Failed to download $URL , reason: $rc" && exit 69
 
 fi
 
-[ ! -f "$PAT" ] && error "Failed to download $URL" && exit 69
+[ ! -s "$PAT" ] && error "Failed to download $URL" && exit 69
 
 SIZE=$(stat -c%s "$PAT")
 
@@ -199,15 +231,15 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
+MSG="Extracting downloaded image..."
+info "Install: $MSG" && html "$MSG"
+
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
-  info "Install: Extracting downloaded image..."
   tar xpf "$PAT" -C "$TMP/."
 
 else
 
-  info "Install: Extracting downloaded image..."
-
   export LD_LIBRARY_PATH="/run/extract"
 
   if [ "$ARCH" == "amd64" ]; then
@@ -222,39 +254,47 @@ else
 
 fi
 
-HDA="$TMP/hda1"
+rm -rf /run/extract
-IDB="$TMP/indexdb"
-PKG="$TMP/packages"
-HDP="$TMP/synohdpack_img"
 
-[ ! -f "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
+MSG="Preparing system partition..."
+info "Install: $MSG" && html "$MSG"
 
 BOOT=$(find "$TMP" -name "*.bin.zip")
-[ ! -f "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
+[ ! -s "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
 
 BOOT=$(echo "$BOOT" | head -c -5)
 unzip -q -o "$BOOT".zip -d "$TMP"
 
-SYSTEM="$TMP/sys.img"
+SYSTEM="$STORAGE/$BASE.system.img"
-SYSTEM_SIZE=4954537983
+rm -f "$SYSTEM"
 
 # Check free diskspace
-SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
+SYSTEM_SIZE=4954537983
-SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
-(( SYSTEM_SIZE > SPACE )) && error "Not enough free space to create a 4 GB system disk, have only $SPACE_GB GB available." && exit 97
+SPACE_MB=$(( (SPACE + 1048575)/1048576 ))
 
-if ! fallocate -l "$SYSTEM_SIZE" "$SYSTEM"; then
+if (( SYSTEM_SIZE > SPACE )); then
-  if ! truncate -s "$SYSTEM_SIZE" "$SYSTEM"; then
+  error "Not enough free space in $STORAGE to create a 5 GB system disk, have only $SPACE_MB MB available." && exit 97
-    rm -f "$SYSTEM" && error "Could not allocate a file for the system disk." && exit 98
+fi
+
+if ! touch "$SYSTEM"; then
+  error "Could not create file $SYSTEM for the system disk." && exit 98
+fi
+
+if [[ "${FS,,}" == "btrfs" ]]; then
+  { chattr +C "$SYSTEM"; } || :
+  FA=$(lsattr "$SYSTEM")
+  if [[ "$FA" != *"C"* ]]; then
+    error "Failed to disable COW for system image $SYSTEM on ${FS^^} filesystem."
   fi
 fi
 
-# Check if file exists
+if ! fallocate -l "$SYSTEM_SIZE" "$SYSTEM"; then
-[ ! -f "$SYSTEM" ] && error "System disk does not exist ($SYSTEM)" && exit 99
+  if ! truncate -s "$SYSTEM_SIZE" "$SYSTEM"; then
-
+    rm -f "$SYSTEM"
-# Check the filesize
+    error "Could not allocate file $SYSTEM for the system disk." && exit 98
-SIZE=$(stat -c%s "$SYSTEM")
+  fi
-[[ SIZE -ne SYSTEM_SIZE ]] && rm -f "$SYSTEM" && error "System disk has the wrong size: $SIZE" && exit 90
+fi
 
 PART="$TMP/partition.fdisk"
 
@@ -270,50 +310,67 @@ PART="$TMP/partition.fdisk"
 
 sfdisk -q "$SYSTEM" < "$PART"
 
-info "Install: Extracting system partition..."
-
 MOUNT="$TMP/system"
 rm -rf "$MOUNT" && mkdir -p "$MOUNT"
 
-mv "$HDA.tgz" "$HDA.txz"
+MSG="Extracting system partition..."
+info "Install: $MSG" && html "$MSG"
 
-if [[ "$DEV" == [Nn]* ]]; then
+HDA="$TMP/hda1"
-  # Exclude dev/ from tar extract
+IDB="$TMP/indexdb"
-  tar xpfJ "$HDA.txz" --absolute-names --exclude="dev" -C "$MOUNT/"
+PKG="$TMP/packages"
-else
+HDP="$TMP/synohdpack_img"
-  tar xpfJ "$HDA.txz" --absolute-names -C "$MOUNT/"
+
-fi
+[ ! -s "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
+mv "$HDA.tgz" "$HDA.txz"
 
 [ -d "$PKG" ] && mv "$PKG/" "$MOUNT/.SynoUpgradePackages/"
 rm -f "$MOUNT/.SynoUpgradePackages/ActiveInsight-"*
 
-[ -f "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
+[ -s "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
-[ -f "$IDB.txz" ] && tar xpfJ "$IDB.txz" --absolute-names -C "$MOUNT/usr/syno/synoman/indexdb/"
 
-info "Install: Installing system partition..."
+if [ -s "$IDB.txz" ]; then
+  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"
 OFFSET="1048576" # 2048 * 512
 NUMBLOCKS="622560" # (4980480 * 512) / 4096
+MSG="Installing system partition..."
 
-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"
-echo "$BASE" > "$STORAGE"/dsm.ver
 
 if [[ "$URL" == "file://$STORAGE/$BASE.pat" ]]; then
   rm -f "$PAT"
 else
-  mv -f "$PAT" "$STORAGE"/"$BASE".pat
+  mv -f "$PAT" "$STORAGE/$BASE.pat"
 fi
 
-mv -f "$BOOT" "$STORAGE"/"$BASE".boot.img
+mv -f "$BOOT" "$STORAGE/$BASE.boot.img"
-mv -f "$SYSTEM" "$STORAGE"/"$BASE".system.img
-
 rm -rf "$TMP"
 
 { set +x; } 2>/dev/null
 [[ "$DEBUG" == [Yy1]* ]] && echo
 
+html "Installation finished successfully..."
 return 0

src/network.sh

@@ -3,17 +3,21 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${DHCP:='N'}
+: "${MAC:=""}"
-: ${MAC:='02:11:32:AA:BB:CC'}
+: "${DHCP:="N"}"
+: "${NETWORK:="Y"}"
+: "${HOST_PORTS:=""}"
 
-: ${VM_NET_TAP:='dsm'}
+: "${VM_NET_DEV:=""}"
-: ${VM_NET_DEV:='eth0'}
+: "${VM_NET_TAP:="dsm"}"
-: ${VM_NET_MAC:="$MAC"}
+: "${VM_NET_MAC:="$MAC"}"
-: ${VM_NET_HOST:='VirtualDSM'}
+: "${VM_NET_HOST:="VirtualDSM"}"
 
-: ${DNSMASQ_OPTS:=''}
+: "${DNSMASQ_OPTS:=""}"
-: ${DNSMASQ:='/usr/sbin/dnsmasq'}
+: "${DNSMASQ:="/usr/sbin/dnsmasq"}"
-: ${DNSMASQ_CONF_DIR:='/etc/dnsmasq.d'}
+: "${DNSMASQ_CONF_DIR:="/etc/dnsmasq.d"}"
+
+ADD_ERR="Please add the following setting to your container:"
 
 # ######################################
 #  Functions
@@ -21,17 +25,23 @@ set -Eeuo pipefail
 
 configureDHCP() {
 
-  # Create a macvtap network for the VM guest
+  # Create the necessary file structure for /dev/vhost-net
+  if [ ! -c /dev/vhost-net ]; then
+    if mknod /dev/vhost-net c 10 238; then
+      chmod 660 /dev/vhost-net
+    fi
+  fi
 
+  # Create a macvtap network for the VM guest
   { ip link add link "$VM_NET_DEV" name "$VM_NET_TAP" address "$VM_NET_MAC" type macvtap mode bridge ; rc=$?; } || :
 
   if (( rc != 0 )); then
-    error "Cannot create macvtap interface. Please make sure the network type is 'macvlan' and not 'ipvlan',"
+    error "Cannot create macvtap interface. Please make sure that the network type is 'macvlan' and not 'ipvlan',"
-    error "and that the NET_ADMIN capability has been added to the container config: --cap-add NET_ADMIN" && exit 16
+    error "that your kernel is recent (>4) and supports it, and that the container has the NET_ADMIN capability set." && exit 16
   fi
 
   while ! ip link set "$VM_NET_TAP" up; do
-    info "Waiting for address to become available..."
+    info "Waiting for MAC address $VM_NET_MAC to become available..."
     sleep 2
   done
 
@@ -53,15 +63,13 @@ configureDHCP() {
   { exec 30>>"$TAP_PATH"; rc=$?; } 2>/dev/null || :
 
   if (( rc != 0 )); then
-    error "Cannot create TAP interface ($rc). Please add the following docker settings to your "
+    error "Cannot create TAP interface ($rc). $ADD_ERR --device-cgroup-rule='c *:* rwm'" && exit 21
-    error "container: --device-cgroup-rule='c $MAJOR:* rwm' --device=/dev/vhost-net" && exit 21
   fi
 
   { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
 
   if (( rc != 0 )); then
-    error "VHOST can not be found ($rc). Please add the following "
+    error "VHOST can not be found ($rc). $ADD_ERR --device=/dev/vhost-net" && exit 22
-    error "docker setting to your container: --device=/dev/vhost-net" && exit 22
   fi
 
   NET_OPTS="-netdev tap,id=hostnet0,vhost=on,vhostfd=40,fd=30"
@@ -69,7 +77,7 @@ configureDHCP() {
   return 0
 }
 
-configureDNS () {
+configureDNS() {
 
   # dnsmasq configuration:
   DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-range=$VM_NET_IP,$VM_NET_IP --dhcp-host=$VM_NET_MAC,,$VM_NET_IP,$VM_NET_HOST,infinite --dhcp-option=option:netmask,255.255.255.0"
@@ -80,90 +88,146 @@ configureDNS () {
 
   # Set DNS server and gateway
   DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-option=option:dns-server,${VM_NET_IP%.*}.1 --dhcp-option=option:router,${VM_NET_IP%.*}.1"
-  DNSMASQ_OPTS=$(echo "$DNSMASQ_OPTS" | sed 's/\t/ /g' | tr -s ' ' | sed 's/^ *//')
 
+  # Add DNS entry for container
+  DNSMASQ_OPTS="$DNSMASQ_OPTS --address=/host.lan/${VM_NET_IP%.*}.1"
+
+  DNSMASQ_OPTS=$(echo "$DNSMASQ_OPTS" | sed 's/\t/ /g' | tr -s ' ' | sed 's/^ *//')
   [[ "$DEBUG" == [Yy1]* ]] && set -x
-  $DNSMASQ ${DNSMASQ_OPTS:+ $DNSMASQ_OPTS}
+
+  if ! $DNSMASQ ${DNSMASQ_OPTS:+ $DNSMASQ_OPTS}; then
+    error "Failed to start dnsmasq, reason: $?" && exit 29
+  fi
   { set +x; } 2>/dev/null
   [[ "$DEBUG" == [Yy1]* ]] && echo
 
   return 0
 }
 
-configureNAT () {
+getPorts() {
+
+  local list=$1
+
+  [ -z "$list" ] && echo "" && return 0
+
+  if [[ "$list" != *","* ]]; then
+    echo " ! --dport $list"
+  else
+    echo " -m multiport ! --dports $list"
+  fi
+
+  return 0
+}
+
+configureNAT() {
+
+  # Create the necessary file structure for /dev/net/tun
+  if [ ! -c /dev/net/tun ]; then
+    [ ! -d /dev/net ] && mkdir -m 755 /dev/net
+    if mknod /dev/net/tun c 10 200; then
+      chmod 666 /dev/net/tun
+    fi
+  fi
+
+  if [ ! -c /dev/net/tun ]; then
+    error "TUN device missing. $ADD_ERR --device /dev/net/tun --cap-add NET_ADMIN" && exit 25
+  fi
+
+  # Check port forwarding flag
+  if [[ $(< /proc/sys/net/ipv4/ip_forward) -eq 0 ]]; then
+    { sysctl -w net.ipv4.ip_forward=1 > /dev/null; rc=$?; } || :
+    if (( rc != 0 )) || [[ $(< /proc/sys/net/ipv4/ip_forward) -eq 0 ]]; then
+      error "IP forwarding is disabled. $ADD_ERR --sysctl net.ipv4.ip_forward=1" && exit 24
+    fi
+  fi
+
+  local tables="The 'ip_tables' kernel module is not loaded. Try this command: sudo modprobe ip_tables iptable_nat"
+  local tuntap="The 'tun' kernel module is not available. Try this command: 'sudo modprobe tun' or run the container with 'privileged: true'."
 
   # Create a bridge with a static IP for the VM guest
 
   VM_NET_IP='20.20.20.21'
-  [[ "$DEBUG" == [Yy1]* ]] && set -x
 
   { ip link add dev dockerbridge type bridge ; rc=$?; } || :
 
   if (( rc != 0 )); then
-    error "Capability NET_ADMIN has not been set most likely. Please add the "
+    error "Failed to create bridge. $ADD_ERR --cap-add NET_ADMIN" && exit 23
-    error "following docker setting to your container: --cap-add NET_ADMIN" && exit 23
   fi
 
   ip address add ${VM_NET_IP%.*}.1/24 broadcast ${VM_NET_IP%.*}.255 dev dockerbridge
 
   while ! ip link set dockerbridge up; do
-    info "Waiting for address to become available..."
+    info "Waiting for IP address to become available..."
     sleep 2
   done
 
   # QEMU Works with taps, set tap to the bridge created
-  ip tuntap add dev "$VM_NET_TAP" mode tap
+  if ! ip tuntap add dev "$VM_NET_TAP" mode tap; then
+    error "$tuntap" && exit 31
+  fi
 
   while ! ip link set "$VM_NET_TAP" up promisc on; do
-    info "Waiting for tap to become available..."
+    info "Waiting for TAP to become available..."
     sleep 2
   done
 
   ip link set dev "$VM_NET_TAP" master dockerbridge
 
   # Add internet connection to the VM
-  iptables -t nat -A POSTROUTING -o "$VM_NET_DEV" -j MASQUERADE
+  update-alternatives --set iptables /usr/sbin/iptables-legacy > /dev/null
-  iptables -t nat -A PREROUTING -i "$VM_NET_DEV" -d "$IP" -p tcp  -j DNAT --to "$VM_NET_IP"
+  update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy > /dev/null
+
+  exclude=$(getPorts "$HOST_PORTS")
+
+  if ! iptables -t nat -A POSTROUTING -o "$VM_NET_DEV" -j MASQUERADE; then
+    error "$tables" && exit 30
+  fi
+
+  # shellcheck disable=SC2086
+  iptables -t nat -A PREROUTING -i "$VM_NET_DEV" -d "$IP" -p tcp${exclude} -j DNAT --to "$VM_NET_IP"
   iptables -t nat -A PREROUTING -i "$VM_NET_DEV" -d "$IP" -p udp  -j DNAT --to "$VM_NET_IP"
 
   if (( KERNEL > 4 )); then
     # Hack for guest VMs complaining about "bad udp checksums in 5 packets"
-    iptables -A POSTROUTING -t mangle -p udp --dport bootpc -j CHECKSUM --checksum-fill || true
+    iptables -A POSTROUTING -t mangle -p udp --dport bootpc -j CHECKSUM --checksum-fill > /dev/null 2>&1 || true
-  fi
-
-  { set +x; } 2>/dev/null
-  [[ "$DEBUG" == [Yy1]* ]] && echo
-
-  # Check port forwarding flag
-  if [[ $(< /proc/sys/net/ipv4/ip_forward) -eq 0 ]]; then
-    { sysctl -w net.ipv4.ip_forward=1 ; rc=$?; } || :
-    if (( rc != 0 )); then
-      error "Please add the following docker setting to your container: --sysctl net.ipv4.ip_forward=1" && exit 24
-    fi
   fi
 
   NET_OPTS="-netdev tap,ifname=$VM_NET_TAP,script=no,downscript=no,id=hostnet0"
 
-  { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
+  if [ -c /dev/vhost-net ]; then
-  (( rc == 0 )) && NET_OPTS="$NET_OPTS,vhost=on,vhostfd=40"
+    { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
+    (( rc == 0 )) && NET_OPTS="$NET_OPTS,vhost=on,vhostfd=40"
+  fi
 
   configureDNS
 
   return 0
 }
 
-closeNetwork () {
+closeNetwork() {
 
   if [[ "$DHCP" == [Yy1]* ]]; then
 
-    { pkill -f server.sh || true; } 2>/dev/null
+    # Shutdown nginx
+    nginx -s stop 2> /dev/null
+    fWait "nginx"
+
+  fi
+
+  [[ "$NETWORK" != [Yy1]* ]] && return 0
+
+  exec 30<&- || true
+  exec 40<&- || true
+
+  if [[ "$DHCP" == [Yy1]* ]]; then
 
     ip link set "$VM_NET_TAP" down || true
     ip link delete "$VM_NET_TAP" || true
 
   else
 
-    { pkill -f dnsmasq || true; } 2>/dev/null
+    local pid="/var/run/dnsmasq.pid"
+    [ -s "$pid" ] && pKill "$(<"$pid")"
 
     ip link set "$VM_NET_TAP" down promisc off || true
     ip link delete "$VM_NET_TAP" || true
@@ -172,58 +236,92 @@ closeNetwork () {
     ip link delete dockerbridge || true
 
   fi
+
+  return 0
+}
+
+getInfo() {
+
+  if [ -z "$VM_NET_DEV" ]; then
+    # Automaticly detect the default network interface
+    VM_NET_DEV=$(awk '$2 == 00000000 { print $1 }' /proc/net/route)
+    [ -z "$VM_NET_DEV" ] && VM_NET_DEV="eth0"
+  fi
+
+  if [ ! -d "/sys/class/net/$VM_NET_DEV" ]; then
+    error "Network interface '$VM_NET_DEV' does not exist inside the container!"
+    error "$ADD_ERR -e \"VM_NET_DEV=NAME\" to specify another interface name." && exit 27
+  fi
+
+  if [ -z "$VM_NET_MAC" ]; then
+    local file="$STORAGE/dsm.mac"
+    [ -s "$file" ] && VM_NET_MAC=$(<"$file")
+    if [ -z "$VM_NET_MAC" ]; then
+      # Generate MAC address based on Docker container ID in hostname
+      VM_NET_MAC=$(echo "$HOST" | md5sum | sed 's/^\(..\)\(..\)\(..\)\(..\)\(..\).*$/02:11:32:\3:\4:\5/')
+      echo "${VM_NET_MAC^^}" > "$file"
+    fi
+  fi
+
+  VM_NET_MAC="${VM_NET_MAC^^}"
+  VM_NET_MAC="${VM_NET_MAC//-/:}"
+
+  if [[ ${#VM_NET_MAC} == 12 ]]; then
+    m="$VM_NET_MAC"
+    VM_NET_MAC="${m:0:2}:${m:2:2}:${m:4:2}:${m:6:2}:${m:8:2}:${m:10:2}"
+  fi
+
+  if [[ ${#VM_NET_MAC} != 17 ]]; then
+    error "Invalid MAC address: '$VM_NET_MAC', should be 12 or 17 digits long!" && exit 28
+  fi
+
+  GATEWAY=$(ip r | grep default | awk '{print $3}')
+  IP=$(ip address show dev "$VM_NET_DEV" | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
+  echo "$IP" > /run/shm/qemu.ip
+
+  return 0
 }
 
 # ######################################
 #  Configure Network
 # ######################################
 
-{ pkill -f server.sh || true; } 2>/dev/null
+if [[ "$NETWORK" != [Yy1]* ]]; then
-
+  NET_OPTS=""
-# Create the necessary file structure for /dev/net/tun
+  return 0
-if [ ! -c /dev/net/tun ]; then
-  [ ! -d /dev/net ] && mkdir -m 755 /dev/net
-  mknod /dev/net/tun c 10 200
-  chmod 666 /dev/net/tun
 fi
 
-[ ! -c /dev/net/tun ] && error "TUN network interface not available..." && exit 25
+getInfo
-
+html "Initializing network..."
-# Create the necessary file structure for /dev/vhost-net
-if [ ! -c /dev/vhost-net ]; then
-  mknod /dev/vhost-net c 10 238
-  chmod 660 /dev/vhost-net
-fi
-
-update-alternatives --set iptables /usr/sbin/iptables-legacy > /dev/null
-update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy > /dev/null
-
-VM_NET_MAC="${VM_NET_MAC//-/:}"
-GATEWAY=$(ip r | grep default | awk '{print $3}')
-IP=$(ip address show dev "$VM_NET_DEV" | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
 
 if [[ "$DEBUG" == [Yy1]* ]]; then
-  info "Container IP is $IP with gateway $GATEWAY" && echo
+  info "Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC"
+  [ -f /etc/resolv.conf ] && grep '^nameserver*' /etc/resolv.conf
+  echo
+fi
+
+if [[ "$IP" == "172.17."* ]]; then
+  warn "your container IP starts with 172.17.* which will cause conflicts when you install the Container Manager package inside DSM!"
 fi
 
 if [[ "$DHCP" == [Yy1]* ]]; then
 
   if [[ "$GATEWAY" == "172."* ]]; then
-    if [[ "$DEBUG" == [Yy1]* ]]; then
+    warn "your gateway IP starts with 172.* which is often a sign that you are not on a macvlan network (required for DHCP)!"
-      info "Warning: Are you sure the container is on a macvlan network?"
-    else
-      error "You can only enable DHCP while the container is on a macvlan network!" && exit 26
-    fi
   fi
 
   # Configuration for DHCP IP
   configureDHCP
 
-  # Display IP on port 80 and 5000
+  MSG="Booting DSM instance..."
-  /run/server.sh 5000 /run/ip.sh &
+  html "$MSG"
 
 else
 
+  # Shutdown nginx
+  nginx -s stop 2> /dev/null
+  fWait "nginx"
+
   # Configuration for static IP
   configureNAT
 

src/power.sh

@@ -3,38 +3,135 @@ set -Eeuo pipefail
 
 # Configure QEMU for graceful shutdown
 
+API_CMD=6
+API_TIMEOUT=50
+API_HOST="127.0.0.1:2210"
+
+QEMU_TERM=""
 QEMU_PORT=7100
-QEMU_TIMEOUT=55
+QEMU_TIMEOUT=50
-QEMU_PID="/run/qemu.pid"
+QEMU_DIR="/run/shm"
-QEMU_COUNT="/run/qemu.count"
+QEMU_PID="$QEMU_DIR/qemu.pid"
+QEMU_LOG="$QEMU_DIR/qemu.log"
+QEMU_OUT="$QEMU_DIR/qemu.out"
+QEMU_END="$QEMU_DIR/qemu.end"
 
-rm -f "$QEMU_PID"
+if [[ "$KVM" == [Nn]* ]]; then
-rm -f "$QEMU_COUNT"
+  API_TIMEOUT=$(( API_TIMEOUT*2 ))
+  QEMU_TIMEOUT=$(( QEMU_TIMEOUT*2 ))
+fi
 
-_trap(){
+touch "$QEMU_LOG"
-    func="$1" ; shift
+
-    for sig ; do
+_trap() {
-        trap "$func $sig" "$sig"
+  func="$1" ; shift
+  for sig ; do
+    trap "$func $sig" "$sig"
+  done
+}
+
+finish() {
+
+  local pid
+  local reason=$1
+
+  touch "$QEMU_END"
+
+  if [ -s "$QEMU_PID" ]; then
+
+    pid=$(<"$QEMU_PID")
+    echo && error "Forcefully terminating QEMU process, reason: $reason..."
+    { kill -15 "$pid" || true; } 2>/dev/null
+
+    while isAlive "$pid"; do
+      sleep 1
+      # Workaround for zombie pid
+      [ ! -s "$QEMU_PID" ] && break
     done
+  fi
+
+  fKill "print.sh"
+  fKill "host.bin"
+
+  closeNetwork
+
+  sleep 1
+  echo && echo "❯ Shutdown completed!"
+
+  exit "$reason"
+}
+
+terminal() {
+
+  local dev=""
+
+  if [ -s "$QEMU_OUT" ]; then
+
+    local msg
+    msg=$(<"$QEMU_OUT")
+
+    if [ -n "$msg" ]; then
+
+      if [[ "${msg,,}" != "char"* ||  "$msg" != *"serial0)" ]]; then
+        echo "$msg"
+      fi
+
+      dev="${msg#*/dev/p}"
+      dev="/dev/p${dev%% *}"
+
+    fi
+  fi
+
+  if [ ! -c "$dev" ]; then
+    dev=$(echo 'info chardev' | nc -q 1 -w 1 localhost "$QEMU_PORT" | tr -d '\000')
+    dev="${dev#*serial0}"
+    dev="${dev#*pty:}"
+    dev="${dev%%$'\n'*}"
+    dev="${dev%%$'\r'*}"
+  fi
+
+  if [ ! -c "$dev" ]; then
+    error "Device '$dev' not found!"
+    finish 34 && return 34
+  fi
+
+  QEMU_TERM="$dev"
+  return 0
 }
 
 _graceful_shutdown() {
 
+  local code=$?
+  local pid url response
+
   set +e
-  local cnt response
 
-  [ ! -f "$QEMU_PID" ] && exit 130
+  if [ -f "$QEMU_END" ]; then
-  [ -f "$QEMU_COUNT" ] && return
+    echo && info "Received $1 signal while already shutting down..."
+    return
+  fi
 
-  echo 0 > "$QEMU_COUNT"
+  touch "$QEMU_END"
   echo && info "Received $1 signal, sending shutdown command..."
 
+  if [ ! -s "$QEMU_PID" ]; then
+    echo && error "QEMU PID file does not exist?"
+    finish "$code" && return "$code"
+  fi
+
+  pid=$(<"$QEMU_PID")
+
+  if ! isAlive "$pid"; then
+    echo && error "QEMU process does not exist?"
+    finish "$code" && return "$code"
+  fi
+
   # Don't send the powerdown signal because vDSM ignores ACPI signals
   # echo 'system_powerdown' | nc -q 1 -w 1 localhost "${QEMU_PORT}" > /dev/null
 
   # Send shutdown command to guest agent via serial port
-  url="http://127.0.0.1:2210/read?command=6&timeout=50"
+  url="http://$API_HOST/read?command=$API_CMD&timeout=$API_TIMEOUT"
-  response=$(curl -sk -m 52 -S "$url" 2>&1)
+  response=$(curl -sk -m "$(( API_TIMEOUT+2 ))" -S "$url" 2>&1)
 
   if [[ "$response" =~ "\"success\"" ]]; then
 
@@ -43,44 +140,46 @@ _graceful_shutdown() {
   else
 
     response="${response#*message\"\: \"}"
-    echo && error "Failed to send shutdown command: ${response%%\"*}"
+    [ -z "$response" ] && response="second signal"
-
+    echo && error "Forcefully terminating because of: ${response%%\"*}"
-    kill -15 "$(cat "$QEMU_PID")"
+    { kill -15 "$pid" || true; } 2>/dev/null
-    pkill -f qemu-system-x86_64 || true
 
   fi
 
-  while [ "$(cat $QEMU_COUNT)" -lt "$QEMU_TIMEOUT" ]; do
+  local cnt=0
 
-    # Try to connect to qemu
+  while [ "$cnt" -lt "$QEMU_TIMEOUT" ]; do
-    if ! echo 'info version'| nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 ; then
-      break
-    fi
 
-    # Increase the counter
+    ! isAlive "$pid" && break
-    cnt=$(($(cat $QEMU_COUNT)+1))
+
-    echo $cnt > "$QEMU_COUNT"
+    sleep 1
+    cnt=$((cnt+1))
 
     [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt/$QEMU_TIMEOUT)"
 
+    # Workaround for zombie pid
+    [ ! -s "$QEMU_PID" ] && break
+
   done
 
-  if [ "$(cat $QEMU_COUNT)" -ge "$QEMU_TIMEOUT" ]; then
+  if [ "$cnt" -ge "$QEMU_TIMEOUT" ]; then
-    echo && error "Shutdown timeout reached, forcefully quitting.."
+    echo && error "Shutdown timeout reached, aborting..."
   fi
 
-  echo && echo "❯ Quitting..."
+  finish "$code" && return "$code"
-  echo 'quit' | nc -q 1 -w 1 localhost "$QEMU_PORT" >/dev/null 2>&1 || true
-
-  { pkill -f print.sh || true; } 2>/dev/null
-  { pkill -f host.bin || true; } 2>/dev/null
-
-  closeNetwork
-  sleep 1
-
-  return
 }
 
-_trap _graceful_shutdown SIGTERM SIGHUP SIGINT SIGABRT SIGQUIT
+MON_OPTS="\
+        -pidfile $QEMU_PID \
+        -name $PROCESS,process=$PROCESS,debug-threads=on \
+        -monitor telnet:localhost:$QEMU_PORT,server,nowait,nodelay"
 
-MON_OPTS="-monitor telnet:localhost:$QEMU_PORT,server,nowait,nodelay"
+if [[ "$CONSOLE" != [Yy]* ]]; then
+
+  MON_OPTS="$MON_OPTS -daemonize -D $QEMU_LOG"
+
+  _trap _graceful_shutdown SIGTERM SIGHUP SIGINT SIGABRT SIGQUIT
+
+fi
+
+return 0

src/print.sh

@@ -1,19 +1,27 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-: ${DHCP:='N'}
+: "${DHCP:="N"}"
+: "${NETWORK:="Y"}"
+
+[[ "$NETWORK" != [Yy1]* ]] && exit 0
 
 info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n" >&2; }
 error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
 
-file="/run/dsm.url"
+file="/run/shm/dsm.url"
-shutdown="/run/qemu.count"
+info="/run/shm/msg.html"
+page="/run/shm/index.html"
+address="/run/shm/qemu.ip"
+shutdown="/run/shm/qemu.end"
+template="/var/www/index.html"
 url="http://127.0.0.1:2210/read?command=10"
 
 resp_err="Guest returned an invalid response:"
+curl_err="Failed to connect to guest: curl error"
 jq_err="Failed to parse response from guest: jq error"
 
-while [ ! -f  "$file" ]
+while [ ! -s  "$file" ]
 do
 
   # Check if not shutting down
@@ -22,13 +30,13 @@ do
   sleep 3
 
   [ -f "$shutdown" ] && exit 1
-  [ -f "$file" ] && break
+  [ -s "$file" ] && break
 
   # Retrieve network info from guest VM
   { json=$(curl -m 20 -sk "$url"); rc=$?; } || :
 
   [ -f "$shutdown" ] && exit 1
-  (( rc != 0 )) && error "Failed to connect to guest: curl error $rc" && continue
+  (( rc != 0 )) && error "$curl_err $rc" && continue
 
   { result=$(echo "$json" | jq -r '.status'); rc=$?; } || :
   (( rc != 0 )) && error "$jq_err $rc ( $json )" && continue
@@ -59,15 +67,28 @@ done
 
 [ -f "$shutdown" ] && exit 1
 
-location=$(cat "$file")
+location=$(<"$file")
 
 if [[ "$location" != "20.20"* ]]; then
 
   msg="http://$location"
+  title="<title>Virtual DSM</title>"
+  body="The location of DSM is <a href='http://$location'>http://$location</a>"
+  script="<script>setTimeout(function(){ window.location.assign('http://$location'); }, 3000);</script>"
+
+  HTML=$(<"$template")
+  HTML="${HTML/\[1\]/$title}"
+  HTML="${HTML/\[2\]/$script}"
+  HTML="${HTML/\[3\]/$body}"
+  HTML="${HTML/\[4\]/}"
+  HTML="${HTML/\[5\]/}"
+
+  echo "$HTML" > "$page"
+  echo "$body" > "$info"
 
 else
 
-  ip=$(ip address show dev eth0 | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
+  ip=$(<"$address")
   port="${location##*:}"
 
   if [[ "$ip" == "172."* ]]; then
@@ -83,3 +104,5 @@ info "-----------------------------------------------------------"
 info " You can now login to DSM at $msg"
 info "-----------------------------------------------------------"
 echo "" >&2
+
+exit 0

src/proc.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Docker environment variables
+
+: "${KVM:="Y"}"
+: "${HOST_CPU:=""}"
+: "${CPU_FLAGS:=""}"
+: "${CPU_MODEL:=""}"
+: "${DEF_MODEL:="qemu64"}"
+
+[ "$ARCH" != "amd64" ] && KVM="N"
+
+if [[ "$KVM" != [Nn]* ]]; then
+
+  KVM_ERR=""
+
+  if [ ! -e /dev/kvm ]; then
+    KVM_ERR="(device file missing)"
+  else
+    if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
+      KVM_ERR="(no write access)"
+    else
+      flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
+      if ! grep -qw "vmx\|svm" <<< "$flags"; then
+        KVM_ERR="(vmx/svm disabled)"
+      fi
+    fi
+  fi
+
+  if [ -n "$KVM_ERR" ]; then
+    KVM="N"
+    error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
+    error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
+    [[ "$DEBUG" != [Yy1]* ]] && exit 88
+  fi
+
+fi
+
+if [[ "$KVM" != [Nn]* ]]; then
+
+  CPU_FEATURES="kvm=on,l3-cache=on"
+  KVM_OPTS=",accel=kvm -enable-kvm -global kvm-pit.lost_tick_policy=discard"
+
+  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"
+    CPU_FEATURES="$CPU_FEATURES,+ssse3,+sse4.1,+sse4.2"
+  fi
+
+  if [ -z "$CPU_MODEL" ]; then
+    CPU_MODEL="host"
+    CPU_FEATURES="$CPU_FEATURES,migratable=no"
+  fi
+
+else
+
+  KVM_OPTS=""
+  CPU_FEATURES="l3-cache=on"
+
+  if [[ "$ARCH" == "amd64" ]]; then
+    KVM_OPTS=" -accel tcg,thread=multi"
+  fi
+
+  if [ -z "$CPU_MODEL" ]; then
+    if [[ "$ARCH" == "amd64" ]]; then
+      CPU_MODEL="max"
+      CPU_FEATURES="$CPU_FEATURES,migratable=no"
+    else
+      CPU_MODEL="$DEF_MODEL"
+    fi
+  fi
+
+  CPU_FEATURES="$CPU_FEATURES,+ssse3,+sse4.1,+sse4.2"
+
+fi
+
+if [ -z "$CPU_FLAGS" ]; then
+  if [ -z "$CPU_FEATURES" ]; then
+    CPU_FLAGS="$CPU_MODEL"
+  else
+    CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES"
+  fi
+else
+  if [ -z "$CPU_FEATURES" ]; then
+    CPU_FLAGS="$CPU_MODEL,$CPU_FLAGS"
+  else
+    CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES,$CPU_FLAGS"
+  fi
+fi
+
+if [ -z "$HOST_CPU" ]; then
+  HOST_CPU=$(lscpu | grep -m 1 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+fi
+
+if [ -n "$HOST_CPU" ]; then
+  HOST_CPU="${HOST_CPU%%,*},,"
+else
+  HOST_CPU="QEMU, Virtual CPU,"
+  if [ "$ARCH" == "amd64" ]; then
+    HOST_CPU="$HOST_CPU X86_64"
+  else
+    HOST_CPU="$HOST_CPU $ARCH"
+  fi
+fi
+
+return 0

src/progress.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+escape () {
+    local s
+    s=${1//&/\&}
+    s=${s//</\&lt;}
+    s=${s//>/\&gt;}
+    s=${s//'"'/\&quot;}
+    printf -- %s "$s"
+    return 0
+}
+
+file="$1"
+body=$(escape "$2")
+info="/run/shm/msg.html"
+
+if [[ "$body" == *"..." ]]; then
+  body="<p class=\"loading\">${body/.../}</p>"
+fi
+
+while true
+do
+  if [ -s "$file" ]; then
+    bytes=$(du -sb "$file" | cut -f1)
+    if (( bytes > 1000 )); then
+      size=$(echo "$bytes" | numfmt --to=iec --suffix=B  | sed -r 's/([A-Z])/ \1/')
+      echo "${body//(\[P\])/($size)}"> "$info"
+    fi
+  fi
+  sleep 1 & wait $!
+done

src/reset.sh

@@ -1,55 +1,175 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n"; }
+info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "${1:-}" "\E[0m\n"; }
-error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
+error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: ${1:-}" "\E[0m\n" >&2; }
+warn () { printf "%b%s%b" "\E[1;31m❯ " "Warning: ${1:-}" "\E[0m\n" >&2; }
 
 trap 'error "Status $? while: $BASH_COMMAND (line $LINENO/$BASH_LINENO)"' ERR
 
 [ ! -f "/run/entry.sh" ] && error "Script must run inside Docker container!" && exit 11
 [ "$(id -u)" -ne "0" ] && error "Script must be executed with root privileges." && exit 12
 
+echo "❯ Starting $APP for Docker v$(</run/version)..."
+echo "❯ For support visit $SUPPORT"
+
 # Docker environment variables
 
-: ${GPU:='N'}           # Disable GPU passthrough
+: "${TZ:=""}"             # System local timezone
-: ${KVM:='Y'}           # Enable KVM acceleration
+: "${DEBUG:="N"}"         # Disable debugging mode
-: ${DEBUG:='N'}         # Disable debugging mode
+: "${COUNTRY:=""}"        # Country code for mirror
-: ${COUNTRY:=''}        # Country code for mirror
+: "${CONSOLE:="N"}"       # Disable console mode
-: ${CONSOLE:='N'}       # Disable console mode
+: "${ALLOCATE:=""}"       # Preallocate diskspace
-: ${ALLOCATE:='Y'}      # Preallocate diskspace
+: "${ARGUMENTS:=""}"      # Extra QEMU parameters
-: ${ARGUMENTS:=''}      # Extra QEMU parameters
+: "${CPU_CORES:="1"}"     # Amount of CPU cores
-: ${CPU_CORES:='1'}     # Amount of CPU cores
+: "${RAM_SIZE:="1G"}"     # Maximum RAM amount
-: ${RAM_SIZE:='1G'}     # Maximum RAM amount
+: "${DISK_SIZE:="16G"}"   # Initial data disk size
-: ${DISK_SIZE:='16G'}   # Initial data disk size
 
 # Helper variables
 
-KERNEL=$(uname -r | cut -b 1)
+PROCESS="${APP,,}"
-MINOR=$(uname -r | cut -d '.' -f2)
+PROCESS="${PROCESS// /-}"
+
+STORAGE="/storage"
+INFO="/run/shm/msg.html"
+PAGE="/run/shm/index.html"
+TEMPLATE="/var/www/index.html"
+FOOTER1="$APP for Docker v$(</run/version)"
+FOOTER2="<a href='$SUPPORT'>$SUPPORT</a>"
+
+SYS=$(uname -r)
+HOST=$(hostname -s)
+KERNEL=$(echo "$SYS" | cut -b 1)
+MINOR=$(echo "$SYS" | cut -d '.' -f2)
 ARCH=$(dpkg --print-architecture)
-VERS=$(qemu-system-x86_64 --version | head -n 1 | cut -d '(' -f 1)
+RAM="$(free -g | grep Mem: | awk '{print $7}')/$(free -g | grep Mem: | awk '{print $2}') GB"
+CPU=$(lscpu | grep -m 1 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+
+# Check system
+
+if [ ! -d "/dev/shm" ]; then
+  error "Directory /dev/shm not found!" && exit 14
+else
+  [ ! -d "/run/shm" ] && ln -s /dev/shm /run/shm
+fi
 
 # Check folder
 
-STORAGE="/storage"
+if [ ! -d "$STORAGE" ]; then
-[ ! -d "$STORAGE" ] && error "Storage folder ($STORAGE) not found!" && exit 13
+  error "Storage folder ($STORAGE) not found!" && exit 13
+fi
+
+# Check filesystem
+FS=$(stat -f -c %T "$STORAGE")
+
+if [[ "${FS,,}" == "ecryptfs" ]] || [[ "${FS,,}" == "tmpfs" ]]; then
+  DISK_IO="threads"
+  DISK_CACHE="writeback"
+fi
+
+# Print system info
+SYS="${SYS/-generic/}"
+FS="${FS/ext2\/ext3/ext4}"
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
+SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
+
+echo "❯ CPU: ${CPU} | RAM: ${RAM} | DISK: $SPACE_GB GB (${FS}) | HOST: ${SYS}..."
+echo
 
 # Cleanup files
-
+rm -f /run/shm/qemu.*
-rm -f /run/dsm.url
+rm -f /run/shm/dsm.url
-rm -f /run/qemu.pid
-rm -f /run/qemu.count
 
 # Cleanup dirs
-
 rm -rf /tmp/dsm
-rm -f /tmp/server.*
 rm -rf "$STORAGE/tmp"
 
 # Helper functions
 
-getCountry () {
+isAlive() {
+  local pid=$1
 
+  if kill -0 "$pid" 2>/dev/null; then
+    return 0
+  fi
+
+  return 1
+}
+
+pKill() {
+  local pid=$1
+
+  { kill -15 "$pid" || true; } 2>/dev/null
+
+  while isAlive "$pid"; do
+    sleep 0.2
+  done
+
+  return 0
+}
+
+fWait() {
+  local name=$1
+
+  while pgrep -f -l "$name" >/dev/null; do
+    sleep 0.2
+  done
+
+  return 0
+}
+
+fKill() {
+  local name=$1
+
+  { pkill -f "$name" || true; } 2>/dev/null
+  fWait "$name"
+
+  return 0
+}
+
+escape () {
+    local s
+    s=${1//&/\&amp;}
+    s=${s//</\&lt;}
+    s=${s//>/\&gt;}
+    s=${s//'"'/\&quot;}
+    printf -- %s "$s"
+    return 0
+}
+
+html()
+{
+    local title
+    local body
+    local script
+    local footer
+
+    title=$(escape "$APP")
+    title="<title>$title</title>"
+    footer=$(escape "$FOOTER1")
+
+    body=$(escape "$1")
+    if [[ "$body" == *"..." ]]; then
+      body="<p class=\"loading\">${body/.../}</p>"
+    fi
+
+    [ -n "${2:-}" ] && script="$2" || script=""
+
+    local HTML
+    HTML=$(<"$TEMPLATE")
+    HTML="${HTML/\[1\]/$title}"
+    HTML="${HTML/\[2\]/$script}"
+    HTML="${HTML/\[3\]/$body}"
+    HTML="${HTML/\[4\]/$footer}"
+    HTML="${HTML/\[5\]/$FOOTER2}"
+
+    echo "$HTML" > "$PAGE"
+    echo "$body" > "$INFO"
+
+    return 0
+}
+
+getCountry() {
   local url=$1
   local query=$2
   local rc json result
@@ -68,18 +188,25 @@ getCountry () {
   return 0
 }
 
-setCountry () {
+setCountry() {
+
+  [[ "${TZ,,}" == "asia/harbin" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/beijing" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/urumqi" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/kashgar" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/shanghai" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/chongqing" ]] && COUNTRY="CN"
 
   [ -z "$COUNTRY" ] && getCountry "https://api.ipapi.is" ".location.country_code"
   [ -z "$COUNTRY" ] && getCountry "https://ifconfig.co/json" ".country_iso"
+  [ -z "$COUNTRY" ] && getCountry "https://api.ip2location.io" ".country_code"
   [ -z "$COUNTRY" ] && getCountry "https://ipinfo.io/json" ".country"
   [ -z "$COUNTRY" ] && getCountry "https://api.myip.com" ".cc"
 
   return 0
 }
 
-addPackage () {
+addPackage() {
-
   local pkg=$1
   local desc=$2
 
@@ -87,10 +214,8 @@ addPackage () {
     return 0
   fi
 
-  info "Installing $desc..."
+  MSG="Installing $desc..."
-
+  info "$MSG" && html "$MSG"
-  export DEBCONF_NOWARNINGS="yes"
-  export DEBIAN_FRONTEND="noninteractive"
 
   [ -z "$COUNTRY" ] && setCountry
 
@@ -98,10 +223,15 @@ addPackage () {
     sed -i 's/deb.debian.org/mirrors.ustc.edu.cn/g' /etc/apt/sources.list.d/debian.sources
   fi
 
-  apt-get -qq update
+  DEBIAN_FRONTEND=noninteractive apt-get -qq update
-  apt-get -qq --no-install-recommends -y install "$pkg" > /dev/null
+  DEBIAN_FRONTEND=noninteractive apt-get -qq --no-install-recommends -y install "$pkg" > /dev/null
 
   return 0
 }
 
+# Start webserver
+cp -r /var/www/* /run/shm
+html "Starting $APP for Docker..."
+nginx -e stderr
+
 return 0

src/serial.sh

@@ -3,11 +3,26 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${HOST_MAC:=''}
+: "${HOST_MAC:=""}"
-: ${HOST_DEBUG:=''}
+: "${HOST_DEBUG:=""}"
-: ${HOST_SERIAL:=''}
+: "${HOST_SERIAL:=""}"
-: ${HOST_MODEL:=''}
+: "${HOST_MODEL:=""}"
-: ${GUEST_SERIAL:=''}
+: "${GUEST_SERIAL:=""}"
+
+if [ -n "$HOST_MAC" ]; then
+
+  HOST_MAC="${HOST_MAC//-/:}"
+
+  if [[ ${#HOST_MAC} == 12 ]]; then
+    m="$HOST_MAC"
+    HOST_MAC="${m:0:2}:${m:2:2}:${m:4:2}:${m:6:2}:${m:8:2}:${m:10:2}"
+  fi
+
+  if [[ ${#HOST_MAC} != 17 ]]; then
+    error "Invalid HOST_MAC address: '$HOST_MAC', should be 12 or 17 digits long!" && exit 28
+  fi
+
+fi
 
 HOST_ARGS=()
 HOST_ARGS+=("-cpu=$CPU_CORES")
@@ -46,11 +61,14 @@ done
 
 # Configure serial ports
 
-SERIAL_OPTS="\
+if [[ "$CONSOLE" != [Yy]* ]]; then
-        -serial mon:stdio \
+  SERIAL_OPTS="-serial pty"
+else
+  SERIAL_OPTS="-serial mon:stdio"
+fi
+
+SERIAL_OPTS="$SERIAL_OPTS \
         -device virtio-serial-pci,id=virtio-serial0,bus=pcie.0,addr=0x3 \
-        -chardev pty,id=charserial0 \
-        -device isa-serial,chardev=charserial0,id=serial0 \
         -chardev socket,id=charchannel0,host=127.0.0.1,port=12345,reconnect=10 \
         -device virtserialport,bus=virtio-serial0.0,nr=1,chardev=charchannel0,id=channel0,name=vchannel"
 

src/server.sh

@@ -1,66 +0,0 @@
-#!/usr/bin/env bash
-set -eu
-
-TMP_FILE=$(mktemp -q /tmp/server.XXXXXX)
-
-stop() {
-  trap - SIGINT EXIT
-  { pkill -f socat || true; } 2>/dev/null
-  [ -f "$TMP_FILE" ] && rm -f "$TMP_FILE"
-}
-
-trap 'stop' EXIT SIGINT SIGTERM SIGHUP
-
-html()
-{
-    local h="<!DOCTYPE html><HTML><HEAD><TITLE>VirtualDSM</TITLE>"
-    h="$h<STYLE>body { color: white; background-color: #125bdb; font-family: Verdana,"
-    h="$h Arial,sans-serif; } a, a:hover, a:active, a:visited { color: white; }</STYLE></HEAD>"
-    h="$h<BODY><BR><BR><H1><CENTER>$1</CENTER></H1></BODY></HTML>"
-
-    echo "$h"
-}
-
-if [[ "$2" != "/"* ]]; then
-
-  BODY="$2"
-
-  if [[ "$BODY" == "install" ]]; then
-    BODY="Please wait while Virtual DSM is being installed..."
-    BODY="$BODY<script>setTimeout(() => { document.location.reload(); }, 9999);</script>"
-  fi
-
-  HTML=$(html "$BODY")
-  printf '%b' "HTTP/1.1 200 OK\nContent-Length: ${#HTML}\nConnection: close\n\n$HTML" > "$TMP_FILE"
-
-  socat TCP4-LISTEN:80,reuseaddr,fork,crlf SYSTEM:"cat $TMP_FILE" 2> /dev/null &
-  socat TCP4-LISTEN:"${1:-5000}",reuseaddr,fork,crlf SYSTEM:"cat $TMP_FILE" 2> /dev/null & wait $!
-  
-  exit
-  
-fi
-
-if [[ "$2" != "/run/ip.sh" ]]; then
-
-  cp "$2" "$TMP_FILE"
-
-else
-
-  BODY="The location of DSM is <a href='http://\$LOCATION'>http://\$LOCATION</a><script>"
-  BODY="$BODY setTimeout(function(){ window.location.assign('http://\$LOCATION'); }, 3000);</script>"
-  WAIT="Please wait while discovering IP...<script>setTimeout(() => { document.location.reload(); }, 4999);</script>"
-
-  HTML=$(html "xxx")
-
-  { echo "#!/bin/bash"
-    echo "[ -f \"/run/dsm.url\" ] && LOCATION=\$(cat \"/run/dsm.url\")"
-    echo "HTML=\"$HTML\"; [ -z \"\$LOCATION\" ] && BODY=\"$WAIT\" || BODY=\"$BODY\"; HTML=\${HTML/xxx/\$BODY}"
-    echo "printf '%b' \"HTTP/1.1 200 OK\\nContent-Length: \${#HTML}\\nConnection: close\\n\\n\$HTML\""
-  } > "$TMP_FILE"
-
-fi
-
-chmod +x "$TMP_FILE"
-  
-socat TCP4-LISTEN:80,reuseaddr,fork,crlf SYSTEM:"$TMP_FILE" 2> /dev/null &
-socat TCP4-LISTEN:"${1:-5000}",reuseaddr,fork,crlf SYSTEM:"$TMP_FILE" 2> /dev/null & wait $!

web/css/style.css

@@ -0,0 +1,167 @@
+body {
+	color: white;
+	background-color: #125bdb;
+	font-smoothing: antialiased;
+	-webkit-font-smoothing: antialiased;
+	-moz-osx-font-smoothing: grayscale;
+	font-family: Verdana, Geneva, sans-serif;
+}
+
+#info {
+	text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.25);
+}
+
+#content {
+	text-align: center;
+	padding: 20px;
+	margin-top: 50px;
+}
+
+footer {
+	width: 98%;
+	position: fixed;
+	bottom: 0px;
+	height: 40px;
+	text-align: center;
+	color: #0c8aeb;
+	text-shadow: 0 0 1px #0c8aeb;
+}
+
+#empty {
+	height: 40px;
+	/* Same height as footer */
+}
+
+a,
+a:hover,
+a:active,
+a:visited {
+	color: white;
+}
+
+footer a:link,
+footer a:visited,
+footer a:active {
+	color: #0c8aeb;
+}
+
+footer a:hover {
+	color: #73e6ff;
+}
+
+.loading:after {
+	content: " .";
+	animation: dots 1s steps(5, end) infinite;
+}
+
+@keyframes dots {
+
+	0%,
+	20% {
+		color: rgba(0, 0, 0, 0);
+		text-shadow: 0.25em 0 0 rgba(0, 0, 0, 0), 0.5em 0 0 rgba(0, 0, 0, 0);
+	}
+
+	40% {
+		color: white;
+		text-shadow: 0.25em 0 0 rgba(0, 0, 0, 0), 0.5em 0 0 rgba(0, 0, 0, 0);
+	}
+
+	60% {
+		text-shadow: 0.25em 0 0 white, 0.5em 0 0 rgba(0, 0, 0, 0);
+	}
+
+	80%,
+	100% {
+		text-shadow: 0.25em 0 0 white, 0.5em 0 0 white;
+	}
+}
+
+.spinner_LWk7 {
+	animation: spinner_GWy6 1.2s linear infinite, spinner_BNNO 1.2s linear infinite
+}
+
+.spinner_yOMU {
+	animation: spinner_GWy6 1.2s linear infinite, spinner_pVqn 1.2s linear infinite;
+	animation-delay: .15s
+}
+
+.spinner_KS4S {
+	animation: spinner_GWy6 1.2s linear infinite, spinner_6uKB 1.2s linear infinite;
+	animation-delay: .3s
+}
+
+.spinner_zVee {
+	animation: spinner_GWy6 1.2s linear infinite, spinner_Qw4x 1.2s linear infinite;
+	animation-delay: .45s
+}
+
+@keyframes spinner_GWy6 {
+
+	0%,
+	50% {
+		width: 9px;
+		height: 9px
+	}
+
+	10% {
+		width: 11px;
+		height: 11px
+	}
+}
+
+@keyframes spinner_BNNO {
+
+	0%,
+	50% {
+		x: 1.5px;
+		y: 1.5px
+	}
+
+	10% {
+		x: .5px;
+		y: .5px
+	}
+}
+
+@keyframes spinner_pVqn {
+
+	0%,
+	50% {
+		x: 13.5px;
+		y: 1.5px
+	}
+
+	10% {
+		x: 12.5px;
+		y: .5px
+	}
+}
+
+@keyframes spinner_6uKB {
+
+	0%,
+	50% {
+		x: 13.5px;
+		y: 13.5px
+	}
+
+	10% {
+		x: 12.5px;
+		y: 12.5px
+	}
+}
+
+@keyframes spinner_Qw4x {
+
+	0%,
+	50% {
+		x: 1.5px;
+		y: 13.5px
+	}
+
+	10% {
+		x: .5px;
+		y: 12.5px
+	}
+}

web/img/favicon.svg

@@ -0,0 +1 @@
+<svg id="Capa_1" enable-background="new 0 0 511.962 511.962" height="512" viewBox="0 0 511.962 511.962" width="512" xmlns="http://www.w3.org/2000/svg"><g><path d="m489.965 120.063c0-5.77-3.31-11.028-8.512-13.524l-218.984-105.063c-4.102-1.967-8.875-1.967-12.977 0l-218.985 105.063c-5.202 2.496-8.511 7.755-8.511 13.524l-.003 271.834c0 5.77 3.31 11.028 8.512 13.524l218.989 105.064c2.051.983 4.27 1.476 6.488 1.476 2.219 0 4.438-.492 6.488-1.476l218.989-105.064c5.202-2.496 8.512-7.755 8.512-13.524z" fill="#4e6ba6"/><path d="m489.965 120.063c0-5.77-3.31-11.028-8.512-13.524l-218.984-105.063c-2.051-.984-4.269-1.476-6.488-1.476v511.962c2.219 0 4.438-.492 6.488-1.476l218.989-105.064c5.202-2.496 8.512-7.755 8.512-13.524z" fill="#28487a"/><path d="m425.812 160.441c0-2.27-.519-4.457-1.457-6.432l-336.701-.095c-.967 1.999-1.504 4.22-1.504 6.526l-.002 191.081c0 5.769 3.31 11.028 8.512 13.524l154.833 74.285c2.051.983 4.27 1.476 6.488 1.476 2.219 0 4.438-.492 6.488-1.476l154.834-74.285c5.202-2.496 8.512-7.755 8.512-13.524z" fill="#8dc2eb"/><path d="m424.354 154.009h-168.373v286.798c2.219 0 4.438-.492 6.488-1.476l154.834-74.285c5.202-2.496 8.512-7.755 8.512-13.524l-.003-191.081c0-2.27-.52-4.458-1.458-6.432z" fill="#5e9ff6"/><path d="m417.3 146.916-154.831-74.284c-4.102-1.967-8.875-1.967-12.977 0l-154.831 74.284c-3.122 1.498-5.555 3.996-7.007 6.998l168.328 80.812 168.374-80.717c-1.448-3.044-3.9-5.579-7.056-7.093z" fill="#ecf9fd"/><path d="m417.3 146.916-154.831-74.284c-2.051-.983-4.27-1.476-6.488-1.476v163.569l168.374-80.717c-1.447-3.043-3.899-5.578-7.055-7.092z" fill="#d9f3fc"/></g></svg>

web/index.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+
+    <head>
+        [1]
+        <meta http-equiv="Cache-Control" content="no-cache" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <link rel="stylesheet" type="text/css" href="/css/style.css" />
+        <link rel="icon" href="/img/favicon.svg" type="image/x-icon">
+        [2]
+    </head>
+
+    <body>
+        <div id="page">
+            <div id="content">
+                <svg id="spinner" width="64" height="64" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+                    <rect class="spinner_LWk7" fill="#0c8aeb" x="1.5" y="1.5" rx="1" width="9" height="9"/>
+                    <rect class="spinner_yOMU" fill="#0c8aeb" x="13.5" y="1.5" rx="1" width="9" height="9"/>
+                    <rect class="spinner_KS4S" fill="#0c8aeb" x="13.5" y="13.5" rx="1" width="9" height="9"/>
+                    <rect class="spinner_zVee" fill="#0c8aeb" x="1.5" y="13.5" rx="1" width="9" height="9"/>
+                </svg>
+                <h1 id="info">[3]</h1>
+            </div>
+            <div id="empty">
+            </div>
+            <footer id="footer">
+                [4]<br />
+                [5]
+            </footer>
+        </div>
+        <script type="text/javascript" src="/js/script.js"></script>
+    </body>
+
+</html>

web/js/script.js

@@ -0,0 +1,130 @@
+var request;
+var interval = 1000;
+
+function getInfo() {
+
+    var url = "/msg.html";
+
+    try {
+
+        if (window.XMLHttpRequest) {
+            request = new XMLHttpRequest();
+        } else {
+            throw "XMLHttpRequest not available!";
+        }
+
+        request.onreadystatechange = processInfo;
+        request.open("GET", url, true);
+        request.send();
+
+    } catch (e) {
+        var err = "Error: " + e.message;
+        console.log(err);
+        setError(err);
+    }
+}
+
+function processInfo() {
+    try {
+        if (request.readyState != 4) {
+            return true;
+        }
+
+        var msg = request.responseText;
+        if (msg == null || msg.length == 0) {
+            setInfo("Booting DSM instance", true);
+            schedule();
+            return false;
+        }
+
+        var notFound = (request.status == 404);
+
+        if (request.status == 200) {
+            if (msg.toLowerCase().indexOf("<html>") !== -1) {
+                notFound = true;
+            } else {
+                if (msg.toLowerCase().indexOf("href=") !== -1) {
+                    var div = document.createElement("div");
+                    div.innerHTML = msg;
+                    var url = div.querySelector("a").href;
+                    setTimeout(() => {
+                        window.location.assign(url);
+                    }, 3000);
+                    setInfo(msg);
+                    return true;
+                } else {
+                    setInfo(msg);
+                    schedule();
+                    return true;
+                }
+            }
+        }
+
+        if (notFound) {
+            setInfo("Connecting to web portal", true);
+            reload();
+            return true;
+        }
+
+        setError("Error: Received statuscode " + request.status);
+        schedule();
+        return false;
+
+    } catch (e) {
+        var err = "Error: " + e.message;
+        console.log(err);
+        setError(err);
+        return false;
+    }
+}
+
+function setInfo(msg, loading, error) {
+
+    try {
+        if (msg == null || msg.length == 0) {
+            return false;
+        }
+
+        var el = document.getElementById("spinner");
+
+        error = !!error;
+        if (!error) {
+            el.style.visibility = 'visible';
+        } else {
+            el.style.visibility = 'hidden';
+        }
+
+        loading = !!loading;
+        if (loading) {
+            msg = "<p class=\"loading\">" + msg + "</p>";
+        }
+
+        el = document.getElementById("info");
+
+        if (el.innerHTML != msg) {
+            el.innerHTML = msg;
+        }
+
+        return true;
+
+    } catch (e) {
+        console.log("Error: " + e.message);
+        return false;
+    }
+}
+
+function setError(text) {
+    return setInfo(text, false, true);
+}
+
+function schedule() {
+    setTimeout(getInfo, interval);
+}
+
+function reload() {
+    setTimeout(() => {
+        document.location.reload();
+    }, 3000);
+}
+
+schedule();

web/nginx.conf

@@ -0,0 +1,31 @@
+server {
+    listen 80;
+    listen 5000 default_server;
+
+    autoindex on;
+    tcp_nodelay on;
+    server_tokens off;
+    absolute_redirect off;
+
+    error_log /dev/null;
+    access_log /dev/null;
+
+    include /etc/nginx/mime.types;
+
+    gzip on;
+    gzip_vary on;
+    gzip_proxied any;
+    gzip_comp_level 5;
+    gzip_min_length 500;
+    gzip_disable "msie6";
+    gzip_types text/css text/javascript text/xml text/plain text/x-component application/javascript application/json application/xml application/rss+xml font/truetype font/opentype application/vnd.ms-fontobject image/svg+xml;
+
+    add_header Cache-Control "no-cache";
+
+    location / {
+
+      root /run/shm;
+      index index.html;
+
+    }
+}