feat: Print arguments in debug mode (#743)

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,62 @@
+name: "\U0001F6A8 Technical issue"
+description: When you're experiencing problems using the container
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there no existing issue for this?
+      description: Please search to see if no solution was already provided before.
+      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 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 version of the Docker engine (as shown by `docker -v`).
+      placeholder: e.g. 26.0.1
+    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,44 @@
+name: "\U0001F680 Feature request"
+description: Suggest an idea for improving the container
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there no existing feature request for this?
+      description: Please search to see if the feature was not already requested before.
+      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/3-bug.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 no existing bug report for this?
+      description: Please search to see if the bug was not already reported before.
+      options:
+      - label: I have searched the existing bug reports
+        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 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 version of the Docker engine (as shown by `docker -v`).
+      placeholder: e.g. 26.0.1
+    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:
+        env:
-        SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -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,13 +10,15 @@ FROM qemux/qemu-host as builder
 FROM debian:trixie-slim
 
 ARG TARGETPLATFORM
-ARG DEBCONF_NOWARNINGS "yes"
+ARG VERSION_ARG="0.0"
-ARG DEBIAN_FRONTEND "noninteractive"
+ARG DEBCONF_NOWARNINGS="yes"
-ARG DEBCONF_NONINTERACTIVE_SEEN "true"
+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 \
@@ -37,18 +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 && \
-    && unlink /etc/nginx/sites-enabled/default \
+    unlink /etc/nginx/sites-enabled/default && \
-    && sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf \
+    sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf && \
-    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+    echo "$VERSION_ARG" > /run/version && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
-COPY ./src /run/
+COPY --chmod=755 ./src /run/
-COPY ./web /var/www/
+COPY --chmod=755 ./web /var/www/
-COPY --from=builder /qemu-host.bin /run/host.bin
+COPY --chmod=755 --from=builder /qemu-host.bin /run/host.bin
-
+COPY --chmod=744 ./web/nginx.conf /etc/nginx/sites-enabled/web.conf
-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
@@ -57,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<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,21 +11,19 @@
 
 </div></h1>
 
-Virtual DSM in a docker container.
+Virtual DSM in a Docker container.
 
 ## Features
 
  - Multiple disks
  - KVM acceleration
- - GPU pass-through
  - Upgrades supported
  
 ## Usage
 
-Via `docker-compose.yml`
+Via Docker Compose:
 
 ```yaml
-version: "3"
 services:
   dsm:
     container_name: dsm
@@ -40,202 +38,218 @@ 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
+docker run -it --name dsm -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 use it?
+* ### How do I use it?
 
-    Very simple! These are the steps:
+  Very simple! These are the steps:
-    
+  
-    - Start the container and get some coffee.
+  - Start the container and connect to [port 5000](http://localhost:5000) using your web browser.
 
-    - Connect to [port 5000](http://localhost:5000) of the container in 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!
 
-    - Wait until DSM is ready, choose an username and password, and you will be taken to the desktop.
+* ### How do I change the storage location?
 
-    - Enjoy your brand new machine, and don't forget to star this repo!
+  To change the storage location, include the following bind mount in your compose file:
 
-  * ### How do I change the size of the disk?
+  ```yaml
+  volumes:
+    - /var/dsm:/storage
+  ```
 
-    To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
+  Replace the example path `/var/dsm` with the desired storage folder.
+ 
+* ### How do I change the size of the disk?
 
-    ```yaml
+  To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
-    environment:
-      DISK_SIZE: "128G"
-    ```
-    
-    This can also be used to resize the existing disk to a larger capacity without any data loss. 
 
-  * ### How do I change the storage location?
+  ```yaml
+  environment:
+    DISK_SIZE: "128G"
+  ```
+  
+  This can also be used to resize the existing disk to a larger capacity without any data loss.
 
-    To change the storage location, include the following bind mount in your compose file:
+* ### How do I create a growable disk?
 
-    ```yaml
+  By default, the entire capacity of the disk is reserved in advance.
-    volumes:
-      - /var/dsm:/storage
-    ```
 
-    Replace the example path `/var/dsm` with the desired storage folder.
+  To create a growable disk that only allocates space that is actually used, add the following environment variable:
 
-  * ### How do I create a growable disk?
+  ```yaml
+  environment:
+    DISK_FMT: "qcow2"
+  ```
 
-    By default, the entire capacity of the disk is reserved in advance.
+  Please note that this may reduce the write performance of the disk.
-
-    To create a growable disk that only allocates space that is actually used, add the following environment variable:
-
-    ```yaml
-    environment:
-      DISK_FMT: "qcow2"
-    ```
-
-    Please note that this may reduce the write performance of the disk.
 
 * ### How do I add multiple disks?
 
-    To create additional disks, modify your compose file like this:
+  To create additional disks, modify your compose file like this:
-    
+  
-    ```yaml
+  ```yaml
-    environment:
+  environment:
-      DISK2_SIZE: "32G"
+    DISK2_SIZE: "32G"
-      DISK3_SIZE: "64G"
+    DISK3_SIZE: "64G"
-    volumes:
+  volumes:
-      - /home/example:/storage2
+    - /home/example:/storage2
-      - /mnt/data/example:/storage3
+    - /mnt/data/example:/storage3
-    ```
+  ```
 
-  * ### How do I pass-through a disk?
+* ### How do I pass-through a disk?
 
-    It is possible to pass-through disk devices directly by adding them to your compose file in this way:
+   It is possible to pass-through disk devices directly by adding them to your compose file in this way:
 
-    ```yaml
+  ```yaml
-    environment:
+  devices:
-      DEVICE2: "/dev/sda"
+    - /dev/disk/by-uuid/12345-12345-12345-12345-12345:/disk2
-      DEVICE3: "/dev/sdb"
+    - /dev/disk/by-uuid/45678-45678-45678-45678-45678:/disk3
-    devices:
+  ```
-      - /dev/sda
-      - /dev/sdb
-    ```
 
-    Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
+  Make sure to bind the disk via its UUID (obtainable via `lsblk -o name,uuid`) instead of its name (`/dev/sdc`), to prevent ever binding the wrong disk when the drive letters happen to change. 
 
-    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.
+  Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
 
-  * ### How do I increase the amount of CPU or RAM?
+  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.
 
-    By default, a single CPU core and 1 GB of RAM are allocated to the container.
+* ### How do I increase the amount of CPU or RAM?
 
-    To increase this, add the following environment variables:
+  By default, a single CPU core and 1 GB of RAM are allocated to the container.
 
-    ```yaml
+  If there arises a need to increase this, add the following environment variables:
-    environment:
-      RAM_SIZE: "4G"
-      CPU_CORES: "4"
-    ```
 
-  * ### How do I verify if my system supports KVM?
+  ```yaml
+  environment:
+    RAM_SIZE: "4G"
+    CPU_CORES: "4"
+  ```
 
-    To verify if your system supports KVM, run the following commands:
+* ### How do I verify if my system supports KVM?
 
-    ```bash
+  To verify if your system supports KVM, run the following commands:
-    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 the virtualization settings in the BIOS.
+  ```bash
+  sudo apt install cpu-checker
+  sudo kvm-ok
+  ```
 
-  * ### How do I assign an individual IP address to the container?
+  If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check the virtualization settings in the BIOS.
 
-    By default, the container uses bridge networking, which shares the IP address with the host. 
+* ### How do I assign an individual IP address to the container?
 
-    If you want to assign an individual IP address to the container, you can create a macvlan network as follows:
+  By default, the container uses bridge networking, which shares the IP address with the host. 
 
-    ```bash
+  If you want to assign an individual IP address to the container, you can create a macvlan network as follows:
-    docker network create -d macvlan \
-        --subnet=192.168.0.0/24 \
-        --gateway=192.168.0.1 \
-        --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:
+  ```bash
+  docker network create -d macvlan \
+      --subnet=192.168.0.0/24 \
+      --gateway=192.168.0.1 \
+      --ip-range=192.168.0.100/28 \
+      -o parent=eth0 vdsm
+  ```
+  
+  Be sure to modify these values to match your local subnet. 
 
-    ```yaml
+  Once you have created the network, change your compose file to look as follows:
-    services:
-      dsm:
-        container_name: dsm
-        ..<snip>..
-        networks:
-          vdsm:
-            ipv4_address: 192.168.0.100
 
-    networks:
+  ```yaml
-      vdsm:
+  services:
-        external: true
+    dsm:
-    ```
+      container_name: dsm
-   
+      ..<snip>..
-    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.
+      networks:
+        vdsm:
+          ipv4_address: 192.168.0.100
 
-    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.
+  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.
 
-  * ### How can DSM acquire an IP address from my router?
+  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.
 
-    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.
+* ### How can DSM acquire an IP address from my router?
 
-    To enable this feature, add the following lines to your compose file:
+  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.
 
-    ```yaml
+  To enable this mode, add the following lines to your compose file:
-    environment:
-      DHCP: "Y"
-    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.
+  ```yaml
+  environment:
+    DHCP: "Y"
+  devices:
+    - /dev/vhost-net
+  device_cgroup_rules:
+    - 'c *:* rwm'
+  ```
 
-  * ### How do I pass-through the GPU?
+  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.
 
-    To pass-through your Intel GPU, add the following lines to your compose file:
+* ### How do I pass-through the GPU?
 
-    ```yaml
+  To pass-through your Intel GPU, add the following lines to your compose file:
-    environment:
-      GPU: "Y"
-    devices:
-      - /dev/dri
-    ```
 
-    This can be used to enable the facial recognition function in Synology Photos for example.
+  ```yaml
+  environment:
+    GPU: "Y"
+  devices:
+    - /dev/dri
+  ```
 
-  * ### How do I install a specific version of vDSM?
+  This can be used to enable the facial recognition function in Synology Photos for example.
 
-    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:
+* ### How do I install a specific version of vDSM?
 
-    ```yaml
+  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:
-    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.
+  ```yaml
+  environment:
+    URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
+  ```
 
-  * ### What are the differences compared to the standard DSM?
+  With this method, it is even possible to switch between different versions while keeping all your file data intact.
 
-    There are only two minor differences: the Virtual Machine Manager package is not available, and Surveillance Station will not include any free licenses.
+  If you don't have internet access, it's also possible to skip the download by setting URL to:
-    
-  * ### 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.
+    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.
+  
+* ### 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
 
@@ -247,5 +261,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,13 +1,16 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+: "${NETWORK:="Y"}"
+
 [ -f "/run/shm/qemu.end" ] && echo "QEMU is shutting down.." && exit 1
-[ ! -f "/run/shm/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
+[ ! -s "/run/shm/qemu.pid" ] && echo "QEMU is not running yet.." && exit 0
+[[ "$NETWORK" != [Yy1]* ]] && echo "Networking is disabled.." && exit 0
 
 file="/run/shm/dsm.url"
 address="/run/shm/qemu.ip"
 
-[ ! -f  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+[ ! -s  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
 
 location=$(<"$file")
 

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,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

@@ -5,6 +5,7 @@ set -Eeuo pipefail
 
 : "${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_TYPE:=""}"              # Device type to be used, choose "ide", "usb", "blk" or "scsi"
 : "${DISK_FLAGS:=""}"             # Specifies the options for use with the qcow2 disk format
 : "${DISK_CACHE:="none"}"         # Caching mode, can be set to 'writeback' for better performance
 : "${DISK_DISCARD:="on"}"         # Controls whether unmap (TRIM) commands are passed to the host.
@@ -13,17 +14,8 @@ set -Eeuo pipefail
 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
@@ -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,10 +114,10 @@ createDisk() {
     fi
   fi
 
-  MSG="Creating a $DISK_TYPE $DISK_DESC image in $DISK_FMT format with a size of $DISK_SPACE..."
+  html "Creating a $DISK_DESC image..."
-  info "$MSG" && html "$MSG"
+  info "Creating a $DISK_SPACE $DISK_STYLE $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)"
+  local FAIL="Could not create a $DISK_STYLE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
 
   case "${DISK_FMT,,}" in
     raw)
@@ -200,7 +202,7 @@ resizeDisk() {
   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)"
+  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)
@@ -266,8 +268,8 @@ convertDisk() {
     fi
   fi
 
-  MSG="Converting $DISK_DESC to $DST_FMT, please wait until completed..."
+  html "Converting $DISK_DESC to $DST_FMT..."
-  info "$MSG" && html "$MSG"
+  info "Converting $DISK_DESC to $DST_FMT, please wait until completed..."
 
   local CONV_FLAGS="-p"
   local DISK_PARAM="$DISK_ALLOC"
@@ -283,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
@@ -306,8 +308,8 @@ convertDisk() {
     fi
   fi
 
-  MSG="Conversion of $DISK_DESC to $DST_FMT completed succesfully!"
+  html "Conversion of $DISK_DESC completed..."
-  info "$MSG" && html "$MSG"
+  info "Conversion of $DISK_DESC to $DST_FMT completed succesfully!"
 
   return 0
 }
@@ -329,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")
@@ -341,17 +347,60 @@ 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,if=none,format=$DISK_FMT,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on"
+
+  case "${DISK_TYPE,,}" in
+    "usb" )
+      result="$result \
+      -device usb-storage,drive=${DISK_ID}${index}"
+      ;;
+    "ide" )
+      result="$result \
+      -device ide-hd,drive=${DISK_ID},bus=ide.$DISK_INDEX,rotation_rate=$DISK_ROTATION${index}"
+      echo "$result"
+      ;;
+    "blk" | "virtio-blk" )
+      result="$result \
+      -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 \
+      -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
@@ -371,7 +420,12 @@ 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"
@@ -380,12 +434,12 @@ addDisk () {
     fi
     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")
 
@@ -399,36 +453,35 @@ 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
 }
 
 addDevice () {
-
+  local DISK_DEV=$1
-  local DISK_ID=$1
+  local DISK_TYPE=$2
-  local DISK_DEV=$2
+  local DISK_INDEX=$3
-  local DISK_DESC=$3
+  local DISK_ADDRESS=$4
-  local DISK_INDEX=$4
-  local DISK_ADDRESS=$5
 
   [ -z "$DISK_DEV" ] && return 0
   [ ! -b "$DISK_DEV" ] && error "Device $DISK_DEV cannot be found! Please add it to the 'devices' section of your compose file." && exit 55
 
-  DISK_OPTS="$DISK_OPTS \
+  local OPTS
-    -device virtio-scsi-pci,id=hw-$DISK_ID,iothread=io2,bus=pcie.0,addr=$DISK_ADDRESS \
+  OPTS=$(createDevice "$DISK_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE")
-    -drive file=$DISK_DEV,if=none,id=drive-$DISK_ID,format=raw,cache=$DISK_CACHE,aio=$DISK_IO,discard=$DISK_DISCARD,detect-zeroes=on \
+  DISK_OPTS="$DISK_OPTS $OPTS"
-    -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
 }
 
 html "Initializing disks..."
 
-DISK_EXT=$(fmt2ext "$DISK_FMT")
+case "${DISK_TYPE,,}" in
+  "" ) DISK_TYPE="scsi" ;;
+  "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
@@ -439,13 +492,17 @@ if [ -z "$ALLOCATE" ]; then
 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
