feat: Add automatic device type (#749)

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/1-issue.yml

@@ -0,0 +1,39 @@
+name: "\U0001F6A8 Technical issue"
+description: When you're experiencing problems using the container
+body:
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: Your Linux distribution (can be shown by `lsb_release -a`).
+      placeholder: e.g. Ubuntu 24.04
+    validations:
+      required: true
+  - type: textarea
+    id: summary
+    attributes:
+      label: Description
+      description: A clear and concise description of your issue.
+    validations:
+      required: true
+  - type: textarea
+    id: compose
+    attributes:
+      label: Docker compose
+      description: The compose file (or otherwise the `docker run` command used).
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Docker log
+      description: The logfile of the container (as shown by `docker logs dsm`).
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: Screenshots (optional)
+      description: Screenshots that might help to make the problem more clear.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/2-feature.yml

@@ -0,0 +1,37 @@
+name: "\U0001F680 Feature request"
+description: Suggest an idea for improving the container
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - 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/3-bug.yml

@@ -0,0 +1,41 @@
+name: "\U0001F41E Bug report"
+description: Create a report to help us improve the container
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: Your Linux distribution (can be shown by `lsb_release -a`).
+      placeholder: e.g. Ubuntu 24.04
+    validations:
+      required: true
+  - type: textarea
+    id: summary
+    attributes:
+      label: Description
+      description: Describe the expected behaviour, the actual behaviour, and the steps to reproduce.
+    validations:
+      required: true
+  - type: textarea
+    id: compose
+    attributes:
+      label: Docker compose
+      description: The compose file (or otherwise the `docker run` command used).
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Docker log
+      description: The logfile of the container (as shown by `docker logs dsm`).
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: Screenshots (optional)
+      description: Screenshots that might help to make the problem more clear.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/4-question.yml

@@ -0,0 +1,26 @@
+name: "\U00002753 General question"
+description: Questions about the container not related to an issue
+title: "[Question]: "
+labels: ["question"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is your question not already answered in the FAQ?
+      description: Please read the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md) carefully to avoid asking duplicate questions.
+      options:
+      - label: I made sure the question is not listed in the [FAQ](https://github.com/vdsm/virtual-dsm/blob/master/readme.md).
+        required: true
+  - type: checkboxes
+    attributes:
+      label: Is this a general question and not a technical issue?
+      description: For questions related to issues you must use the [technical issue](https://github.com/vdsm/virtual-dsm/issues/new?assignees=&labels=&projects=&template=1-issue.yml) form instead. It contains all the right fields (system info, logfiles, etc.) we need in order to be able to help you.
+      options:
+      - label: I am sure my question is not about a technical issue.
+        required: true
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What's the question you have about the container?
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.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:
-        SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2002 -e SC2223 -e SC2034 -e SC2064 -e SC2317 -e SC2153 -e SC2028
+          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,4 +1,4 @@
-FROM qemux/qemu-host as builder
+FROM qemux/qemu-host:2.04 as builder
 
 #  FROM golang as builder
 #  WORKDIR /
@@ -10,12 +10,15 @@ FROM qemux/qemu-host as builder
 FROM debian:trixie-slim
 
 ARG TARGETPLATFORM
+ARG VERSION_ARG="0.0"
 ARG DEBCONF_NOWARNINGS="yes"
-ARG DEBIAN_FRONTEND noninteractive
+ARG DEBIAN_FRONTEND="noninteractive"
+ARG DEBCONF_NONINTERACTIVE_SEEN="true"
 
-RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
+RUN set -eu && extra="" && \
-    && apt-get update \
+    if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi && \
-    && apt-get --no-install-recommends -y install \
+    apt-get update && \
+    apt-get --no-install-recommends -y install \
         jq \
         tini \
         curl \
@@ -23,11 +26,12 @@ RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
         wget \
         fdisk \
         unzip \
-        socat \
+        nginx \
         procps \
         xz-utils \
         iptables \
         iproute2 \
+        apt-utils \
         dnsmasq \
         fakeroot \
         net-tools \
@@ -35,13 +39,17 @@ RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi \
         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 && \
+    echo "$VERSION_ARG" > /run/version && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
-COPY ./src /run/
+COPY --chmod=755 ./src /run/
-COPY --from=builder /qemu-host.bin /run/host.bin
+COPY --chmod=755 ./web /var/www/
-RUN chmod +x /run/*.sh && chmod +x /run/*.bin
+COPY --chmod=755 --from=builder /qemu-host.bin /run/host.bin
+COPY --chmod=744 ./web/nginx.conf /etc/nginx/sites-enabled/web.conf
 
 VOLUME /storage
 EXPOSE 22 139 445 5000
@@ -50,9 +58,6 @@ ENV RAM_SIZE "1G"
 ENV DISK_SIZE "16G"
 ENV CPU_CORES "1"
 
-ARG VERSION_ARG="0.0"
-RUN echo "$VERSION_ARG" > /run/version
-
 HEALTHCHECK --interval=60s --start-period=45s --retries=2 CMD /run/check.sh
 
 ENTRYPOINT ["/usr/bin/tini", "-s", "/run/entry.sh"]

compose.yml

@@ -1,21 +1,15 @@
-version: "3"
 services:
     dsm:
         container_name: dsm
         image: vdsm/virtual-dsm:latest
         environment:
             DISK_SIZE: "16G"
-            RAM_SIZE: "1G"
-            CPU_CORES: "1"
         devices:
             - /dev/kvm
-        device_cgroup_rules:
-            - 'c *:* rwm'
         cap_add:
             - NET_ADMIN
         ports:
             - 5000:5000
         volumes:
             - /var/dsm:/storage
-        restart: on-failure
         stop_grace_period: 2m

kubernetes.yml

@@ -0,0 +1,58 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: dsm-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 16Gi
+---
+apiVersion: v1
+kind: Pod
+metadata:
+  name: dsm
+  labels:
+    name: dsm
+spec:
+  terminationGracePeriodSeconds: 120 # the Kubernetes default is 30 seconds and it may be not enough
+  containers:
+    - name: dsm
+      image: vdsm/virtual-dsm
+      ports:
+        - containerPort: 5000
+          protocol: TCP
+      resources:
+        limits:
+          devices.kubevirt.io/kvm: 1
+      securityContext:
+        privileged: true
+      env:
+        - name: RAM_SIZE
+          value: 1G
+        - name: CPU_CORES
+          value: "1"
+        - name: DISK_SIZE
+          value: "16G"  # Kubernetes uses Gi, but DSM uses GB
+      volumeMounts:
+        - mountPath: /storage
+          name: storage
+  volumes:
+    - name: storage
+      persistentVolumeClaim:
+        claimName: dsm-pvc
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: dsm
+spec:
+  type: NodePort
+  selector:
+    name: dsm
+  ports:
+    - name: tcp-5000
+      port: 5000
+      targetPort: 5000
+      nodePort: 31150

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,23 @@
 
 </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:
@@ -40,19 +38,45 @@ services:
       - 5000:5000
     volumes:
       - /var/dsm:/storage
-    restart: on-failure
     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 -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
+```
+
+Via Kubernetes:
+
+```shell
+kubectl apply -f kubernetes.yml
 ```
 
 ## FAQ
 
-  * ### How do I change the size of the virtual disk?
+* ### How do I use it?
+
+  Very simple! These are the steps:
+  
+  - Start the container and connect to [port 5000](http://localhost:5000) using your web browser.
+
+  - Wait until DSM is ready, choose an username and password, and you will be taken to the desktop.
+  
+  Enjoy your brand new machine, and don't forget to star this repo!
+
+* ### How do I change the storage location?
+
+  To change the storage location, include the following bind mount in your compose file:
+
+  ```yaml
+  volumes:
+    - /var/dsm:/storage
+  ```
+
+  Replace the example path `/var/dsm` with the desired storage folder.
+ 
+* ### How do I change the size of the disk?
 
   To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
 
@@ -63,16 +87,18 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
   
   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 create a growable disk?
 
-    To change the location of the virtual disk, include the following bind mount in your compose file:
+  By default, the entire capacity of the disk is reserved in advance.
+
+  To create a growable disk that only allocates space that is actually used, add the following environment variable:
 
   ```yaml
-    volumes:
+  environment:
-      - /var/dsm:/storage
+    DISK_FMT: "qcow2"
   ```
 
-    Replace the example path `/var/dsm` with the desired storage folder.
+  Please note that this may reduce the write performance of the disk.
 
 * ### How do I add multiple disks?
 
@@ -87,25 +113,26 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
     - /mnt/data/example:/storage3
   ```
 
-  * ### How do I create a growable disk?
+* ### How do I pass-through a disk?
 
-    By default, the entire capacity of the disk is reserved in advance.
+   It is possible to pass-through a disk device directly, by adding it to your compose file in this way:
-
-    To create a growable disk that only allocates space that is actually used, add the following environment variables:
 
   ```yaml
-    environment:
+  devices:
-      ALLOCATE: "N"
+    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/disk2
-      DISK_FMT: "qcow2"
   ```
 
-    Please note that this may reduce the write performance of the disk.
+  Make sure to bind the disk via its UUID (obtainable via `lsblk -o name,uuid`) instead of its name (`/dev/sdc`), to prevent ever binding the wrong disk when the drive letters happen to change. 
 
-  * ### How do I increase the amount of CPU or RAM?
+  Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
 
-    By default, a single core and 1 GB of RAM are allocated to the container.
+  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.
 
-    To increase this, add the following environment variables:
+* ### How do I change the amount of CPU or RAM?
+
+  By default, the container will be allowed to use a maximum of 1 CPU core and 1 GB of RAM.
+
+  If you want to adjust this, you can specify the desired amount using the following environment variables:
 
   ```yaml
   environment:
@@ -156,28 +183,30 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
       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.
+  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.
 
-  * ### How can the container acquire an IP address from my router?
+* ### How can DSM acquire an IP address from my router?
 
   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.
 
-    To enable this feature, add the following lines to your compose file:
+  To enable this mode, add the following lines to your compose file:
 
   ```yaml
   environment:
     DHCP: "Y"
+  devices:
+    - /dev/vhost-net
   device_cgroup_rules:
     - 'c *:* rwm'
   ```
 
-    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.
+  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.
 
-  * ### How do I passthrough the GPU?
+* ### How do I pass-through the GPU?
 
-    To passthrough your Intel GPU, add the following lines to your compose file:
+  To pass-through your Intel GPU, add the following lines to your compose file:
 
   ```yaml
   environment:
@@ -190,7 +219,7 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
 * ### How do I install a specific version of vDSM?
 
-    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:
+  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:
@@ -199,6 +228,15 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
   With this method, it is even possible to switch between different versions while keeping all your file data intact.
 
+  If you don't have internet access, it's also possible to skip the download by setting URL to:
+
+  ```yaml
+  environment:
+    URL: "DSM_VirtualDSM_42218.pat"
+  ```
+
+  after placing a file called `DSM_VirtualDSM_42218.pat` in your `/storage` folder.
+
 * ### 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.
@@ -207,7 +245,10 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
   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 project on an official Synology NAS, as any other use will be a violation of their terms and conditions.
+  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
 
@@ -219,5 +260,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,15 +1,18 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-[ -f "/run/qemu.end" ] && echo "QEMU is shutting down.." && exit 1
+: "${NETWORK:="Y"}"
-[ ! -f "/run/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
 
-file="/run/dsm.url"
+[ -f "/run/shm/qemu.end" ] && echo "QEMU is shutting down.." && exit 1
-address="/run/qemu.ip"
+[ ! -s "/run/shm/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
+[[ "$NETWORK" != [Yy1]* ]] && echo "Networking is disabled.." && exit 0
 
-[ ! -f  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+file="/run/shm/dsm.url"
+address="/run/shm/qemu.ip"
 
-location=$(cat "$file")
+[ ! -s  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+
+location=$(<"$file")
 
 if ! curl -m 20 -ILfSs "http://$location/" > /dev/null; then
 
@@ -19,7 +22,7 @@ if ! curl -m 20 -ILfSs "http://$location/" > /dev/null; then
     echo "Failed to reach DSM at port $port"
   else
     echo "Failed to reach DSM at http://$location"
-    ip="$(cat "$address")"
+    ip=$(<"$address")
   fi
 
   echo "You might need to whitelist IP $ip in the DSM firewall." && exit 1

src/config.sh

@@ -2,9 +2,9 @@
 set -Eeuo pipefail
 
 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')
+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,smm=off,usb=off,vmport=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
 DEV_OPTS="-device virtio-balloon-pci,id=balloon0,bus=pcie.0,addr=0x4"
 DEV_OPTS="$DEV_OPTS -object rng-random,id=objrng0,filename=/dev/urandom"
 DEV_OPTS="$DEV_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
@@ -12,4 +12,26 @@ DEV_OPTS="$DEV_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0
 ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $DEV_OPTS $ARGUMENTS"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')
 
+# Check available memory as the very last step
+
+if [[ "$RAM_CHECK" != [Nn]* ]]; then
+
+  RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
+  AVAIL_GB=$(( RAM_AVAIL/1073741824 ))
+
+  if (( (RAM_WANTED + RAM_SPARE) > RAM_AVAIL )); then
+    error "Your configured RAM_SIZE of $WANTED_GB GB is too high for the $AVAIL_GB GB of memory available, please set a lower value."
+    exit 17
+  fi
+
+  if (( (RAM_WANTED + (RAM_SPARE * 3)) > RAM_AVAIL )); then
+    warn "your configured RAM_SIZE of $WANTED_GB GB is very close to the $AVAIL_GB GB of memory available, please consider a lower value."
+  fi
+
+fi
+
+if [[ "$DEBUG" == [Yy1]* ]]; then
+  printf "Arguments:\n\n%s" "${ARGS// -/$'\n-'}" && echo
+fi
+
 return 0

src/disk.sh

@@ -3,27 +3,19 @@ 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_FLAGS:=''}             # Specifies the options for use with the qcow2 disk format
+: "${DISK_TYPE:=""}"              # Device type to be used, choose "ide", "usb", "blk" or "scsi"
-: ${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_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=io2 \
-    -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=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"
 
 fmt2ext() {
   local DISK_FMT=$1
@@ -61,8 +53,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)
@@ -80,13 +72,23 @@ getSize() {
 isCow() {
   local FS=$1
 
-  if [[ "${FS,,}" == "xfs" || "${FS,,}" == "zfs" || "${FS,,}" == "btrfs" || "${FS,,}" == "bcachefs" ]]; then
+  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
@@ -112,8 +114,10 @@ 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..."
-  local FAIL="Could not create a $DISK_TYPE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
+  info "Creating a $DISK_SPACE $DISK_STYLE $DISK_DESC image in $DISK_FMT format..."
+
+  local FAIL="Could not create a $DISK_STYLE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
@@ -195,8 +199,10 @@ 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..."
-  local FAIL="Could not resize the $DISK_TYPE $DISK_FMT $DISK_DESC image from ${GB}G to $DISK_SPACE ($DISK_FILE)"
+  info "$MSG" && html "$MSG"
+
+  local FAIL="Could not resize the $DISK_STYLE $DISK_FMT $DISK_DESC image from ${GB}G to $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
@@ -262,6 +268,7 @@ 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"
@@ -278,7 +285,7 @@ convertDisk() {
   # shellcheck disable=SC2086
   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
+    error "Failed to convert $DISK_STYLE $DISK_DESC image to $DST_FMT format in $DIR, is there enough space available?" && exit 79
   fi
 
   if [[ "$DST_FMT" == "raw" ]]; then
@@ -301,6 +308,7 @@ convertDisk() {
     fi
   fi
 
+  html "Conversion of $DISK_DESC completed..."
   info "Conversion of $DISK_DESC to $DST_FMT completed succesfully!"
 
   return 0
@@ -323,6 +331,10 @@ checkFS () {
     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")
@@ -335,17 +347,64 @@ checkFS () {
   return 0
 }
 
+createDevice () {
+  local DISK_FILE=$1
+  local DISK_TYPE=$2
+  local DISK_INDEX=$3
+  local DISK_ADDRESS=$4
+  local DISK_FMT=$5
+  local DISK_IO=$6
+  local DISK_CACHE=$7
+  local DISK_ID="data$DISK_INDEX"
+
+  local index=""
+  [ -n "$DISK_INDEX" ] && index=",bootindex=$DISK_INDEX"
+  local result="-drive file=$DISK_FILE,id=$DISK_ID,format=$DISK_FMT,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on"
+
+  case "${DISK_TYPE,,}" in
+    "auto" )
+      echo "$result"
+      ;;
+    "usb" )
+      result="$result,if=none \
+      -device usb-storage,drive=${DISK_ID}${index}"
+      echo "$result"
+      ;;
+    "ide" )
+      result="$result,if=none \
+      -device ide-hd,drive=${DISK_ID},bus=ide.$DISK_INDEX,rotation_rate=$DISK_ROTATION${index}"
+      echo "$result"
+      ;;
+    "blk" | "virtio-blk" )
+      result="$result,if=none \
+      -device virtio-blk-pci,drive=${DISK_ID},scsi=off,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}"
+      echo "$result"
+      ;;
+    "scsi" | "virtio-scsi" )
+      result="$result,if=none \
+      -device virtio-scsi-pci,id=${DISK_ID}b,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2 \
+      -device scsi-hd,drive=${DISK_ID},bus=${DISK_ID}b.0,channel=0,scsi-id=0,lun=0,rotation_rate=$DISK_ROTATION${index}"
+      echo "$result"
+      ;;
+  esac
+
+  return 0
+}
+
 addDisk () {
-  local DISK_ID=$1
+  local DISK_BASE=$1
-  local DISK_BASE=$2
+  local DISK_TYPE=$2
-  local DISK_EXT=$3
+  local DISK_DESC=$3
-  local DISK_DESC=$4
+  local DISK_SPACE=$4
-  local DISK_SPACE=$5
+  local DISK_INDEX=$5
-  local DISK_INDEX=$6
+  local DISK_ADDRESS=$6
-  local DISK_ADDRESS=$7
+  local DISK_FMT=$7
-  local DISK_FMT=$8
+  local DISK_IO=$8
+  local DISK_CACHE=$9
+  local DISK_EXT DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE OPTS
+
+  DISK_EXT=$(fmt2ext "$DISK_FMT")
   local DISK_FILE="$DISK_BASE.$DISK_EXT"
-  local DIR DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE
 
   DIR=$(dirname "$DISK_FILE")
   [ ! -d "$DIR" ] && return 0
@@ -365,21 +424,26 @@ addDisk () {
   FS=$(stat -f -c %T "$DIR")
   checkFS "$FS" "$DISK_FILE" "$DISK_DESC" || exit $?
 
-  if ! [ -f "$DISK_FILE" ] ; then
+  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" "$FS" || exit $?
     fi
   fi
 
-  if [ -f "$DISK_FILE" ]; then
+  if [ -s "$DISK_FILE" ]; then
 
     CUR_SIZE=$(getSize "$DISK_FILE")
 
@@ -393,24 +457,56 @@ addDisk () {
 
   fi
 
-  DISK_OPTS="$DISK_OPTS \
+  OPTS=$(createDevice "$DISK_FILE" "$DISK_TYPE" "$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_TYPE=$2
+  local DISK_INDEX=$3
+  local DISK_ADDRESS=$4
+
+  [ -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_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
+  DISK_OPTS="$DISK_OPTS $OPTS"
+
+  return 0
+}
+
+html "Initializing disks..."
+
+case "${DISK_TYPE,,}" in
+  "" ) DISK_TYPE="scsi" ;;
+  "auto" | "ide" | "usb" | "blk" | "scsi" ) ;;
+  * ) error "Invalid DISK_TYPE, value \"$DISK_TYPE\" is unrecognized!" && exit 80 ;;
+esac
+
+if [ -z "$ALLOCATE" ]; then
+  if [[ "${DISK_FMT,,}" == "raw" ]]; then
+    ALLOCATE="Y"
+  else
+    ALLOCATE="N"
+  fi
+fi
 
 if [[ "$ALLOCATE" == [Nn]* ]]; then
-  DISK_TYPE="growable"
+  DISK_STYLE="growable"
   DISK_ALLOC="preallocation=off"
 else
-  DISK_TYPE="preallocated"
+  DISK_STYLE="preallocated"
   DISK_ALLOC="preallocation=falloc"
 fi
 
+DISK_OPTS=$(createDevice "$BOOT" "$DISK_TYPE" "1" "0xa" "raw" "$DISK_IO" "$DISK_CACHE")
+OPTS=$(createDevice "$SYSTEM" "$DISK_TYPE" "2" "0xb" "raw" "$DISK_IO" "$DISK_CACHE")
+DISK_OPTS="$DISK_OPTS $OPTS"
+
 DISK1_FILE="$STORAGE/data"
 if [[ ! -f "$DISK1_FILE.img" ]] && [[ -f "$STORAGE/data${DISK_SIZE}.img" ]]; then
   # Fallback for legacy installs
@@ -444,52 +540,52 @@ 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 "/disk" ] && DEVICE="/disk"
+[ -z "$DEVICE" ] && [ -b "/disk1" ] && DEVICE="/disk1"
+[ -z "$DEVICE2" ] && [ -b "/disk2" ] && DEVICE2="/disk2"
+[ -z "$DEVICE3" ] && [ -b "/disk3" ] && DEVICE3="/disk3"
+[ -z "$DEVICE4" ] && [ -b "/disk4" ] && DEVICE4="/disk4"
 
-  local DISK_ID=$1
+[ -z "$DEVICE" ] && [ -b "/dev/disk1" ] && DEVICE="/dev/disk1"
-  local DISK_DEV=$2
+[ -z "$DEVICE2" ] && [ -b "/dev/disk2" ] && DEVICE2="/dev/disk2"
-  local DISK_INDEX=$3
+[ -z "$DEVICE3" ] && [ -b "/dev/disk3" ] && DEVICE3="/dev/disk3"
-  local DISK_ADDRESS=$4
+[ -z "$DEVICE4" ] && [ -b "/dev/disk4" ] && DEVICE4="/dev/disk4"
 
-  [ -z "$DISK_DEV" ] && return 0
+if [ -n "$DEVICE" ]; 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 "$DEVICE" "$DISK_TYPE" "3" "0xc" || exit $?
+else
+  addDisk "$DISK1_FILE" "$DISK_TYPE" "disk" "$DISK_SIZE" "3" "0xc" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+fi
 
-  DISK_OPTS="$DISK_OPTS \
+if [ -n "$DEVICE2" ]; then
-    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+  addDevice "$DEVICE2" "$DISK_TYPE" "4" "0xd" || 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 "$DISK2_FILE" "$DISK_TYPE" "disk2" "$DISK2_SIZE" "4" "0xd" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
-
+fi
-  return 0
-}
-
-: ${DEVICE:=''}        # Docker variable to passthrough a block device, like /dev/vdc1.
-: ${DEVICE2:=''}
-: ${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 $?
 
+if [ -n "$DEVICE3" ]; then
+  addDevice "$DEVICE3" "$DISK_TYPE" "5" "0xe" || exit $?
+else
+  addDisk "$DISK3_FILE" "$DISK_TYPE" "disk3" "$DISK3_SIZE" "5" "0xe" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+fi
+
+if [ -n "$DEVICE4" ]; then
+  addDevice "$DEVICE4" "$DISK_TYPE" "6" "0xf" || exit $?
+else
+  addDisk "$DISK4_FILE" "$DISK_TYPE" "disk4" "$DISK4_SIZE" "6" "0xf" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+fi
+
+DISK_OPTS="$DISK_OPTS -object iothread,id=io2"
+
+html "Initialized disks successfully..."
 return 0

src/display.sh

@@ -3,17 +3,20 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${GPU:='N'}           # GPU passthrough
+: "${GPU:="N"}"         # GPU passthrough
-: ${DISPLAY:='none'}  # Display type
+: "${VGA:="virtio"}"    # VGA adaptor
+: "${DISPLAY:="none"}"  # Display type
 
 if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
 
-  DISPLAY_OPTS="-display $DISPLAY -vga none"
+  [[ "${DISPLAY,,}" == "none" ]] && VGA="none"
+  DISPLAY_OPTS="-display $DISPLAY -vga $VGA"
   return 0
 
 fi
 
-DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128 -vga virtio"
+DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128"
+DISPLAY_OPTS="$DISPLAY_OPTS -vga $VGA"
 
 [ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
 

src/entry.sh

@@ -1,8 +1,8 @@
 #!/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
 
@@ -18,15 +18,18 @@ cd /run
 
 trap - ERR
 
+info "Booting ${APP}..."
+
 if [[ "$CONSOLE" == [Yy]* ]]; then
   exec qemu-system-x86_64 ${ARGS:+ $ARGS}
 fi
 
-[[ "$DEBUG" == [Yy1]* ]] && info "$VERS" && set -x
+{ qemu-system-x86_64 ${ARGS:+ $ARGS} >"$QEMU_OUT" 2>"$QEMU_LOG"; rc=$?; } || :
-msg=$(qemu-system-x86_64 ${ARGS:+ $ARGS})
+(( rc != 0 )) && error "$(<"$QEMU_LOG")" && exit 15
 
-{ set +x; } 2>/dev/null && terminal "$msg"
+terminal
 tail -fn +0 "$QEMU_LOG" 2>/dev/null &
-cat "$QEMU_TERM" 2>/dev/null & wait $! || true
+cat "$QEMU_TERM" 2>/dev/null & wait $! || :
 
-sleep 1 && finish 0
+sleep 1 & wait $!
+[ ! -f "$QEMU_END" ] && finish 0

src/install.sh

@@ -1,23 +1,37 @@
 #!/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.
 
 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
+  if [[ "${URL,,}" != "http"* ]]; then
+    if [ -s "$STORAGE/$BASE.pat" ]; then
+      URL="file://$STORAGE/$BASE.pat"
+    else
+      error "File $STORAGE/$BASE.pat does not exist!" && exit 65
+    fi
+  fi
+fi
 
-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"
@@ -34,7 +48,9 @@ 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"
@@ -44,8 +60,6 @@ rm -f "$STORAGE/$BASE.agent"
 rm -f "$STORAGE/$BASE.boot.img"
 rm -f "$STORAGE/$BASE.system.img"
 
-[[ "$DEBUG" == [Yy1]* ]] && set -x
-
 # Check filesystem
 FS=$(stat -f -c %T "$STORAGE")
 
@@ -57,7 +71,15 @@ if [[ "${FS,,}" == "fuse"* ]]; then
   info "Warning: the filesystem of $STORAGE is FUSE, this extra layer will negatively affect performance!"
 fi
 
-if [[ "${FS,,}" != "fat"* && "${FS,,}" != "vfat"* && "${FS,,}" != "exfat"* && "${FS,,}" != "ntfs"* && "${FS,,}" != "msdos"* ]]; then
+if [[ "${FS,,}" == "ecryptfs" ]] || [[ "${FS,,}" == "tmpfs" ]]; 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"
@@ -92,29 +114,64 @@ fi
 # Download the required files from the Synology website
 
 ROOT="Y"
+RD="$TMP/rd.gz"
 RDC="$STORAGE/dsm.rd"
 
-if [ ! -f "$RDC" ]; then
+if [ ! -s "$RDC" ] && [[ "$URL" == "file://"* ]] && [[ "${URL,,}" == *"_42218.pat" ]]; then
 
-  info "Install: Downloading installer..."
+  rm -f "$RD"
+  rm -f "$RDC"
 
-  RD="$TMP/rd.gz"
+  tar --extract --file="${URL:7}" --directory="$(dirname "$RD")"/. "$(basename "$RD")"
+  cp "$RD" "$RDC"
+
+fi
+
+if [ ! -s "$RDC" ]; then
+
+  rm -f "$RD"
+  rm -f "$RDC"
+
+  MSG="Downloading installer..."
+  PRG="Downloading installer ([P])..."
+  info "Install: $MSG" && html "$MSG"
+
+  SIZE=5394188
   POS="65627648-71021835"
   VERIFY="b4215a4b213ff5154db0488f92c87864"
   LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
+  [[ "${URL,,}" == *"_42218.pat" ]] && LOC="$URL"
 
-  { curl -r "$POS" -sfk -S -o "$RD" "$LOC"; rc=$?; } || :
+  /run/progress.sh "$RD" "$SIZE" "$PRG" &
-  (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
+  { curl -r "$POS" -sfk --connect-timeout 10 -S -o "$RD" "$LOC"; rc=$?; } || :
 
+  fKill "progress.sh"
+
+  (( rc == 4 )) && error "Failed to download $LOC , network failure!" && exit 60
+
+  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"
+    SIZE=379637760
+
+    rm -f "$RD"
     rm -f "$PAT"
 
-    { wget "$LOC" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+    html "$MSG"
+    /run/progress.sh "$PAT" "$SIZE" "$PRG" &
+    { wget "$LOC" -O "$PAT" -q --no-check-certificate --timeout=10 --show-progress "$PROGRESS"; rc=$?; } || :
+
+    fKill "progress.sh"
+    (( rc == 4 )) && error "Failed to download $LOC , network failure!" && exit 60
     (( rc != 0 )) && error "Failed to download $LOC , reason: $rc" && exit 60
 
     tar --extract --file="$PAT" --directory="$(dirname "$RD")"/. "$(basename "$RD")"
@@ -129,17 +186,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
 
   { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
 
   if (( rc != 0 )); then
     ROOT="N"
     { (cd "$TMP" && fakeroot cpio -idmu <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-    (( rc != 0 )) && error "Failed to extract $RDC, reason $rc" && exit 92
+    (( rc != 0 )) && error "Failed to extract $RDC on $FS, reason $rc" && 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 \
@@ -165,7 +222,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"
@@ -176,12 +237,21 @@ if [[ "$URL" == "file://"* ]]; then
 
 else
 
-  { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+  SIZE=0
+  [[ "${URL,,}" == *"_69057.pat" ]] && SIZE=363837333
+  [[ "${URL,,}" == *"_42218.pat" ]] && SIZE=379637760
+
+  /run/progress.sh "$PAT" "$SIZE" "$PRG" &
+
+  { wget "$URL" -O "$PAT" -q --no-check-certificate --timeout=10 --show-progress "$PROGRESS"; rc=$?; } || :
+
+  fKill "progress.sh"
+  (( rc == 4 )) && error "Failed to download $URL , network failure!" && exit 69
   (( 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")
 
@@ -189,7 +259,8 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
-info "Install: Extracting downloaded image..."
+MSG="Extracting downloaded image..."
+info "Install: $MSG" && html "$MSG"
 
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
@@ -211,10 +282,13 @@ else
 
 fi
 
-info "Install: Preparing system partition..."
+rm -rf /run/extract
+
+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"
@@ -235,11 +309,11 @@ if ! touch "$SYSTEM"; then
   error "Could not create file $SYSTEM for the system disk." && exit 98
 fi
 
-if [[ "${FS,,}" == "xfs" || "${FS,,}" == "zfs" || "${FS,,}" == "btrfs" || "${FS,,}" == "bcachefs" ]]; then
+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 (returned $FA)"
+    error "Failed to disable COW for system image $SYSTEM on ${FS^^} filesystem."
   fi
 fi
 
@@ -267,29 +341,23 @@ sfdisk -q "$SYSTEM" < "$PART"
 MOUNT="$TMP/system"
 rm -rf "$MOUNT" && mkdir -p "$MOUNT"
 
-info "Install: Extracting system partition..."
+MSG="Extracting system partition..."
+info "Install: $MSG" && html "$MSG"
 
 HDA="$TMP/hda1"
 IDB="$TMP/indexdb"
 PKG="$TMP/packages"
 HDP="$TMP/synohdpack_img"
 
-[ ! -f "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
+[ ! -s "$HDA.tgz" ] && error "The PAT file contains no OS image." && exit 64
-
 mv "$HDA.tgz" "$HDA.txz"
 
-if [[ "$ROOT" != [Nn]* ]]; then
-
-  tar xpfJ "$HDA.txz" --absolute-names -C "$MOUNT/"
-
-fi
-
 [ -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/"
 
-if [ -f "$IDB.txz" ]; then
+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"
@@ -298,10 +366,13 @@ fi
 LABEL="1.44.1-42218"
 OFFSET="1048576" # 2048 * 512
 NUMBLOCKS="622560" # (4980480 * 512) / 4096
+MSG="Installing system partition..."
 
 if [[ "$ROOT" != [Nn]* ]]; then
 
-  info "Install: Installing system partition..."
+  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"
 
@@ -309,13 +380,12 @@ 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: Installing system partition...' '\E[0m\n';\
+        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"
 
 if [[ "$URL" == "file://$STORAGE/$BASE.pat" ]]; then
@@ -325,10 +395,7 @@ else
 fi
 
 mv -f "$BOOT" "$STORAGE/$BASE.boot.img"
-
 rm -rf "$TMP"
 
-{ set +x; } 2>/dev/null
+html "Installation finished successfully..."
-[[ "$DEBUG" == [Yy1]* ]] && echo
-
 return 0

src/network.sh

@@ -3,17 +3,20 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${DHCP:='N'}
+: "${MAC:=""}"
-: ${MAC:='02:11:32:AA:BB:CC'}
+: "${DHCP:="N"}"
+: "${NETWORK:="Y"}"
+: "${HOST_PORTS:=""}"
 
-: ${VM_NET_DEV:=''}
+: "${VM_NET_DEV:=""}"
-: ${VM_NET_TAP:='dsm'}
+: "${VM_NET_TAP:="dsm"}"
-: ${VM_NET_MAC:="$MAC"}
+: "${VM_NET_MAC:="$MAC"}"
-: ${VM_NET_HOST:='VirtualDSM'}
+: "${VM_NET_IP:="20.20.20.21"}"
+: "${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:"
 
@@ -23,17 +26,23 @@ ADD_ERR="Please add the following setting to your container:"
 
 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: --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
 
@@ -80,16 +89,37 @@ 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
 }
 
+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
@@ -101,21 +131,21 @@ configureNAT() {
   fi
 
   if [ ! -c /dev/net/tun ]; then
-    error "TUN device missing. $ADD_ERR --cap-add NET_ADMIN" && exit 25
+    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 ; rc=$?; } || :
+    { sysctl -w net.ipv4.ip_forward=1 > /dev/null; rc=$?; } || :
-    if (( rc != 0 )); then
+    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
 
-  # Create a bridge with a static IP for the VM guest
+  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'."
 
-  VM_NET_IP='20.20.20.21'
+  # Create a bridge with a static IP for the VM guest
-  [[ "$DEBUG" == [Yy1]* ]] && set -x
 
   { ip link add dev dockerbridge type bridge ; rc=$?; } || :
 
@@ -123,18 +153,20 @@ configureNAT() {
     error "Failed to create bridge. $ADD_ERR --cap-add NET_ADMIN" && exit 23
   fi
 
-  ip address add ${VM_NET_IP%.*}.1/24 broadcast ${VM_NET_IP%.*}.255 dev dockerbridge
+  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
 
@@ -144,22 +176,27 @@ configureNAT() {
   update-alternatives --set iptables /usr/sbin/iptables-legacy > /dev/null
   update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy > /dev/null
 
-  iptables -t nat -A POSTROUTING -o "$VM_NET_DEV" -j MASQUERADE
+  exclude=$(getPorts "$HOST_PORTS")
-  iptables -t nat -A PREROUTING -i "$VM_NET_DEV" -d "$IP" -p tcp -j DNAT --to "$VM_NET_IP"
+
+  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
-
   NET_OPTS="-netdev tap,ifname=$VM_NET_TAP,script=no,downscript=no,id=hostnet0"
 
+  if [ -c /dev/vhost-net ]; then
     { exec 40>>/dev/vhost-net; rc=$?; } 2>/dev/null || :
     (( rc == 0 )) && NET_OPTS="$NET_OPTS,vhost=on,vhostfd=40"
+  fi
 
   configureDNS
 
@@ -168,19 +205,28 @@ configureNAT() {
 
 closeNetwork() {
 
+  if [[ "$DHCP" == [Yy1]* ]]; then
+
+    # 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
 
-    fKill "server.sh"
-
     ip link set "$VM_NET_TAP" down || true
     ip link delete "$VM_NET_TAP" || true
 
   else
 
-    fKill "dnsmasq"
+    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
@@ -193,11 +239,33 @@ closeNetwork() {
   return 0
 }
 
+checkOS() {
+
+  local name
+  local os=""
+  name=$(uname -a)
+
+  [[ "${name,,}" == *"darwin"* ]] && os="MacOS"
+  [[ "${name,,}" == *"microsoft"* ]] && os="Windows"
+
+  if [ -n "$os" ]; then
+    error "You are using Docker Desktop for $os which does not support macvlan, please revert to bridge networking!"
+    return 1
+  fi
+
+  return 0
+}
+
 getInfo() {
 
   if [ -z "$VM_NET_DEV" ]; then
+    # Give Kubernetes priority over the default interface
+    [ -d "/sys/class/net/net0" ] && VM_NET_DEV="net0"
+    [ -d "/sys/class/net/net1" ] && VM_NET_DEV="net1"
+    [ -d "/sys/class/net/net2" ] && VM_NET_DEV="net2"
+    [ -d "/sys/class/net/net3" ] && VM_NET_DEV="net3"
     # Automaticly detect the default network interface
-    VM_NET_DEV=$(awk '$2 == 00000000 { print $1 }' /proc/net/route)
+    [ -z "$VM_NET_DEV" ] && VM_NET_DEV=$(awk '$2 == 00000000 { print $1 }' /proc/net/route)
     [ -z "$VM_NET_DEV" ] && VM_NET_DEV="eth0"
   fi
 
@@ -206,19 +274,31 @@ getInfo() {
     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
+    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}')
+  GATEWAY=$(ip route list dev "$VM_NET_DEV" | awk ' /^default/ {print $3}')
   IP=$(ip address show dev "$VM_NET_DEV" | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
-  echo "$IP" > /run/qemu.ip
+  echo "$IP" > /run/shm/qemu.ip
 
   return 0
 }
@@ -227,36 +307,48 @@ getInfo() {
 #  Configure Network
 # ######################################
 
-fKill "server.sh"
+if [[ "$NETWORK" != [Yy1]* ]]; then
-
+  NET_OPTS=""
-if [ ! -c /dev/vhost-net ]; then
+  return 0
-  if mknod /dev/vhost-net c 10 238; then
-    chmod 660 /dev/vhost-net
-  fi
 fi
 
 getInfo
+html "Initializing network..."
 
 if [[ "$DEBUG" == [Yy1]* ]]; then
-  info "Container IP is $IP with gateway $GATEWAY on interface $VM_NET_DEV" && 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
+  ! checkOS && [[ "$DEBUG" != [Yy1]* ]] && exit 19
-    if [[ "$DEBUG" != [Yy1]* ]]; then
+
-      error "You can only enable DHCP while the container is on a macvlan network!" && exit 26
+  if [[ "$IP" == "172."* ]]; then
-    fi
+    warn "container IP starts with 172.* which is often a sign that you are not on a macvlan network (required for DHCP)!"
   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
 
+  if [[ "$IP" != "172."* ]] && [[ "$IP" != "10.8"* ]] && [[ "$IP" != "10.9"* ]]; then
+    ! checkOS && [[ "$DEBUG" != [Yy1]* ]] && exit 19
+  fi
+
+  # Shutdown nginx
+  nginx -s stop 2> /dev/null
+  fWait "nginx"
+
   # Configuration for static IP
   configureNAT
 

src/power.sh

@@ -10,18 +10,17 @@ API_HOST="127.0.0.1:2210"
 QEMU_TERM=""
 QEMU_PORT=7100
 QEMU_TIMEOUT=50
-QEMU_PID="/run/qemu.pid"
+QEMU_DIR="/run/shm"
-QEMU_LOG="/run/qemu.log"
+QEMU_PID="$QEMU_DIR/qemu.pid"
-QEMU_END="/run/qemu.end"
+QEMU_LOG="$QEMU_DIR/qemu.log"
+QEMU_OUT="$QEMU_DIR/qemu.out"
+QEMU_END="$QEMU_DIR/qemu.end"
 
 if [[ "$KVM" == [Nn]* ]]; then
   API_TIMEOUT=$(( API_TIMEOUT*2 ))
   QEMU_TIMEOUT=$(( QEMU_TIMEOUT*2 ))
 fi
 
-rm -f "$QEMU_PID"
-rm -f "$QEMU_LOG"
-rm -f "$QEMU_END"
 touch "$QEMU_LOG"
 
 _trap() {
@@ -36,16 +35,18 @@ finish() {
   local pid
   local reason=$1
 
-  if [ -f "$QEMU_PID" ]; then
+  touch "$QEMU_END"
 
-    pid="$(cat "$QEMU_PID")"
+  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
-      [ ! -f "$QEMU_PID" ] && break
+      [ ! -s "$QEMU_PID" ] && break
     done
   fi
 
@@ -62,15 +63,25 @@ finish() {
 
 terminal() {
 
-  local msg=$1
+  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
 
-  local dev="${msg#*/dev/p}"
+      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}"
@@ -90,7 +101,6 @@ terminal() {
 
 _graceful_shutdown() {
 
-  local cnt=0
   local code=$?
   local pid url response
 
@@ -104,12 +114,12 @@ _graceful_shutdown() {
   touch "$QEMU_END"
   echo && info "Received $1 signal, sending shutdown command..."
 
-  if [ ! -f "$QEMU_PID" ]; then
+  if [ ! -s "$QEMU_PID" ]; then
     echo && error "QEMU PID file does not exist?"
     finish "$code" && return "$code"
   fi
 
-  pid="$(cat "$QEMU_PID")"
+  pid=$(<"$QEMU_PID")
 
   if ! isAlive "$pid"; then
     echo && error "QEMU process does not exist?"
@@ -136,6 +146,8 @@ _graceful_shutdown() {
 
   fi
 
+  local cnt=0
+
   while [ "$cnt" -lt "$QEMU_TIMEOUT" ]; do
 
     ! isAlive "$pid" && break
@@ -146,7 +158,7 @@ _graceful_shutdown() {
     [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt/$QEMU_TIMEOUT)"
 
     # Workaround for zombie pid
-    [ ! -f "$QEMU_PID" ] && break
+    [ ! -s "$QEMU_PID" ] && break
 
   done
 
@@ -159,6 +171,7 @@ _graceful_shutdown() {
 
 MON_OPTS="\
         -pidfile $QEMU_PID \
+        -name $PROCESS,process=$PROCESS,debug-threads=on \
         -monitor telnet:localhost:$QEMU_PORT,server,nowait,nodelay"
 
 if [[ "$CONSOLE" != [Yy]* ]]; then

src/print.sh

@@ -1,21 +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"
-address="/run/qemu.ip"
+info="/run/shm/msg.html"
-shutdown="/run/qemu.end"
+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
@@ -24,7 +30,7 @@ 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=$?; } || :
@@ -61,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="$(cat "$address")"
+  ip=$(<"$address")
   port="${location##*:}"
 
   if [[ "$ip" == "172."* ]]; then
@@ -85,3 +104,5 @@ info "-----------------------------------------------------------"
 info " You can now login to DSM at $msg"
 info "-----------------------------------------------------------"
 echo "" >&2
+
+exit 0

src/proc.sh

@@ -3,12 +3,16 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${KVM:='Y'}
+: "${KVM:="Y"}"
-: ${HOST_CPU:=''}
+: "${HOST_CPU:=""}"
-: ${CPU_MODEL:='host'}
+: "${CPU_FLAGS:=""}"
-: ${CPU_FEATURES:='+ssse3,+sse4.1,+sse4.2'}
+: "${CPU_MODEL:=""}"
+: "${DEF_MODEL:="qemu64"}"
 
-[ "$ARCH" != "amd64" ] && KVM="N"
+if [[ "${ARCH,,}" != "amd64" ]]; then
+  KVM="N"
+  warn "your CPU architecture is ${ARCH^^} and cannot provide KVM acceleration for x64 instructions, this will cause a major loss of performance."
+fi
 
 if [[ "$KVM" != [Nn]* ]]; then
 
@@ -20,7 +24,8 @@ if [[ "$KVM" != [Nn]* ]]; then
     if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
       KVM_ERR="(no write access)"
     else
-      if ! grep -q -e vmx -e svm /proc/cpuinfo; then
+      flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
+      if ! grep -qw "vmx\|svm" <<< "$flags"; then
         KVM_ERR="(vmx/svm disabled)"
       fi
     fi
@@ -28,39 +33,75 @@ if [[ "$KVM" != [Nn]* ]]; then
 
   if [ -n "$KVM_ERR" ]; then
     KVM="N"
-    error "KVM acceleration not detected $KVM_ERR, this will cause a major loss of performance."
+    if [[ "$OSTYPE" =~ ^darwin ]]; then
+      warn "you are using MacOS which has no KVM support, this will cause a major loss of performance."
+    else
+      if grep -qi Microsoft /proc/version; then
+        warn "you are using Windows 10 which has no KVM support, this will cause a major loss of performance."
+      else
+        error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
         error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
         [[ "$DEBUG" != [Yy1]* ]] && exit 88
       fi
+    fi
+  fi
 
 fi
 
 if [[ "$KVM" != [Nn]* ]]; then
 
-  KVM_OPTS=",accel=kvm -enable-kvm"
+  CPU_FEATURES="kvm=on,l3-cache=on"
+  KVM_OPTS=",accel=kvm -enable-kvm -global kvm-pit.lost_tick_policy=discard"
 
-  if ! grep -qE '^flags.* (sse4_2)' /proc/cpuinfo; then
+  if ! grep -qw "sse4_2" <<< "$flags"; then
-    error "Your host CPU does not have the SSE4.2 instruction set that Virtual DSM requires to boot."
+    info "Your CPU does not have the SSE4 instruction set that Virtual DSM requires, it will be emulated..."
-    error "Disable KVM by setting KVM=N to emulate a compatible CPU, at the cost of performance."
+    [ -z "$CPU_MODEL" ] && CPU_MODEL="$DEF_MODEL"
-    [[ "$DEBUG" != [Yy1]* ]] && exit 89
+    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 [[ "$CPU_MODEL" == "host"* ]]; then
   if [[ "$ARCH" == "amd64" ]]; then
-      CPU_MODEL="max,$CPU_FEATURES"
+    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="qemu64,$CPU_FEATURES"
+      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 'Model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+  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

src/progress.sh

@@ -0,0 +1,38 @@
+#!/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"
+total="$2"
+body=$(escape "$3")
+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
+      if [ -z "$total" ] || [[ "$total" == "0" ]]; then
+        size=$(numfmt --to=iec --suffix=B  "$bytes" | sed -r 's/([A-Z])/ \1/')
+      else
+        size=$(printf '%.1f\n' "$((bytes*100*100/total))e-2")
+        size="$size%"
+      fi
+      echo "${body//(\[P\])/($size)}"> "$info"
+    fi
+  fi
+  sleep 1 & wait $!
+done

src/reset.sh

@@ -1,50 +1,107 @@
 #!/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
 
-: ${TZ:=''}             # System local timezone
+: "${TZ:=""}"             # System local timezone
-: ${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:='Y'}      # Preallocate diskspace
+: "${ALLOCATE:=""}"       # 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
+: "${RAM_CHECK:="Y"}"     # Check available RAM
+: "${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)
+SOCKETS=$(lscpu | grep -m 1 -i 'socket(s)' | awk '{print $(2)}')
+CPU=$(lscpu | grep -m 1 -i '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
+
+# Read memory
+RAM_SPARE=500000000
+RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
+RAM_TOTAL=$(free -b | grep -m 1 Mem: | awk '{print $2}')
+RAM_SIZE=$(echo "${RAM_SIZE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+RAM_WANTED=$(numfmt --from=iec "$RAM_SIZE")
+AVAIL_GB=$(( RAM_AVAIL/1073741824 ))
+TOTAL_GB=$(( (RAM_TOTAL + 1073741823)/1073741824 ))
+WANTED_GB=$(( (RAM_WANTED + 1073741823)/1073741824 ))
+
+# 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: $AVAIL_GB/$TOTAL_GB GB | DISK: $SPACE_GB GB (${FS}) | HOST: ${SYS}..."
+echo
+
+# Check memory
+
+if [[ "$RAM_CHECK" != [Nn]* ]]; then
+  if (( (RAM_WANTED + RAM_SPARE) > RAM_AVAIL )); then
+    error "Your configured RAM_SIZE of $WANTED_GB GB is too high for the $AVAIL_GB GB of memory available, please set a lower value."
+    exit 17
+  fi
+fi
 
 # Cleanup files
-
+rm -f /run/shm/qemu.*
-rm -f /run/dsm.url
+rm -f /run/shm/dsm.url
-rm -f /run/qemu.ip
-rm -f /run/qemu.log
-rm -f /run/qemu.pid
-rm -f /run/qemu.end
 
 # Cleanup dirs
-
 rm -rf /tmp/dsm
-rm -f /tmp/server.*
 rm -rf "$STORAGE/tmp"
 
 # Helper functions
@@ -65,7 +122,17 @@ pKill() {
   { kill -15 "$pid" || true; } 2>/dev/null
 
   while isAlive "$pid"; do
-    sleep 0.1
+    sleep 0.2
+  done
+
+  return 0
+}
+
+fWait() {
+  local name=$1
+
+  while pgrep -f -l "$name" >/dev/null; do
+    sleep 0.2
   done
 
   return 0
@@ -75,10 +142,49 @@ fKill() {
   local name=$1
 
   { pkill -f "$name" || true; } 2>/dev/null
+  fWait "$name"
 
-  while pgrep -f -l "$name" >/dev/null; do
+  return 0
-    sleep 0.1
+}
-  done
+
+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
 }
@@ -128,10 +234,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
 
@@ -139,10 +243,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")

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;
+
+    }
+}