@@ -489,29 +546,42 @@ DISK4_FILE="/storage4/data4"
 : "${DEVICE3:=""}"
 : "${DEVICE4:=""}"
 
+[ -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"
+
+[ -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"
+
 if [ -n "$DEVICE" ]; then
-  addDevice "userdata" "$DEVICE" "device" "3" "0xc" || exit $?
+  addDevice "$DEVICE" "$DISK_TYPE" "3" "0xc" || exit $?
 else
-  addDisk "userdata" "$DISK1_FILE" "$DISK_EXT" "disk" "$DISK_SIZE" "3" "0xc" "$DISK_FMT" || exit $?
+  addDisk "$DISK1_FILE" "$DISK_TYPE" "disk" "$DISK_SIZE" "3" "0xc" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
 if [ -n "$DEVICE2" ]; then
-  addDevice "userdata2" "$DEVICE2" "device2" "4" "0xd" || exit $?
+  addDevice "$DEVICE2" "$DISK_TYPE" "4" "0xd" || exit $?
 else
-  addDisk "userdata2" "$DISK2_FILE" "$DISK_EXT" "disk2" "$DISK2_SIZE" "4" "0xd" "$DISK_FMT" || exit $?
+  addDisk "$DISK2_FILE" "$DISK_TYPE" "disk2" "$DISK2_SIZE" "4" "0xd" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
 if [ -n "$DEVICE3" ]; then
-  addDevice "userdata3" "$DEVICE3" "device3" "5" "0xe" || exit $?
+  addDevice "$DEVICE3" "$DISK_TYPE" "5" "0xe" || exit $?
 else
-  addDisk "userdata3" "$DISK3_FILE" "$DISK_EXT" "disk3" "$DISK3_SIZE" "5" "0xe" "$DISK_FMT" || exit $?
+  addDisk "$DISK3_FILE" "$DISK_TYPE" "disk3" "$DISK3_SIZE" "5" "0xe" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
 fi
 
 if [ -n "$DEVICE4" ]; then
-  addDevice "userdata4" "$DEVICE4" "device4" "6" "0xf" || exit $?
+  addDevice "$DEVICE4" "$DISK_TYPE" "6" "0xf" || exit $?
 else
-  addDisk "userdata4" "$DISK4_FILE" "$DISK_EXT" "disk4" "$DISK4_SIZE" "6" "0xf" "$DISK_FMT" || exit $?
+  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

@@ -15,7 +15,8 @@ if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
 
 fi
 
-DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128 -vga $VGA"
+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

@@ -18,11 +18,12 @@ cd /run
 
 trap - ERR
 
+info "Booting ${APP}..."
+
 if [[ "$CONSOLE" == [Yy]* ]]; then
   exec qemu-system-x86_64 ${ARGS:+ $ARGS}
 fi
 
-[[ "$DEBUG" == [Yy1]* ]] && info "$VERS" && echo "Arguments: $ARGS" && echo
 { qemu-system-x86_64 ${ARGS:+ $ARGS} >"$QEMU_OUT" 2>"$QEMU_LOG"; rc=$?; } || :
 (( rc != 0 )) && error "$(<"$QEMU_LOG")" && exit 15
 
@@ -30,4 +31,5 @@ terminal
 tail -fn +0 "$QEMU_LOG" 2>/dev/null &
 cat "$QEMU_TERM" 2>/dev/null & wait $! || :
 
-sleep 1 && finish 0
+sleep 1 & wait $!
+finish 0

src/install.sh

@@ -5,6 +5,7 @@ set -Eeuo pipefail
 
 if [ -f "$STORAGE/dsm.ver" ]; then
   BASE=$(<"$STORAGE/dsm.ver")
+  [ -z "$BASE" ] && BASE="DSM_VirtualDSM_69057"
 else
   # Fallback for old installs
   BASE="DSM_VirtualDSM_42962"
@@ -12,14 +13,21 @@ fi
 
 if [ -n "$URL" ]; then
   BASE=$(basename "$URL" .pat)
-  if [ ! -f "$STORAGE/$BASE.system.img" ]; then
+  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
 
@@ -52,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")
 
@@ -65,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"
@@ -100,31 +114,65 @@ 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
+
+  rm -f "$RD"
+  rm -f "$RDC"
+
+  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"
 
-  RD="$TMP/rd.gz"
+  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=$?; } || :
 
-  SUM=$(md5sum "$RD" | cut -f 1 -d " ")
+  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"
-    (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
+    /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")"
     rm "$PAT"
@@ -138,14 +186,14 @@ 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
 
   rm -rf /run/extract && mkdir -p /run/extract
@@ -175,7 +223,10 @@ fi
 rm -rf "$TMP" && mkdir -p "$TMP"
 
 info "Install: Downloading $BASE.pat..."
-html "Install: Downloading DSM from Synology..."
+
+MSG="Downloading DSM..."
+PRG="Downloading DSM ([P])..."
+html "$MSG"
 
 PAT="/$BASE.pat"
 rm -f "$PAT"
@@ -186,12 +237,21 @@ if [[ "$URL" == "file://"* ]]; then
 
 else
 
-  { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+  SIZE=0
-  (( rc != 0 )) && error "Failed to download $URL, reason: $rc" && exit 69
+  [[ "${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")
 
@@ -228,7 +288,7 @@ 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"
@@ -249,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
 
@@ -289,15 +349,15 @@ 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"
 
 [ -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"
@@ -337,8 +397,5 @@ fi
 mv -f "$BOOT" "$STORAGE/$BASE.boot.img"
 rm -rf "$TMP"
 
-{ set +x; } 2>/dev/null
-[[ "$DEBUG" == [Yy1]* ]] && echo
-
 html "Installation finished successfully..."
 return 0

src/network.sh

@@ -3,12 +3,15 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
+: "${MAC:=""}"
 : "${DHCP:="N"}"
-: "${MAC:="02:11:32:AA:BB:CC"}"
+: "${NETWORK:="Y"}"
+: "${HOST_PORTS:=""}"
 
 : "${VM_NET_DEV:=""}"
 : "${VM_NET_TAP:="dsm"}"
 : "${VM_NET_MAC:="$MAC"}"
+: "${VM_NET_IP:="20.20.20.21"}"
 : "${VM_NET_HOST:="VirtualDSM"}"
 
 : "${DNSMASQ_OPTS:=""}"
@@ -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"
 
-  { 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
 
@@ -168,22 +205,28 @@ configureNAT() {
 
 closeNetwork() {
 
-  exec 30<&- || true
-  exec 40<&- || true
-
   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
+
     ip link set "$VM_NET_TAP" down || true
     ip link delete "$VM_NET_TAP" || true
 
   else
 
     local pid="/var/run/dnsmasq.pid"
-    [ -f "$pid" ] && pKill "$(<"$pid")"
+    [ -s "$pid" ] && pKill "$(<"$pid")"
 
     ip link set "$VM_NET_TAP" down promisc off || true
     ip link delete "$VM_NET_TAP" || true
@@ -196,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
 
@@ -209,17 +274,29 @@ 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/shm/qemu.ip
 
@@ -230,25 +307,30 @@ getInfo() {
 #  Configure Network
 # ######################################
 
-if [ ! -c /dev/vhost-net ]; then
+if [[ "$NETWORK" != [Yy1]* ]]; then
-  if mknod /dev/vhost-net c 10 238; then
+  NET_OPTS=""
-    chmod 660 /dev/vhost-net
+  return 0
-  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
 
+  ! checkOS && exit 19
+
   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)!"
-      error "You can only enable DHCP while the container is on a macvlan network!" && exit 26
-    fi
   fi
 
   # Configuration for DHCP IP
@@ -259,6 +341,10 @@ if [[ "$DHCP" == [Yy1]* ]]; then
 
 else
 
+  if [[ "$GATEWAY" != "172."* ]] && [[ "$GATEWAY" != "10."* ]]; then
+    ! checkOS && exit 19
+  fi
+
   # Shutdown nginx
   nginx -s stop 2> /dev/null
   fWait "nginx"

src/power.sh

@@ -10,10 +10,11 @@ API_HOST="127.0.0.1:2210"
 QEMU_TERM=""
 QEMU_PORT=7100
 QEMU_TIMEOUT=50
-QEMU_PID="/run/shm/qemu.pid"
+QEMU_DIR="/run/shm"
-QEMU_LOG="/run/shm/qemu.log"
+QEMU_PID="$QEMU_DIR/qemu.pid"
-QEMU_OUT="/run/shm/qemu.out"
+QEMU_LOG="$QEMU_DIR/qemu.log"
-QEMU_END="/run/shm/qemu.end"
+QEMU_OUT="$QEMU_DIR/qemu.out"
+QEMU_END="$QEMU_DIR/qemu.end"
 
 if [[ "$KVM" == [Nn]* ]]; then
   API_TIMEOUT=$(( API_TIMEOUT*2 ))
@@ -34,7 +35,9 @@ finish() {
   local pid
   local reason=$1
 
-  if [ -f "$QEMU_PID" ]; then
+  touch "$QEMU_END"
+
+  if [ -s "$QEMU_PID" ]; then
 
     pid=$(<"$QEMU_PID")
     echo && error "Forcefully terminating QEMU process, reason: $reason..."
@@ -43,7 +46,7 @@ finish() {
     while isAlive "$pid"; do
       sleep 1
       # Workaround for zombie pid
-      [ ! -f "$QEMU_PID" ] && break
+      [ ! -s "$QEMU_PID" ] && break
     done
   fi
 
@@ -62,7 +65,7 @@ terminal() {
 
   local dev=""
 
-  if [ -f "$QEMU_OUT" ]; then
+  if [ -s "$QEMU_OUT" ]; then
 
     local msg
     msg=$(<"$QEMU_OUT")
@@ -98,7 +101,6 @@ terminal() {
 
 _graceful_shutdown() {
 
-  local cnt=0
   local code=$?
   local pid url response
 
@@ -112,7 +114,7 @@ _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
@@ -144,6 +146,8 @@ _graceful_shutdown() {
 
   fi
 
+  local cnt=0
+
   while [ "$cnt" -lt "$QEMU_TIMEOUT" ]; do
 
     ! isAlive "$pid" && break
@@ -154,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
 
@@ -167,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

@@ -2,6 +2,9 @@
 set -Eeuo pipefail
 
 : "${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; }
@@ -18,7 +21,7 @@ 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
@@ -27,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=$?; } || :
@@ -101,3 +104,5 @@ info "-----------------------------------------------------------"
 info " You can now login to DSM at $msg"
 info "-----------------------------------------------------------"
 echo "" >&2
+
+exit 0

src/proc.sh

@@ -5,10 +5,14 @@ set -Eeuo pipefail
 
 : "${KVM:="Y"}"
 : "${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
-    error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
+      warn "you are using MacOS which has no KVM support, this will cause a major loss of performance."
-    [[ "$DEBUG" != [Yy1]* ]] && exit 88
+    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
+    KVM_OPTS=" -accel tcg,thread=multi"
+  fi
+
+  if [ -z "$CPU_MODEL" ]; then
     if [[ "$ARCH" == "amd64" ]]; then
-      CPU_MODEL="max,$CPU_FEATURES"
+      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,9 +1,9 @@
 #!/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; }
+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
 
@@ -12,7 +12,6 @@ trap 'error "Status $? while: $BASH_COMMAND (line $LINENO/$BASH_LINENO)"' ERR
 
 echo "❯ Starting $APP for Docker v$(</run/version)..."
 echo "❯ For support visit $SUPPORT"
-echo
 
 # Docker environment variables
 
@@ -24,21 +23,35 @@ echo
 : "${ARGUMENTS:=""}"      # Extra QEMU parameters
 : "${CPU_CORES:="1"}"     # Amount of CPU cores
 : "${RAM_SIZE:="1G"}"     # Maximum RAM amount
+: "${RAM_CHECK:="Y"}"     # Check available RAM
 : "${DISK_SIZE:="16G"}"   # Initial data disk size
 
 # Helper variables
 
+PROCESS="${APP,,}"
+PROCESS="${PROCESS// /-}"
+
 STORAGE="/storage"
-INFO="/dev/shm/msg.html"
+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>"
 
-KERNEL=$(uname -r | cut -b 1)
+SYS=$(uname -r)
-MINOR=$(uname -r | cut -d '.' -f2)
+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)
+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
 
@@ -46,11 +59,39 @@ if [ ! -d "$STORAGE" ]; then
   error "Storage folder ($STORAGE) not found!" && exit 13
 fi
 
-if [ ! -d "/run/shm" ]; then
+# Check filesystem
-  if [ -d "/dev/shm" ]; then
+FS=$(stat -f -c %T "$STORAGE")
-    ln -s /dev/shm /run/shm
+
-  else
+if [[ "${FS,,}" == "ecryptfs" ]] || [[ "${FS,,}" == "tmpfs" ]]; then
-    error "Folder /dev/shm not found!" && exit 14
+  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
 

src/serial.sh

@@ -9,6 +9,21 @@ set -Eeuo pipefail
 : "${HOST_MODEL:=""}"
 : "${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")
 HOST_ARGS+=("-cpu_arch=$HOST_CPU")

web/css/style.css

@@ -1,7 +1,14 @@
 body {
 	color: white;
 	background-color: #125bdb;
-	font-family: Verdana, Arial, sans-serif;
+	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 {
@@ -17,6 +24,7 @@ footer {
 	height: 40px;
 	text-align: center;
 	color: #0c8aeb;
+	text-shadow: 0 0 1px #0c8aeb;
 }
 
 #empty {
@@ -33,8 +41,13 @@ a:visited {
 
 footer a:link,
 footer a:visited,
-footer a:active { color: #0c8aeb; }
+footer a:active {
-footer a:hover { color: #73e6ff; }
+	color: #0c8aeb;
+}
+
+footer a:hover {
+	color: #73e6ff;
+}
 
 .loading:after {
 	content: " .";

web/nginx.conf

@@ -1,8 +1,6 @@
 server {
     listen 80;
-    listen [::]:80;
     listen 5000 default_server;
-    listen [::]:5000 default_server;
 
     autoindex on;
     tcp_nodelay on;