feat: Warn about UDP host ports (#1250)

*

.devcontainer/codespaces.yml

@@ -0,0 +1,19 @@
+services:
+  dsm:
+    container_name: dsm
+    image: ghcr.io/vdsm/virtual-dsm
+    environment:
+      RAM_SIZE: "half"
+      DISK_SIZE: "max"
+      CPU_CORES: "max"
+    devices:
+      - /dev/kvm
+      - /dev/net/tun
+    cap_add:
+      - NET_ADMIN
+    ports:
+      - 5000:5000
+    volumes:
+      - ./dsm:/storage
+    restart: on-failure
+    stop_grace_period: 2m

.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+  "name": "Virtual DSM",
+  "service": "dsm",
+  "forwardPorts": [5000],
+  "portsAttributes": {
+    "5000": {
+      "label": "Web",
+      "onAutoForward": "notify"
+    }
+  },
+  "otherPortsAttributes": {
+    "onAutoForward": "ignore"
+  }, 
+  "dockerComposeFile": "codespaces.yml"
+}

.dockerignore

@@ -1,4 +1,5 @@
 .dockerignore
+.devcontainer
 .git
 .github
 .gitignore
@@ -6,7 +7,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,41 @@
+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).
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Docker log
+      description: The logfile of the container (as shown by `docker logs dsm`).
+      render: shell
+    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,43 @@
+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).
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Docker log
+      description: The logfile of the container (as shown by `docker logs dsm`).
+      render: shell
+    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/renovate.json

@@ -1,6 +1,4 @@
 {
-  "extends": [
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-    "config:base",
+  "extends": ["config:recommended", ":disableDependencyDashboard"]
-    ":disableDependencyDashboard"
-  ]
 }

.github/workflows/build.yml

@@ -2,16 +2,6 @@ name: Build
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - master
-    paths-ignore:
-      - '**/*.md'
-      - '**/*.yml'
-      - '.gitignore'
-      - '.dockerignore'
-      - '.github/**'
-      - '.github/workflows/**'
 
 concurrency:
   group: build
@@ -32,13 +22,13 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       -
         name: Docker metadata
         id: meta
-        uses: docker/metadata-action@v5
+        uses: docker/metadata-action@v6
         with:
           context: git
           images: |
@@ -53,42 +43,40 @@ jobs:
           DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index
       - 
         name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
       -
         name: Login into Docker Hub
-        uses: docker/login-action@v3
+        uses: docker/login-action@v4
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       -
         name: Login to GitHub Container Registry
-        uses: docker/login-action@v3
+        uses: docker/login-action@v4
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
       -
         name: Build Docker image
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v7
         with:
           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 }}
           build-args: |
-            VCS_REF=${GITHUB_SHA::8}
             VERSION_ARG=${{ steps.meta.outputs.version }}
       -
         name: Create a release
         uses: action-pack/github-release@v2
-        env:
-          GITHUB_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
         with:
           tag: "v${{ steps.meta.outputs.version }}"
           title: "v${{ steps.meta.outputs.version }}"
+          token: ${{ secrets.REPO_ACCESS_TOKEN }}
       -
         name: Increment version variable
         uses: action-pack/bump@v2
@@ -101,3 +89,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,24 @@ jobs:
     name: shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+    - 
-      - name: Run ShellCheck
+      name: Checkout
+      uses: actions/checkout@v7
+    - parallel:
+      -
+        name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master
-env:
+        env:
-        SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2002 -e SC2223 -e SC2034 -e SC2064 -e SC2317 -e SC2028 -e SC2153 -e SC2004 
+          SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2034 -e SC2064 -e SC2317 -e SC2153 -e SC2028
+      - 
+        name: Lint Dockerfile
+        uses: hadolint/hadolint-action@v3.3.0
+        with:
+          dockerfile: Dockerfile
+          ignore: DL3008,DL3003,DL3006,DL3013
+          failure-threshold: warning
+      -
+        name: Validate JSON and YML files
+        uses: GrantBirki/json-yaml-validate@v5.0.0
+        with:
+          yaml_exclude_regex: ".*\\kubernetes\\.yml$"

.github/workflows/hub.yml

@@ -12,13 +12,15 @@ jobs:
   dockerHubDescription:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      -
-    - 
+        name: Checkout repo
-      name: Docker Hub Description
+        uses: actions/checkout@v7
-      uses: peter-evans/dockerhub-description@v3
+      - 
-      with:
+        name: Docker Hub Description
-        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        uses: peter-evans/dockerhub-description@v5
-        password: ${{ secrets.DOCKERHUB_TOKEN }}
+        with:
-        repository: ${{ secrets.DOCKERHUB_REPO }}
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
-        short-description: ${{ github.event.repository.description }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
-        readme-filepath: ./readme.md
+          repository: ${{ secrets.DOCKERHUB_REPO }}
+          short-description: ${{ github.event.repository.description }}
+          readme-filepath: ./readme.md

.github/workflows/review.yml

@@ -0,0 +1,71 @@
+on:
+  pull_request:
+
+name: "Review"
+
+permissions:
+  contents: read
+  pull-requests: write
+  checks: write
+
+jobs:
+  review:
+    name: review
+    runs-on: ubuntu-latest
+    steps:
+    -
+      name: Checkout
+      uses: actions/checkout@v7
+    - parallel:
+      -
+        name: Spelling
+        uses: reviewdog/action-misspell@v1
+        with:
+          locale: "US"
+          level: warning
+          pattern: |
+            *.md
+            *.sh
+          reporter: github-pr-review
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Hadolint
+        uses: reviewdog/action-hadolint@v1
+        with:
+          level: warning
+          fail_level: error
+          reporter: github-pr-review
+          hadolint_ignore: DL3008 DL3003 DL3006 DL3013
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: YamlLint
+        uses: reviewdog/action-yamllint@v1
+        with:
+          level: warning
+          reporter: github-pr-review
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: ActionLint
+        uses: reviewdog/action-actionlint@v1
+        with:
+          level: warning
+          reporter: github-pr-review
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Shellformat
+        uses: reviewdog/action-shfmt@v1
+        if: false
+        with:
+          level: warning
+          fail_on_error: "true"
+          shfmt_flags: "-i 2 -ci -bn"
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Shellcheck
+        uses: reviewdog/action-shellcheck@v1
+        with:
+          level: warning
+          fail_level: error
+          reporter: github-pr-review
+          shellcheck_flags: -x -e SC1091 -e SC2001 -e SC2034 -e SC2064 -e SC2317 -e SC2153 -e SC2028
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -1,10 +1,6 @@
 on:
   workflow_dispatch:
   pull_request:
-    paths:
-      - '**/*.sh'
-      - '.github/workflows/test.yml'
-      - '.github/workflows/check.yml'
 
 name: "Test"
 permissions: {}

Dockerfile

@@ -1,57 +1,87 @@
-FROM qemux/qemu-host as builder
+# syntax=docker/dockerfile:1
-
-#  FROM golang as builder
-#  WORKDIR /
-#  RUN git clone https://github.com/qemu-tools/qemu-host.git
-#  WORKDIR /qemu-host/src
-#  RUN go mod download
-#  RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o /qemu-host.bin .
 
+FROM qemux/qemu-host:2.05 AS builder
 FROM debian:trixie-slim
 
+ARG TARGETARCH
+ARG TARGETPLATFORM
+ARG VERSION_ARG="0.0"
+ARG VERSION_PASST="2026_06_11"
+
 ARG DEBCONF_NOWARNINGS="yes"
-ARG DEBIAN_FRONTEND noninteractive
+ARG DEBIAN_FRONTEND="noninteractive"
+ARG DEBCONF_NONINTERACTIVE_SEEN="true"
 
-RUN apt-get update && apt-get -y upgrade && \
+RUN <<EOF
-    apt-get --no-install-recommends -y install \
+  set -eu
-        jq \
-        tini \
-        curl \
-        cpio \
-        wget \
-        fdisk \
-        unzip \
-        socat \
-        procps \
-        xz-utils \
-        iptables \
-        iproute2 \
-        dnsmasq \
-        net-tools \
-        ca-certificates \
-        netcat-openbsd \
-        qemu-system-x86 \
-    && apt-get clean \
-    && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
-COPY ./src /run/
+  apt-get update
-COPY --from=builder /qemu-host.bin /run/host.bin
+  apt-get --no-install-recommends -y install \
-RUN chmod +x /run/*.sh && chmod +x /run/*.bin
+    jq \
+    tini \
+    curl \
+    wget \
+    fdisk \
+    unzip \
+    nginx \
+    procps \
+    ipcalc \
+    ethtool \
+    python3 \
+    python3-pip \
+    python3-msgpack \
+    python3-pysodium \
+    xz-utils \
+    iptables \
+    iproute2 \
+    dnsmasq \
+    fakeroot \
+    apt-utils \
+    net-tools \
+    e2fsprogs \
+    qemu-utils \
+    websocketd \
+    iputils-ping \
+    inotify-tools \
+    ca-certificates \
+    netcat-openbsd \
+    qemu-system-x86
+
+  # Install Passt package
+  wget "https://github.com/qemus/passt/releases/download/v${VERSION_PASST}/passt_${VERSION_PASST}_${TARGETARCH}.deb" -O /tmp/passt.deb -q --timeout=10
+  dpkg -i /tmp/passt.deb
+
+  apt-get clean
+
+  # Install Python dependencies
+  pip3 install --no-cache-dir --break-system-packages --root-user-action=ignore dissect.cstruct
+
+  # Configure QEMU
+  mkdir -p /etc/qemu
+  echo "allow br0" > /etc/qemu/bridge.conf
+
+  # Configure nginx
+  unlink /etc/nginx/sites-enabled/default
+  sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf
+
+  # Set version file
+  echo "$VERSION_ARG" > /etc/version
+
+  rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+EOF
+
+COPY --chmod=755 ./src /run/
+COPY --chmod=755 ./web /var/www/
+COPY --chmod=755 --from=builder /qemu-host.bin /run/host.bin
+COPY --chmod=744 ./web/conf/nginx.conf /etc/nginx/default.conf
+ADD --chmod=775 https://raw.githubusercontent.com/sud0woodo/patology/refs/heads/main/patology.py /run/extract.py
 
 VOLUME /storage
+EXPOSE 22 139 445 5000
 
-EXPOSE 22
+ENV RAM_SIZE="2G"
-EXPOSE 80
+ENV CPU_CORES="2"
-EXPOSE 139
+ENV DISK_SIZE="256G"
-EXPOSE 445
-EXPOSE 5000
-
-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
 

agent/agent.sh

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

agent/service.sh

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

compose.yml

@@ -0,0 +1,17 @@
+services:
+  dsm:
+    container_name: dsm
+    image: vdsm/virtual-dsm
+    environment:
+      DISK_SIZE: "256G"
+    devices:
+      - /dev/kvm
+      - /dev/net/tun
+    cap_add:
+      - NET_ADMIN
+    ports:
+      - 5000:5000
+    volumes:
+      - ./dsm:/storage
+    restart: always
+    stop_grace_period: 2m

docker-compose.yml

@@ -1,23 +0,0 @@
-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
-            - /dev/net/tun
-            - /dev/vhost-net
-        device_cgroup_rules:
-            - 'c *:* rwm'
-        cap_add:
-            - NET_ADMIN        
-        ports:
-            - 5000:5000
-        volumes:
-            - /opt/dsm:/storage
-        restart: on-failure
-        stop_grace_period: 1m

docs/environment.md

@@ -0,0 +1,91 @@
+# Environment Variables
+
+This page lists all the environment variables that can be used to configure the container.
+
+## 💽 Virtual DSM
+
+| Variable | Default | Description |
+|---|---|---|
+| `URL` |  | URL or local path of the DSM `.pat` installation file. When unset, the default Virtual DSM image is downloaded automatically. |
+| `HOST_MAC` |  | MAC address reported to DSM. |
+| `HOST_MODEL` |  | Synology host device model reported to DSM. |
+| `HOST_SERIAL` |  | Synology host serial number reported to DSM. |
+| `GUEST_SERIAL` |  | Synology guest serial number reported to DSM. |
+
+## 🧠 CPU and Memory
+
+| Variable | Default | Description |
+|---|---|---|
+| `CPU_CORES` | `2` | Number of CPU cores assigned to the VM. Can also be set to `max` or `half`. |
+| `CPU_MODEL` | `host` | QEMU CPU model to use. |
+| `CPU_FLAGS` |  | Additional QEMU CPU flags. |
+| `HOST_CPU` |  | CPU name reported to DSM. Automatically selected when unset. |
+| `KVM` | `Y` | Enables KVM hardware acceleration. Set to `N` to disable. |
+| `RAM_SIZE` | `2G` | Amount of RAM assigned to the VM, for example `2G`, `4G`, `max`, or `half`. |
+| `RAM_CHECK` | `Y` | Checks whether enough host memory is available before starting the VM. |
+
+## 💾 Storage
+
+| Variable | Default | Description |
+|---|---|---|
+| `DISK_SIZE` | `256G` | Size of the main data disk. |
+| `DISK_FMT` | `raw` | Disk image format, usually `raw` or `qcow2`. |
+| `DISK_TYPE` | `scsi` | Disk controller/device type, such as `sata`, `scsi`, `nvme`, or `blk`. |
+| `DISK_CACHE` | `none` | QEMU disk cache mode, for example `none` or `writeback`. |
+| `DISK_IO` | `native` | QEMU disk I/O mode, for example `native`, `threads`, or `io_uring`. |
+| `DISK_DISCARD` | `unmap` | Enables TRIM/unmap support for the data disk. |
+| `DISK_ROTATION` | `1` | Rotation rate reported to the guest. Use `1` for SSD-like storage. |
+| `DISK_FLAGS` |  | Additional options used when creating qcow2 disks. |
+| `ALLOCATE` | `N` | Preallocates disk space when creating the data disk. |
+| `STORAGE` | `/storage` | Storage directory used for disks, firmware variables, and generated files. |
+
+## 🌐 Networking
+
+| Variable | Default | Description |
+|---|---|---|
+| `NETWORK` | `Y` | Network mode. Common values are `Y` for NAT, `passt`, `slirp`, or `N` to disable networking. |
+| `DHCP` | `N` | Enables DHCP/macvtap mode so the VM receives an address from the external LAN. |
+| `IP` |  | Guest IP address override. |
+| `MAC` |  | Guest network adapter MAC address. |
+| `HOST` | `VirtualDSM` | Hostname assigned to the VM. |
+| `DEV` | `eth0` | Host/container network interface to use. |
+| `MTU` |  | Network MTU to use for the guest interface. |
+| `MASK` | `255.255.255.0` | IPv4 netmask. |
+| `TAP` | `dsm` | TAP/macvtap interface name. |
+| `BRIDGE` | `docker` | Bridge name used for NAT networking. |
+| `ADAPTER` | `virtio-net-pci` | QEMU network adapter model. |
+| `HOST_PORTS` |  | Ports reserved for services running on the host/container side. |
+| `USER_PORTS` |  | Additional ports to forward to the VM when using user-mode networking. |
+| `DNSMASQ_OPTS` |  | Additional dnsmasq options. |
+| `DNSMASQ_DEBUG` | `N` | Enables dnsmasq log tailing. |
+| `DNSMASQ_DISABLE` | `N` | Disables the internal dnsmasq resolver. |
+| `PASST_OPTS` |  | Additional passt options. |
+| `PASST_DEBUG` | `N` | Enables passt debug output. |
+
+## 🖥️ Display
+
+| Variable | Default | Description |
+|---|---|---|
+| `DISPLAY` | `none` | QEMU display backend. Common values are `vnc`, `disabled`, or `none`. |
+| `VGA` | `none` | QEMU video adapter model. |
+| `GPU` | `N` | Enables Intel iGPU acceleration. |
+| `RENDERNODE` | `/dev/dri/renderD128` | Render node used for GPU acceleration. |
+
+## 🔌 Shutdown
+
+| Variable | Default | Description |
+|---|---|---|
+| `SHUTDOWN` | `Y` | Enables graceful shutdown. |
+| `TIMEOUT` | `115` | Timeout used while waiting for DSM to shut down. |
+| `API_TIMEOUT` | `90` | Timeout used for the shutdown API call. |
+
+## 🐞 Debugging
+
+| Variable | Default | Description |
+|---|---|---|
+| `DEBUG` | `N` | Enables verbose debug output. |
+| `TRACE` | `N` | Enables shell command tracing. |
+| `COM_PORT` | `2210` | Internal communication port used by the DSM host helper. |
+| `CHR_PORT` | `12345` | Internal character device port used by the DSM host helper. |
+| `HOST_DEBUG` | `N` | Enables debug output for the host helper. |
+| `ARGUMENTS` |  | Additional raw QEMU arguments appended to the generated command line. |

kubernetes.yml

@@ -0,0 +1,77 @@
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: dsm-pvc
+spec:
+  accessModes:
+  - ReadWriteOnce
+  resources:
+    requests:
+      storage: 256Gi
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: dsm
+  labels:
+    name: dsm
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: dsm
+  template:
+    metadata:
+      labels:
+        app: dsm
+    spec:
+      containers:
+      - name: dsm
+        image: vdsm/virtual-dsm
+        env:
+        - name: DISK_SIZE
+          value: "256G"
+        ports:
+          - containerPort: 5000
+            name: http
+            protocol: TCP
+        securityContext:
+          capabilities:
+            add:
+            - NET_ADMIN
+          privileged: true
+        volumeMounts:
+        - mountPath: /storage
+          name: storage
+        - mountPath: /dev/kvm
+          name: dev-kvm
+        - mountPath: /dev/net/tun
+          name: dev-tun
+      terminationGracePeriodSeconds: 120
+      volumes:
+      - name: storage
+        persistentVolumeClaim:
+          claimName: dsm-pvc
+      - hostPath:
+          path: /dev/kvm
+        name: dev-kvm
+      - hostPath:
+          path: /dev/net/tun
+          type: CharDevice
+        name: dev-tun
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: dsm
+spec:
+  internalTrafficPolicy: Cluster
+  ports:
+    - name: http
+      port: 5000
+      protocol: TCP
+      targetPort: 5000
+  selector:
+    app: dsm
+  type: ClusterIP

readme.md

@@ -1,220 +1,294 @@
-<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">
 
 [![Build]][build_url]
 [![Version]][tag_url]
 [![Size]][tag_url]
+[![Package]][pkg_url]
 [![Pulls]][hub_url]
 
 </div></h1>
 
-Virtual DSM in a docker container.
+Virtual DSM in a Docker container.
 
-## Features
+## Features ✨
 
- - Multiple disks
+- Runs Virtual DSM inside a Docker container
- - KVM acceleration
+- Automatic download of the installation files
- - GPU passthrough
+- Web-based access to the DSM desktop
- - Upgrades supported
+- Near-native performance with KVM acceleration
+- Customizable CPU, memory, and storage allocation
+- Supports multiple disks and physical disk passthrough
+- Supports NAT, user-mode, macvlan, and macvtap networking
 
-## Usage
+## Usage  🐳
 
-Via `docker-compose.yml`
+##### Docker Compose:
 
 ```yaml
-version: "3"
 services:
   dsm:
     container_name: dsm
-    image: vdsm/virtual-dsm:latest
+    image: vdsm/virtual-dsm
     environment:
-      DISK_SIZE: "16G"
+      DISK_SIZE: "256G"
     devices:
       - /dev/kvm
+      - /dev/net/tun
     cap_add:
       - NET_ADMIN
     ports:
       - 5000:5000
     volumes:
-      - /opt/dsm:/storage
+      - ./dsm:/storage
-    restart: on-failure
+    restart: always
-    stop_grace_period: 1m
+    stop_grace_period: 2m
 ```
 
-Via `docker run`
+##### Docker CLI:
 
 ```bash
-docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 60 vdsm/virtual-dsm:latest
+docker run -it --rm --name dsm -e "DISK_SIZE=256G" -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/dsm:/storage" --stop-timeout 120 docker.io/vdsm/virtual-dsm
 ```
 
-## FAQ
+##### Kubernetes:
 
-  * ### How do I change the size of the virtual disk?
+```shell
+kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/master/kubernetes.yml
+```
 
-    To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
+##### GitHub Codespaces:
 
-    ```yaml
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/vdsm/virtual-dsm)
-    environment:
-      DISK_SIZE: "128G"
-    ```
 
-    This can also be used to resize the existing disk to a larger capacity without any data loss. 
+## Requirements ⚙️
 
-  * ### How do I change the location of the virtual disk?
+ - A Linux host with KVM support, or Docker Desktop / Podman on Windows 11 with nested virtualization enabled.
+ - At least 2 GB of RAM available.
+ - At least 32 GB of free disk space.
 
-    To change the virtual disk's location from the default Docker volume, include the following bind mount in your compose file:
+> [!NOTE]
+> Docker Desktop on macOS and Windows 10 do not currently provide the required KVM support for this image.
 
-    ```yaml
+## FAQ 💬
-    volumes:
-      - /home/user/data:/storage
-    ```
 
-    Replace the example path `/home/user/data` with the desired storage folder.
+### How do I use it?
 
-  * ### How do I add multiple disks?
+  Very simple! These are the steps:
   
-    To create additional disks, modify your compose file like this:
+  - Start the container and connect to [port 5000](http://127.0.0.1:5000/) using your web browser.
 
-    ```yaml
+  - Wait until DSM finishes its installation
-    environment:
-      DISK2_SIZE: "32G"
-      DISK3_SIZE: "64G"
-    volumes:
-      - /home/example:/storage2
-      - /mnt/data/example:/storage3
-    ```
  
-  * ### How do I change the space reserved by the virtual disk? 
+  - Choose a username and password, and you will be taken to the desktop.
   
-    By default, the entire disk space is reserved in advance. To create a growable disk that only reserves the space that is actually used, add the following environment variable:
+  Enjoy your brand new NAS, and don't forget to star this repo!
 
-    ```yaml
+### How do I change the storage location?
-    environment:
-      ALLOCATE: "N"
-    ```
 
-    Keep in mind that this will not affect any of your existing disks, it only applies to newly created disks.
+  To change the storage location, include the following bind mount in your compose file:
 
-  * ### How do I increase the amount of CPU or RAM?
+  ```yaml
+  volumes:
+    - ./dsm:/storage
+  ```
 
-    By default, a single core and 1 GB of RAM are allocated to the container. To increase this, add the following environment variables:
+  Replace the example path `./dsm` with the desired storage folder or named volume.
  
-    ```yaml
+### How do I change the size of the disk?
-    environment:
-      RAM_SIZE: "4G"
-      CPU_CORES: "4"
-    ```
 
-  * ### How do I verify if my system supports KVM?
+  To expand the default size of 256 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
 
-    To verify if your system supports KVM, run the following commands:
+  ```yaml
+  environment:
+    DISK_SIZE: "512G"
+  ```
   
-    ```bash
+> [!TIP]
-    sudo apt install cpu-checker
+> This can also be used to resize an existing disk to a larger capacity without any data loss.
-    sudo kvm-ok
-    ```
 
-    If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check your BIOS settings.
+### How do I add multiple disks?
 
-  * ### How do I assign an individual IP address to the container?
+  To create additional disks, modify your compose file like this:
   
-    By default, the container uses bridge networking, which shares the IP address with the host. 
+  ```yaml
+  environment:
+    DISK2_SIZE: "500G"
+    DISK3_SIZE: "750G"
+  volumes:
+    - ./example2:/storage2
+    - ./example3:/storage3
+  ```
 
-    If you want to assign an individual IP address to the container, you can create a macvlan network as follows:
+### How do I pass through a disk?
 
-    ```bash
+   You can pass through disk devices or partitions directly by adding them to your compose file in this way:
-    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
+  devices:
+    - /dev/sdb:/disk1
+    - /dev/sdc1:/disk2
+  ```
 
-    Once you have created the network, change your compose file to look as follows:
+  Make sure it is totally empty (without any filesystem), otherwise DSM may not format it as a volume.
 
-    ```yaml
+### How do I change the amount of CPU or RAM?
-    services:
-      dsm:
-        container_name: dsm
-        ..<snip>..
-        networks:
-          vdsm:
-            ipv4_address: 192.168.0.100
 
-    networks:
+  By default, Virtual DSM will be allowed to use 2 CPU cores and 2 GB of RAM.
-      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.
+  If you want to adjust this, you can specify the desired amount using the following environment variables:
 
-    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.
+  ```yaml
+  environment:
+    RAM_SIZE: "4G"
+    CPU_CORES: "4"
+  ```
 
-  * ### How can the container acquire an IP address from my router?
+### How do I verify if my system supports KVM?
 
-    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.
+  First check if your software is compatible using this chart:
 
-    To enable this feature, add the following lines to your compose file:
+  | **Product**  | **Linux** | **Win11** | **Win10** | **macOS** |
+  |---|---|---|---|---|
+  | Docker CLI        | ✅   | ✅       | ❌        | ❌ |
+  | Docker Desktop    | ❌   | ✅       | ❌        | ❌ | 
+  | Podman CLI        | ✅   | ✅       | ❌        | ❌ | 
+  | Podman Desktop    | ✅   | ✅       | ❌        | ❌ | 
 
-    ```yaml
+  After that you can run the following commands in Linux to check your system:
-    environment:
-      DHCP: "Y"
-    devices:
-      - /dev/vhost-net
-    device_cgroup_rules:
-      - 'c *:* rwm'
-    ```
 
-    Please note that even if you don't need DHCP, it's still recommended to enable this feature as it prevents NAT issues and increases performance by using a `macvtap` interface.
+  ```bash
+  sudo apt install cpu-checker
+  sudo kvm-ok
+  ```
 
-  * ### How do I passthrough the GPU?
+  If you receive an error from `kvm-ok` indicating that KVM cannot be used, please check whether:
 
-    To passthrough your Intel GPU, add the following lines to your compose file:
+  - the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your BIOS.
 
-    ```yaml
+  - you enabled "nested virtualization" if you are running the container inside a virtual machine.
-    environment:
-      GPU: "Y"
-    devices:
-      - /dev/dri
-    ```
 
-    This can be used to enable the facial recognition function in Synology Photos for example.
+  - you are not using a cloud provider, as most of them do not allow nested virtualization for their VPSs.
 
-  * ### How do I install a specific version of vDSM?
+  If you did not receive any error from `kvm-ok` but the container still complains about a missing KVM device, it could help to add `privileged: true` to your compose file (or `sudo` to your `docker` command) to rule out any permission issue.
 
-    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:
+### How do I assign an individual IP address to the container?
 
-    ```yaml
+  By default, the container uses bridge networking, which shares the IP address with the host. 
-    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.
+  If you want to assign an individual IP address to the container, you can create a macvlan network as follows:
 
-  * ### What are the differences compared to the standard DSM?
+  ```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
+  ```
   
-    There are only two minor differences: the Virtual Machine Manager package is not available, and Surveillance Station will not include any free licenses.
+  Be sure to modify these values to match your local subnet. 
 
-  * ### Is this project legal?
+  Once you have created the network, change your compose file to look as follows:
 
-    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
+  services:
+    dsm:
+      container_name: dsm
+      ..<snip>..
+      networks:
+        vdsm:
+          ipv4_address: 192.168.0.100
 
-    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.
+  networks:
+    vdsm:
+      external: true
+  ```
  
-## Disclaimer
+  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.
 
-Only run this container on Synology hardware, any other use is not permitted by their EULA. The product names, logos, brands, and other trademarks referred to within this project are the property of their respective trademark holders. This project is not affiliated, sponsored, or endorsed by Synology, Inc.
+> [!IMPORTANT]
+> 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 DSM acquire an IP address from my router?
+
+  After configuring the container for [macvlan](#how-do-i-assign-an-individual-ip-address-to-the-container), 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 mode, in which the container and DSM will have separate IP addresses, add the following lines to your compose file:
+
+  ```yaml
+  environment:
+    DHCP: "Y"
+  devices:
+    - /dev/vhost-net
+  device_cgroup_rules:
+    - 'c *:* rwm'
+  ```
+
+### How do I pass through the GPU?
+
+  To pass through your Intel GPU, add the following lines to your compose file:
+
+  ```yaml
+  environment:
+    GPU: "Y"
+  devices:
+    - /dev/dri
+  ```
+
+> [!NOTE]
+> This can be used to enable the facial recognition function in Synology Photos, but does not provide hardware transcoding for video.
+
+### How do I install a specific version of vDSM?
+
+  By default, version 7.2 will be installed, but if you prefer an older version, you can add the download URL of the `.pat` file to your compose file as follows:
+
+  ```yaml
+  environment:
+    URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
+  ```
+
+  With this method, it is even possible to switch back and forth between versions while keeping your file data intact.
+
+  Alternatively, you can also skip the download and use a local file instead, by binding it in your compose file in this way:
+  
+  ```yaml
+  volumes:
+    - ./DSM_VirtualDSM_42218.pat:/boot.pat
+  ```
+
+  Replace the example path `./DSM_VirtualDSM_42218.pat` with the filename of your desired `.pat` file. The value of `URL` will be ignored in this case.
+
+### Are these all available options?
+
+No. For a complete overview of all supported settings, see the [environment variables](docs/environment.md) page.
+
+### 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 material owned by Synology. Neither does it try to circumvent any copyright protection measures.
+  
+  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 🌟
+[![Stargazers](https://raw.githubusercontent.com/star-stats/stars/refs/heads/data/charts/vdsm-virtual-dsm.svg)](https://github.com/vdsm/virtual-dsm/stargazers)
+
+## Disclaimer ⚖️
+
+*Only run this container on Synology hardware, any other use is not permitted by their EULA. The product names, logos, brands, and other trademarks referred to within this project are the property of their respective trademark holders. This project is not affiliated, sponsored, or endorsed by Synology, Inc.*
 
 [build_url]: https://github.com/vdsm/virtual-dsm/
 [hub_url]: https://hub.docker.com/r/vdsm/virtual-dsm
 [tag_url]: https://hub.docker.com/r/vdsm/virtual-dsm/tags
+[pkg_url]: https://github.com/vdsm/virtual-dsm/pkgs/container/virtual-dsm
 
 [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
+[Package]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fvdsm%2Fvirtual-dsm%2Fvirtual-dsm.json&query=%24.downloads&logo=github&style=flat&color=066da5&label=pulls

src/check.sh

@@ -1,61 +1,38 @@
 #!/usr/bin/env bash
-set -u
+set -Eeuo pipefail
 
-[ ! -f "/run/qemu.pid" ] && echo "QEMU not running yet.." && exit 0
+cd /run
-[ -f "/run/qemu.count" ] && echo "QEMU is shutting down.." && exit 1
+. utils.sh      # Load functions
 
-file="/run/dsm.url"
+: "${DHCP:="N"}"
+: "${NETWORK:="Y"}"
 
-if [ ! -f  "$file" ]; then
+[ -f "/run/shm/qemu.end" ] && echo "QEMU is shutting down..." && exit 1
+[ ! -s "/run/shm/qemu.pid" ] && echo "QEMU is not running yet..." && exit 0
+disabled "$NETWORK" && echo "Networking is disabled." && exit 0
 
-  # Retrieve IP from guest VM for Docker healthcheck
+file="/run/shm/dsm.url"
-  RESPONSE=$(curl -s -m 30 -S http://127.0.0.1:2210/read?command=10 2>&1)
+address="/run/shm/qemu.ip"
+gateway="/run/shm/qemu.gw"
 
-  if [[ ! "${RESPONSE}" =~ "\"success\"" ]] ; then
+[ ! -s  "$file" ] && echo "DSM has not enabled networking yet..." && exit 1
-    echo "Failed to connect to guest: $RESPONSE" && exit 1
+
+location=$(<"$file")
+
+if ! curl -m 20 -ILfSs "http://$location/" > /dev/null; then
+
+  if enabled "$DHCP"; then
+    ip=$(<"$address")
+    echo "Failed to reach DSM at http://$location"
+  else
+    ip=$(<"$gateway")
+    port="${location##*:}"
+    echo "Failed to reach DSM at port $port"
   fi
 
-  # Retrieve the HTTP port number
+  echo "You might need to whitelist IP $ip in the DSM firewall." && exit 1
-  if [[ ! "${RESPONSE}" =~ "\"http_port\"" ]] ; then
-    echo "Failed to parse response from guest: $RESPONSE" && exit 1
-  fi
-
-  rest=${RESPONSE#*http_port}
-  rest=${rest#*:}
-  rest=${rest%%,*}
-  PORT=${rest%%\"*}
-
-  [ -z "${PORT}" ] && echo "Guest has not set a portnumber yet.." && exit 1
-
-  # Retrieve the IP address
-  if [[ ! "${RESPONSE}" =~ "eth0" ]] ; then
-    echo "Failed to parse response from guest: $RESPONSE" && exit 1
-  fi
-
-  rest=${RESPONSE#*eth0}
-  rest=${rest#*ip}
-  rest=${rest#*:}
-  rest=${rest#*\"}
-  IP=${rest%%\"*}
-
-  [ -z "${IP}" ] && echo "Guest has not received an IP yet.." && exit 1
-
-  echo "${IP}:${PORT}" > $file
 
 fi
 
-LOCATION=$(cat "$file")
+echo "Healthcheck OK"
-
-if ! curl -m 20 -ILfSs "http://${LOCATION}/" > /dev/null; then
-  rm -f $file
-  echo "Failed to reach http://${LOCATION}"
-  exit 1
-fi
-
-if [[ "$LOCATION" == "20.20"* ]]; then
-  echo "Healthcheck OK"
-else
-  echo "Healthcheck OK ( ${LOCATION%:*} )"
-fi
-
 exit 0

src/config.sh

@@ -1,40 +1,16 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -Eeuo pipefail
 
-KVM_ERR=""
+DEF_OPTS="-nodefaults -boot strict=on"
-KVM_OPTS=""
+RAM_OPTS=$(echo "-m ${RAM_SIZE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+MON_OPTS="-name $PROCESS,process=$PROCESS,debug-threads=on -pidfile $QEMU_PID"
+CPU_OPTS="-cpu $CPU_FLAGS -smp $CPU_CORES,sockets=1,dies=1,cores=$CPU_CORES,threads=1"
+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+=" -object rng-random,id=objrng0,filename=/dev/urandom"
+DEV_OPTS+=" -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
 
-if [ -e /dev/kvm ] && sh -c 'echo -n > /dev/kvm' &> /dev/null; then
+ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $DEV_OPTS $ARGUMENTS"
-  if ! grep -q -e vmx -e svm /proc/cpuinfo; then
-    KVM_ERR="(vmx/svm disabled)"
-  fi
-else
-  [ -e /dev/kvm ] && KVM_ERR="(no write access)" || KVM_ERR="(device file missing)"
-fi
-
-if [ -n "${KVM_ERR}" ]; then
-  if [ "$ARCH" == "amd64" ]; then
-    error "KVM acceleration not detected ${KVM_ERR}, see the FAQ about this."
-    [[ "${DEBUG}" != [Yy1]* ]] && exit 88
-  fi
-else
-  KVM_OPTS=",accel=kvm -enable-kvm -cpu host"
-fi
-
-DEF_OPTS="-nographic -nodefaults -boot strict=on -display none"
-RAM_OPTS=$(echo "-m ${RAM_SIZE}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
-CPU_OPTS="-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}"
-EXTRA_OPTS="-device virtio-balloon-pci,id=balloon0,bus=pcie.0,addr=0x4"
-EXTRA_OPTS="$EXTRA_OPTS -object rng-random,id=objrng0,filename=/dev/urandom"
-EXTRA_OPTS="$EXTRA_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
-
-if [[ "${GPU}" == [Yy1]* ]] && [[ "$ARCH" == "amd64" ]]; then
-  DEF_OPTS="-nodefaults -boot strict=on -display egl-headless,rendernode=/dev/dri/renderD128"
-  DEF_OPTS="${DEF_OPTS} -device virtio-vga,id=video0,max_outputs=1,bus=pcie.0,addr=0x1"
-fi
-
-ARGS="${DEF_OPTS} ${CPU_OPTS} ${RAM_OPTS} ${MAC_OPTS} ${MON_OPTS} ${SERIAL_OPTS} ${NET_OPTS} ${DISK_OPTS} ${EXTRA_OPTS} ${ARGUMENTS}"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')
 
 return 0

src/disk.sh

@@ -3,220 +3,801 @@ 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_uring'
-: ${DISK_CACHE:='none'}   # Caching mode, can be set to 'writeback' for better performance
+: "${DISK_FMT:="raw"}"            # Disk file format, 'raw' by default for best performance
-: ${DISK_DISCARD:='on'}   # Controls whether unmap (TRIM) commands are passed to the host.
+: "${DISK_TYPE:=""}"              # Device type to be used, "sata", "nvme", "blk" or "scsi"
-: ${DISK_ROTATION:='1'}   # Rotation rate, set to 1 for SSD storage and increase for HDD
+: "${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:="unmap"}"      # 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
+
+# Sanitize all variables
+DISK_IO=$(strip "$DISK_IO")
+DISK_FMT=$(strip "$DISK_FMT")
+DISK_TYPE=$(strip "$DISK_TYPE")
+DISK_FLAGS=$(strip "$DISK_FLAGS")
+DISK_CACHE=$(strip "$DISK_CACHE")
+DISK_DISCARD=$(strip "$DISK_DISCARD")
+DISK_ROTATION=$(strip "$DISK_ROTATION")
 
 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="\
+if ! setOwner "$BOOT"; then
-    -device virtio-scsi-pci,id=hw-synoboot,bus=pcie.0,addr=0xa \
+  error "Failed to set the owner for \"$BOOT\" !"
-    -drive file=${BOOT},if=none,id=drive-synoboot,format=raw,cache=${DISK_CACHE},aio=${DISK_IO},discard=${DISK_DISCARD},detect-zeroes=on \
+fi
-    -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,bus=pcie.0,addr=0xb \
+if ! setOwner "$SYSTEM"; then
-    -drive file=${SYSTEM},if=none,id=drive-synosys,format=raw,cache=${DISK_CACHE},aio=${DISK_IO},discard=${DISK_DISCARD},detect-zeroes=on \
+  error "Failed to set the owner for \"$SYSTEM\" !"
-    -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"
+fi
+
+fmt2ext() {
+  local DISK_FMT="$1"
+
+  case "${DISK_FMT,,}" in
+    qcow2) echo "qcow2" ;;
+    raw) echo "img" ;;
+    *) error "Unrecognized disk format: $DISK_FMT" && exit 78 ;;
+  esac
+}
+
+ext2fmt() {
+  local DISK_EXT="$1"
+
+  case "${DISK_EXT,,}" in
+    qcow2) echo "qcow2" ;;
+    img) echo "raw" ;;
+    *) error "Unrecognized file extension: .$DISK_EXT" && exit 78 ;;
+  esac
+}
+
+getSize() {
+
+  local DISK_FILE="$1"
+  local DISK_EXT DISK_FMT size
+
+  DISK_EXT=$(echo "${DISK_FILE//*./}" | sed 's/^.*\.//')
+  DISK_FMT=$(ext2fmt "$DISK_EXT")
+
+  case "${DISK_FMT,,}" in
+    raw)
+      stat -c%s "$DISK_FILE"
+      ;;
+
+    qcow2)
+      size=$(qemu-img info --output=json -f "$DISK_FMT" "$DISK_FILE" | jq -r '."virtual-size" // empty')
+      if [[ ! "$size" =~ ^[0-9]+$ ]]; then
+        error "Failed to determine virtual size of $DISK_FILE"
+        exit 78
+      fi
+      echo "$size"
+      ;;
+
+    *)
+      error "Unrecognized disk format: $DISK_FMT"
+      exit 78
+      ;;
+  esac
+}
+
+isCow() {
+  local FS="$1"
+
+  if [[ "${FS,,}" == "btrfs" ]]; then
+    return 0
+  fi
+
+  return 1
+}
+
+supportsDirect() {
+  local FS="$1"
+
+  if [[ "${FS,,}" == "ecryptfs" || "${FS,,}" == "tmpfs" ]]; then
+    return 1
+  fi
+
+  return 0
+}
+
+allocateRaw() {
+
+  local DISK_FILE="$1"
+  local DATA_SIZE="$2"
+
+  if disabled "$ALLOCATE"; then
+    truncate -s "$DATA_SIZE" "$DISK_FILE"
+    return $?
+  fi
+
+  fallocate -l "$DATA_SIZE" "$DISK_FILE" &>/dev/null && return 0
+  fallocate -l -x "$DATA_SIZE" "$DISK_FILE" && return 0
+  truncate -s "$DATA_SIZE" "$DISK_FILE" || return 1
+
+  return 0
+}
+
+getDiskOptions() {
+
+  local FS="$1"
+  local DISK_FMT="$2"
+  local DISK_PARAM="$DISK_ALLOC"
+
+  isCow "$FS" && DISK_PARAM+=",nocow=on"
+
+  if [[ "${DISK_FMT,,}" != "raw" ]]; then
+    [ -n "$DISK_FLAGS" ] && DISK_PARAM+=",$DISK_FLAGS"
+  fi
+
+  echo "$DISK_PARAM"
+  return 0
+}
+
+normalizeSize() {
+
+  local DISK_SPACE="$1"
+  local DISK_DESC="$2"
+  local DIR="$3"
+  local SPACE FREE GB DATA_SIZE
+
+  if [[ "${DISK_SPACE,,}" == "max" || "${DISK_SPACE,,}" == "half" ]]; then
+
+    local SPARE=1073741824
+    FREE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
+
+    if [[ "${DISK_SPACE,,}" == "max" ]]; then
+      FREE=$(( FREE - SPARE ))
+    else
+      FREE=$(( FREE / 2 ))
+    fi
+
+    (( FREE < SPARE )) && FREE="$SPARE"
+    GB=$(( FREE / 1073741825 ))
+    DISK_SPACE="${GB}G"
+
+  fi
+
+  SPACE="${DISK_SPACE// /}"
+  [ -z "$SPACE" ] && SPACE="256G"
+  [ -z "${SPACE//[0-9. ]}" ] && SPACE="${SPACE}G"
+  SPACE=$(echo "${SPACE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+
+  if ! numfmt --from=iec "$SPACE" &>/dev/null; then
+    error "Invalid value for ${DISK_DESC^^}_SIZE: $DISK_SPACE" && exit 73
+  fi
+
+  DATA_SIZE=$(numfmt --from=iec "$SPACE")
+
+  if (( DATA_SIZE < 6442450944 )); then
+    error "Please increase the ${DISK_DESC^^}_SIZE variable to at least 6 GB." && exit 73
+  fi
+
+  echo "$SPACE"
+  return 0
+}
+
+
+baseDir() {
+
+  local path="${1%/}"
+
+  [[ -z "$path" || "$path" == "/" ]] && {
+    echo "/"
+    return 0
+  }
+
+  path="${path#/}"
+  path="${path%%/*}"
+
+  echo "/$path"
+  return 0
+}
+createDisk() {
+
+  local DISK_FILE="$1"
+  local DISK_SPACE="$2"
+  local DISK_DESC="$3"
+  local DISK_FMT="$4"
+  local FS="$5"
+  local DATA_SIZE DIR BASE_DIR SPACE GB FA
+
+  rm -f "$DISK_FILE"
+
+  DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
+
+  if ! disabled "$ALLOCATE"; then
+
+    # Check free diskspace
+    DIR=$(dirname "$DISK_FILE")
+    BASE_DIR=$(baseDir "$DIR")
+
+    if ! SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1); then
+      error "Failed to check free space in $BASE_DIR."
+      exit 76
+    fi
+
+    if (( DATA_SIZE > SPACE )); then
+      GB=$(formatBytes "$SPACE")
+      error "Not enough free space to create a $DISK_DESC of ${DISK_SPACE/G/ GB} in $BASE_DIR, it has only $GB available..."
+      error "Please specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation by setting ALLOCATE=N." && exit 76
+    fi
+
+  fi
+
+  html "Creating a $DISK_DESC image..."
+  info "Creating a ${DISK_SPACE/G/ GB} $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/G/ GB} ($DISK_FILE)"
+
+  case "${DISK_FMT,,}" in
+    raw)
+
+      if isCow "$FS"; then
+        if ! touch "$DISK_FILE"; then
+          error "$FAIL" && exit 77
+        fi
+        { chattr +C "$DISK_FILE"; } || :
+      fi
+
+      if ! allocateRaw "$DISK_FILE" "$DATA_SIZE"; then
+        rm -f "$DISK_FILE"
+        error "$FAIL" && exit 77
+      fi
+      ;;
+    qcow2)
+
+      local DISK_PARAM
+      DISK_PARAM=$(getDiskOptions "$FS" "$DISK_FMT")
+
+      if ! qemu-img create -f "$DISK_FMT" -o "$DISK_PARAM" -- "$DISK_FILE" "$DATA_SIZE" ; then
+        rm -f "$DISK_FILE"
+        error "$FAIL" && exit 70
+      fi
+      ;;
+  esac
+
+  if isCow "$FS"; then
+    FA=$(lsattr "$DISK_FILE")
+    if [[ "$FA" != *"C"* ]]; then
+      error "Failed to disable COW for $DISK_DESC image $DISK_FILE on ${FS^^} filesystem (returned $FA)"
+    fi
+  fi
+
+  return 0
+}
+
+resizeDisk() {
+
+  local DISK_FILE="$1"
+  local DISK_SPACE="$2"
+  local DISK_DESC="$3"
+  local DISK_FMT="$4"
+  local FS="$5"
+  local CUR_SIZE DATA_SIZE DIR BASE_DIR SPACE GB
+
+  CUR_SIZE=$(getSize "$DISK_FILE") || exit 71
+  DATA_SIZE=$(numfmt --from=iec "$DISK_SPACE")
+  local REQ=$(( DATA_SIZE - CUR_SIZE ))
+  (( REQ < 1 )) && error "Shrinking disks is not supported yet, please increase ${DISK_DESC^^}_SIZE." && exit 71
+
+  if ! disabled "$ALLOCATE"; then
+
+    # Check free diskspace
+    DIR=$(dirname "$DISK_FILE")
+    BASE_DIR=$(baseDir "$DIR")
+
+    if ! SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1); then
+      error "Failed to check free space in $BASE_DIR."
+      exit 76
+    fi
+
+    if (( REQ > SPACE )); then
+      GB=$(formatBytes "$SPACE")
+      error "Not enough free space to resize $DISK_DESC to ${DISK_SPACE/G/ GB} in $BASE_DIR, it has only $GB available.."
+      error "Please specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation by setting ALLOCATE=N." && exit 74
+    fi
+
+  fi
+
+  GB=$(formatBytes "$CUR_SIZE")
+  MSG="Resizing $DISK_DESC from $GB to ${DISK_SPACE/G/ GB}..."
+  info "$MSG" && html "$MSG"
+
+  local FAIL="Could not resize the $DISK_STYLE $DISK_FMT $DISK_DESC image from ${GB} to ${DISK_SPACE/G/ GB} ($DISK_FILE)"
+
+  case "${DISK_FMT,,}" in
+    raw)
+
+      if ! allocateRaw "$DISK_FILE" "$DATA_SIZE"; then
+        error "$FAIL" && exit 75
+      fi
+      ;;
+    qcow2)
+
+      if ! qemu-img resize -f "$DISK_FMT" "--$DISK_ALLOC" "$DISK_FILE" "$DATA_SIZE" ; then
+        error "$FAIL" && exit 72
+      fi
+
+      ;;
+  esac
+
+  return 0
+}
+
+convertDisk() {
+
+  local SOURCE_FILE="$1"
+  local SOURCE_FMT="$2"
+  local DST_FILE="$3"
+  local DST_FMT="$4"
+  local DISK_BASE="$5"
+  local DISK_DESC="$6"
+  local FS="$7"
+
+  [ -f "$DST_FILE" ] && error "Conversion failed, destination file $DST_FILE already exists?" && exit 79
+  [ ! -f "$SOURCE_FILE" ] && error "Conversion failed, source file $SOURCE_FILE does not exist?" && exit 79
+
+  local TMP_FILE="$DISK_BASE.tmp"
+  rm -f "$TMP_FILE"
+
+  local DIR BASE_DIR FA
+  DIR=$(dirname "$TMP_FILE")
+  BASE_DIR=$(baseDir "$DIR")
+
+  if ! disabled "$ALLOCATE"; then
+
+    local CUR_SIZE SPACE GB
+
+    # Check free diskspace
+    CUR_SIZE=$(getSize "$SOURCE_FILE") || exit 79
+
+    if ! SPACE=$(df --output=avail -B 1 "$DIR" | tail -n 1); then
+      error "Failed to check free space in $BASE_DIR."
+      exit 76
+    fi
+
+    if (( CUR_SIZE > SPACE )); then
+      GB=$(formatBytes "$SPACE")
+      error "Not enough free space to convert $DISK_DESC to $DST_FMT in $BASE_DIR, it has only $GB available..."
+      error "Please free up some disk space or disable preallocation by setting ALLOCATE=N." && exit 76
+    fi
+
+  fi
+
+  local msg="Converting $DISK_DESC to $DST_FMT"
+  html "$msg..."
+  info "$msg, please wait until completed..."
+
+  local CONV_FLAGS="-p"
+  local DISK_PARAM
+  DISK_PARAM=$(getDiskOptions "$FS" "$DST_FMT")
+
+  if [[ "$DST_FMT" != "raw" ]]; then
+    if disabled "$ALLOCATE"; then
+      CONV_FLAGS+=" -c"
+    fi
+  fi
+
+  # 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_STYLE $DISK_DESC image to $DST_FMT format in $BASE_DIR, is there enough space available?" && exit 79
+  fi
+
+  if [[ "$DST_FMT" == "raw" ]]; then
+    if ! disabled "$ALLOCATE"; then
+
+      # Work around qemu-img bug
+      if ! CUR_SIZE=$(stat -c%s "$TMP_FILE"); then
+        error "Failed to determine converted image size: $TMP_FILE"
+        exit 79
+      fi
+
+      if ! fallocate -l "$CUR_SIZE" "$TMP_FILE" &>/dev/null; then
+        if ! fallocate -l -x "$CUR_SIZE" "$TMP_FILE"; then
+          error "Failed to allocate $CUR_SIZE bytes for $DISK_DESC image $TMP_FILE"
+        fi
+      fi
+    fi
+  fi
+
+  if ! rm -f "$SOURCE_FILE"; then
+    rm -f "$TMP_FILE"
+    error "Failed to remove old $DISK_DESC image $SOURCE_FILE."
+    exit 79
+  fi
+
+  if ! mv "$TMP_FILE" "$DST_FILE"; then
+    rm -f "$TMP_FILE"
+    error "Failed to move converted $DISK_DESC image to $DST_FILE."
+    exit 79
+  fi
+
+  if isCow "$FS"; then
+    FA=$(lsattr "$DST_FILE")
+    if [[ "$FA" != *"C"* ]]; then
+      error "Failed to disable COW for $DISK_DESC image $DST_FILE on ${FS^^} filesystem (returned $FA)"
+    fi
+  fi
+
+  msg="Conversion of $DISK_DESC"
+  html "$msg completed..."
+  info "$msg to $DST_FMT completed successfully!"
+
+  return 0
+}
+
+checkFS () {
+
+  local FS="$1"
+  local DISK_FILE="$2"
+  local DISK_DESC="$3"
+  local DIR BASE_DIR FA
+
+  DIR=$(dirname "$DISK_FILE")
+  BASE_DIR=$(baseDir "$DIR")
+  [ ! -d "$DIR" ] && return 0
+
+  if [[ "${FS,,}" == "overlay"* && "${ENGINE,,}" == "docker" ]]; then
+    warn "the filesystem of $BASE_DIR is OverlayFS, this usually means it was binded to an invalid path!"
+  fi
+
+  if [[ "${FS,,}" == "fuse"* ]]; then
+    warn "the filesystem of $BASE_DIR is FUSE, this extra layer will negatively affect performance!"
+  fi
+
+  if ! supportsDirect "$FS"; then
+    warn "the filesystem of $BASE_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")
+      if [[ "$FA" != *"C"* ]]; then
+        warn "COW (copy on write) is not disabled for $DISK_DESC image file $DISK_FILE, this is recommended on ${FS^^} filesystems!"
+      fi
+    fi
+  fi
+
+  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_SERIAL="$8"
+  local DISK_SECTORS="$9"
+  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
+    "none" ) ;;
+    "auto" )
+      echo "$result"
+      ;;
+    "usb" )
+      result+=",if=none \
+      -device usb-storage,drive=${DISK_ID}${index}${DISK_SERIAL}${DISK_SECTORS}"
+      echo "$result"
+      ;;
+    "nvme" )
+      result+=",if=none \
+      -device nvme,drive=${DISK_ID}${index},serial=deadbeaf${DISK_INDEX}${DISK_SERIAL}${DISK_SECTORS}"
+      echo "$result"
+      ;;
+    "ide" | "sata" )
+      result+=",if=none \
+      -device ich9-ahci,id=ahci${DISK_INDEX},addr=$DISK_ADDRESS \
+      -device ide-hd,drive=${DISK_ID},bus=ahci$DISK_INDEX.0,rotation_rate=$DISK_ROTATION${index}${DISK_SERIAL}${DISK_SECTORS}"
+      echo "$result"
+      ;;
+    "blk" | "virtio-blk" )
+      result+=",if=none \
+      -device virtio-blk-pci,drive=${DISK_ID},bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2${index}${DISK_SERIAL}${DISK_SECTORS}"
+      echo "$result"
+      ;;
+    "scsi" | "virtio-scsi" )
+      result+=",if=none \
+      -device virtio-scsi-pci,id=${DISK_ID}b,bus=pcie.0,addr=$DISK_ADDRESS,iothread=io2 \
+      -device scsi-hd,drive=${DISK_ID},bus=${DISK_ID}b.0,channel=0,scsi-id=0,lun=0,rotation_rate=$DISK_ROTATION${index}${DISK_SERIAL}${DISK_SECTORS}"
+      echo "$result"
+      ;;
+  esac
+
+  return 0
+}
+
+finishDisks () {
+
+  case "${DISK_TYPE,,}" in
+    "blk" | "scsi" | "virtio-blk" | "virtio-scsi" )
+      [[ "$DISK_OPTS" != *" -object iothread,id=io2"* ]] && DISK_OPTS+=" -object iothread,id=io2" ;;
+  esac
+
+  if ! enabled "$DISK_DISABLE"; then
+    html "Initialized disks successfully..."
+  fi
+
+  return 0
+}
 
 addDisk () {
 
-  local FS
+  local DISK_BASE="$1"
-  local GB
+  local DISK_TYPE="$2"
-  local DIR
+  local DISK_DESC="$3"
-  local REQ
+  local DISK_SPACE="$4"
-  local SPACE
+  local DISK_INDEX="$5"
-  local CUR_SIZE
+  local DISK_ADDRESS="$6"
-  local DATA_SIZE
+  local DISK_FMT="$7"
-  local DISK_ID=$1
+  local DISK_IO="$8"
-  local DISK_FILE=$2
+  local DISK_CACHE="$9"
-  local DISK_DESC=$3
+  local DISK_EXT DIR SPACE DATA_SIZE FS PREV_FMT PREV_EXT CUR_SIZE LEFT FREE USED
-  local DISK_SPACE=$4
-  local DISK_INDEX=$5
-  local DISK_ADDRESS=$6
 
-  DIR=$(dirname "${DISK_FILE}")
+  DISK_EXT=$(fmt2ext "$DISK_FMT")
-  [ ! -d "${DIR}" ] && return 0
+  local DISK_FILE="$DISK_BASE.$DISK_EXT"
+
+  DIR=$(dirname "$DISK_FILE")
+  [ ! -d "$DIR" ] && return 0
+
+  SPACE=$(normalizeSize "$DISK_SPACE" "$DISK_DESC" "$DIR")
+  DATA_SIZE=$(numfmt --from=iec "$SPACE")
 
   FS=$(stat -f -c %T "$DIR")
+  checkFS "$FS" "$DISK_FILE" "$DISK_DESC" || exit $?
 
-  if [[ "$FS" == "overlay"* ]]; then
+  if ! supportsDirect "$FS"; then
-    info "Warning: the filesystem of ${DIR} is OverlayFS, this usually means it was binded to an invalid path!"
+    DISK_IO="threads"
+    DISK_CACHE="writeback"
   fi
 
-  [ -z "$DISK_SPACE" ] && DISK_SPACE="16G"
+  if [ ! -s "$DISK_FILE" ] ; then
-  DISK_SPACE=$(echo "${DISK_SPACE}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
-  DATA_SIZE=$(numfmt --from=iec "${DISK_SPACE}")
 
-  if (( DATA_SIZE < 6442450944 )); then
+    if [[ "${DISK_FMT,,}" != "raw" ]]; then
-    error "Please increase ${DISK_DESC^^}_SIZE to at least 6 GB." && exit 83
+      PREV_FMT="raw"
-  fi
+    else
-
+      PREV_FMT="qcow2"
-  if [ -f "${DISK_FILE}" ]; then
-
-    CUR_SIZE=$(stat -c%s "${DISK_FILE}")
-
-    if [ "$DATA_SIZE" -gt "$CUR_SIZE" ]; then
-
-      GB=$(( (CUR_SIZE + 1073741823)/1073741824 ))
-      info "Resizing ${DISK_DESC} from ${GB}G to ${DISK_SPACE} .."
-
-      if [[ "${ALLOCATE}" == [Nn]* ]]; then
-
-        # Resize file by changing its length
-        if ! truncate -s "${DISK_SPACE}" "${DISK_FILE}"; then
-          error "Could not resize ${DISK_DESC} file (${DISK_FILE}) to ${DISK_SPACE} .." && exit 85
-        fi
-
-      else
-
-        REQ=$((DATA_SIZE-CUR_SIZE))
-
-        # Check free diskspace
-        SPACE=$(df --output=avail -B 1 "${DIR}" | tail -n 1)
-        SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-
-        if (( REQ > SPACE )); then
-          error "Not enough free space to resize ${DISK_DESC} to ${DISK_SPACE} in ${DIR}, it has only ${SPACE_GB} GB available.."
-          error "Specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation with ALLOCATE=N." && exit 84
-        fi
-
-        # Resize file by allocating more space
-        if ! fallocate -l "${DISK_SPACE}" "${DISK_FILE}"; then
-          if ! truncate -s "${DISK_SPACE}" "${DISK_FILE}"; then
-            error "Could not resize ${DISK_DESC} file (${DISK_FILE}) to ${DISK_SPACE}" && exit 85
-          fi
-        fi
-
-      fi
     fi
+
+    PREV_EXT=$(fmt2ext "$PREV_FMT")
+
+    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
 
-    if [[ "${ALLOCATE}" == [Nn]* ]]; then
+    CUR_SIZE=$(getSize "$DISK_FILE") || exit 71
 
-      # Create an empty file
+    if (( DATA_SIZE > CUR_SIZE )); then
-      if ! truncate -s "${DISK_SPACE}" "${DISK_FILE}"; then
+
-        rm -f "${DISK_FILE}"
+      resizeDisk "$DISK_FILE" "$SPACE" "$DISK_DESC" "$DISK_FMT" "$FS" || exit $?
-        error "Could not create a ${DISK_SPACE} file for ${DISK_DESC} (${DISK_FILE})" && exit 87
-      fi
 
     else
 
-      # Check free diskspace
+      if (( DATA_SIZE < CUR_SIZE )); then
-      SPACE=$(df --output=avail -B 1 "${DIR}" | tail -n 1)
-      SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
 
-      if (( DATA_SIZE > SPACE )); then
+        if [[ "${DISK_SPACE,,}" != "max" && "${DISK_SPACE,,}" != "half" ]]; then
-        error "Not enough free space to create ${DISK_DESC} of ${DISK_SPACE} in ${DIR}, it has only ${SPACE_GB} GB available.."
+          info "You decreased the ${DISK_DESC^^}_SIZE variable to ${DISK_SPACE/G/ GB} but shrinking disks is not supported, will be ignored..."
-        error "Specify a smaller ${DISK_DESC^^}_SIZE or disable preallocation with ALLOCATE=N." && exit 86
-      fi
-
-      # Create an empty file
-      if ! fallocate -l "${DISK_SPACE}" "${DISK_FILE}"; then
-        if ! truncate -s "${DISK_SPACE}" "${DISK_FILE}"; then
-          rm -f "${DISK_FILE}"
-          error "Could not create a ${DISK_SPACE} file for ${DISK_DESC} (${DISK_FILE})" && exit 87
         fi
+
+      fi
+    fi
+
+  else
+
+    createDisk "$DISK_FILE" "$SPACE" "$DISK_DESC" "$DISK_FMT" "$FS" || exit $?
+
+  fi
+
+  if [ -f "$DISK_FILE" ] && disabled "$ALLOCATE"; then
+
+    CUR_SIZE=$(getSize "$DISK_FILE") || exit 73
+    USED=$(du -sB 1 "$DISK_FILE" | cut -f1)
+    FREE=$(df --output=avail -B 1 "$DIR" | tail -n 1)
+    LEFT=$(( CUR_SIZE - USED - FREE ))
+    (( LEFT < 0 )) && LEFT=0
+
+    if (( LEFT > 0 )); then
+
+      local GB BASE_DIR
+      GB=$(formatBytes "$FREE")
+      BASE_DIR=$(baseDir "$DIR")
+      LEFT=$(formatBytes "$LEFT")
+      CUR_SIZE=$(formatBytes "$CUR_SIZE")
+      msg="The virtual size of the ${DISK_DESC,,} is $CUR_SIZE"
+
+      if [ -n "$USED" ] && [[ "$USED" != "0" ]]; then
+        USED=$(formatBytes "$USED")
+        msg+=" (of which $USED is used)"
       fi
 
+      info "$msg, but there is only $GB of free space remaining in $BASE_DIR now."
+      info "Please consider making at least $LEFT more space available in $BASE_DIR for future expansions."
+
+    fi
+
+  fi
+
+  if [ -f "$DISK_FILE" ]; then
+    if ! setOwner "$DISK_FILE"; then
+      error "Failed to set the owner for \"$DISK_FILE\" !"
+      exit 77
     fi
   fi
 
-  DISK_OPTS="${DISK_OPTS} \
+  DISK_OPTS+=$(createDevice "$DISK_FILE" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" "" "")
-    -device virtio-scsi-pci,id=hw-${DISK_ID},bus=pcie.0,addr=${DISK_ADDRESS} \
-    -drive file=${DISK_FILE},if=none,id=drive-${DISK_ID},format=raw,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
 }
 
-DISK1_FILE="${STORAGE}/data.img"
-
-if [[ ! -f "${DISK1_FILE}" ]] && [[ -f "${STORAGE}/data${DISK_SIZE}.img" ]]; then
-  # Fallback for legacy installs
-  mv "${STORAGE}/data${DISK_SIZE}.img" "${DISK1_FILE}"
-fi
-
-DISK2_FILE="/storage2/data2.img"
-
-if [ ! -f "${DISK2_FILE}" ]; then
-  # Fallback for legacy installs
-  FALLBACK="/storage2/data.img"
-  if [[ -f "${DISK1_FILE}" ]] && [[ -f "${FALLBACK}" ]]; then
-    SIZE1=$(stat -c%s "${FALLBACK}")
-    SIZE2=$(stat -c%s "${DISK1_FILE}")
-    if [[ SIZE1 -ne SIZE2 ]]; then
-      mv "${FALLBACK}" "${DISK2_FILE}"
-    fi
-  fi
-fi
-
-DISK3_FILE="/storage3/data3.img"
-
-if [ ! -f "${DISK3_FILE}" ]; then
-  # Fallback for legacy installs
-  FALLBACK="/storage3/data.img"
-  if [[ -f "${DISK1_FILE}" ]] && [[ -f "${FALLBACK}" ]]; then
-    SIZE1=$(stat -c%s "${FALLBACK}")
-    SIZE2=$(stat -c%s "${DISK1_FILE}")
-    if [[ SIZE1 -ne SIZE2 ]]; then
-      mv "${FALLBACK}" "${DISK3_FILE}"
-    fi
-  fi
-fi
-
-DISK4_FILE="/storage4/data4.img"
-DISK5_FILE="/storage5/data5.img"
-DISK6_FILE="/storage6/data6.img"
-
-: ${DISK2_SIZE:=''}
-: ${DISK3_SIZE:=''}
-: ${DISK4_SIZE:=''}
-: ${DISK5_SIZE:=''}
-: ${DISK6_SIZE:=''}
-
-addDisk "userdata" "${DISK1_FILE}" "disk" "${DISK_SIZE}" "3" "0xc"
-addDisk "userdata2" "${DISK2_FILE}" "disk2" "${DISK2_SIZE}" "4" "0xd"
-addDisk "userdata3" "${DISK3_FILE}" "disk3" "${DISK3_SIZE}" "5" "0xe"
-addDisk "userdata4" "${DISK4_FILE}" "disk4" "${DISK4_SIZE}" "9" "0x7"
-addDisk "userdata5" "${DISK5_FILE}" "disk5" "${DISK5_SIZE}" "10" "0x8"
-addDisk "userdata6" "${DISK6_FILE}" "disk6" "${DISK6_SIZE}" "11" "0x9"
-
 addDevice () {
 
-  local DISK_ID=$1
+  local DISK_DEV="$1"
-  local DISK_DEV=$2
+  local DISK_TYPE="$2"
-  local DISK_INDEX=$3
+  local DISK_INDEX="$3"
-  local DISK_ADDRESS=$4
+  local DISK_ADDRESS="$4"
 
-  [ -z "${DISK_DEV}" ] && return 0
+  [ -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
+  [ ! -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 sectors=""
-    -device virtio-scsi-pci,id=hw-${DISK_ID},bus=pcie.0,addr=${DISK_ADDRESS} \
+  local dev_type=""
-    -drive file=${DISK_DEV},if=none,id=drive-${DISK_ID},format=raw,cache=${DISK_CACHE},aio=${DISK_IO},discard=${DISK_DISCARD},detect-zeroes=on \
+  dev_type=$(lsblk -no TYPE "$DISK_DEV" 2>/dev/null | head -n1)
-    -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}"
+
+  # Only detect and apply sector sizes for partitions, not whole disks
+  # Whole disk passthrough with explicit sector sizes causes DSM not to recognize the disk
+  if [[ "$dev_type" == "part" ]]; then
+    local result=""
+    local logical=""
+    local physical=""
+
+    result=$(fdisk -l "$DISK_DEV" 2>/dev/null | grep -m 1 -o "(logical/physical): .*" | cut -c 21- || true)
+
+    if [ -n "$result" ]; then
+      logical="${result%% *}"
+      physical=$(echo "$result" | grep -m 1 -o "/ .*" | cut -c 3- || true)
+      physical="${physical%% *}"
+    fi
+
+    if [ -z "$logical" ] || [ -z "$physical" ]; then
+      warn "Failed to determine the sector size for $DISK_DEV"
+    elif [[ "$physical" != "512" ]]; then
+      sectors=",logical_block_size=$logical,physical_block_size=$physical"
+    fi
+  fi
+
+  DISK_OPTS+=$(createDevice "$DISK_DEV" "$DISK_TYPE" "$DISK_INDEX" "$DISK_ADDRESS" "raw" "$DISK_IO" "$DISK_CACHE" "" "$sectors")
 
   return 0
 }
 
-: ${DEVICE:=''}        # Docker variable to passthrough a block device, like /dev/vdc1.
+[ -z "${DISK_OPTS:-}" ] && DISK_OPTS=""
-: ${DEVICE2:=''}
+[ -z "${DISK_TYPE:-}" ] && DISK_TYPE="scsi"
-: ${DEVICE3:=''}
+[ -z "${DISK_NAME:-}" ] && DISK_NAME="data"
-: ${DEVICE4:=''}
+[ -z "${DISK_DISABLE:-}" ] && DISK_DISABLE=""
-: ${DEVICE5:=''}
-: ${DEVICE6:=''}
 
-addDevice "userdata7" "${DEVICE}" "6" "0xf"
+if ! enabled "$DISK_DISABLE"; then
-addDevice "userdata8" "${DEVICE2}" "7" "0x5"
+  msg="Initializing disks..."
-addDevice "userdata9" "${DEVICE3}" "8" "0x6"
+  html "$msg"
-addDevice "userdata4" "${DEVICE4}" "9" "0x7"
+  enabled "$DEBUG" && echo "$msg"
-addDevice "userdata5" "${DEVICE5}" "10" "0x8"
+fi
-addDevice "userdata6" "${DEVICE6}" "11" "0x9"
+
+if [[ "${DISK_IO,,}" == "native" && "${DISK_CACHE,,}" != "none" && "${DISK_CACHE,,}" != "directsync" ]]; then
+  warn "DISK_IO=native requires direct I/O caching, using DISK_IO=threads with DISK_CACHE=$DISK_CACHE."
+  DISK_IO="threads"
+fi
+
+case "${DISK_DISCARD,,}" in
+  "y" | "yes" | "true" | "1" | "on" | "unmap" )
+    DISK_DISCARD="unmap" ;;
+
+  "n" | "no" | "false" | "0" | "off" | "ignore" )
+    DISK_DISCARD="ignore" ;;
+
+  * )
+    warn "Invalid DISK_DISCARD value '$DISK_DISCARD', using 'unmap'."
+    DISK_DISCARD="unmap" ;;
+esac
+
+if [[ ! "$DISK_ROTATION" =~ ^[0-9]+$ ]]; then
+  warn "Invalid DISK_ROTATION value '$DISK_ROTATION', using 1."
+  DISK_ROTATION="1"
+fi
+
+DISK_FMT="${DISK_FMT,,}"
+
+case "$DISK_FMT" in
+  "raw" | "qcow2" ) ;;
+  * ) error "Invalid DISK_FMT specified, value \"$DISK_FMT\" is not recognized!" && exit 78 ;;
+esac
+
+case "${DISK_TYPE,,}" in
+  "ide" | "sata" | "nvme" | "usb" | "scsi" | "blk" | "virtio-blk" | "virtio-scsi" | "auto" | "none" ) ;;
+  * ) error "Invalid DISK_TYPE specified, value \"$DISK_TYPE\" is not recognized!" && exit 80 ;;
+esac
+
+if [[ "$DISK_FLAGS" =~ [[:space:]] ]]; then
+  error "Invalid DISK_FLAGS value '$DISK_FLAGS', spaces are not allowed."
+  exit 78
+fi
+
+if [ -z "$ALLOCATE" ]; then
+  ALLOCATE="N"
+fi
+
+if disabled "$ALLOCATE"; then
+  DISK_STYLE="growable"
+  DISK_ALLOC="preallocation=off"
+else
+  DISK_STYLE="preallocated"
+  DISK_ALLOC="preallocation=falloc"
+fi
+
+DISK_OPTS+=$(createDevice "$BOOT" "$DISK_TYPE" "1" "0xa" "raw" "$DISK_IO" "$DISK_CACHE" "" "")
+DISK_OPTS+=$(createDevice "$SYSTEM" "$DISK_TYPE" "2" "0xb" "raw" "$DISK_IO" "$DISK_CACHE" "" "")
+
+if enabled "$DISK_DISABLE"; then
+  finishDisks
+  return 0
+fi
+
+DISK1_FILE="$STORAGE/${DISK_NAME}"
+DISK2_FILE="/storage2/${DISK_NAME}2"
+DISK3_FILE="/storage3/${DISK_NAME}3"
+DISK4_FILE="/storage4/${DISK_NAME}4"
+
+: "${DISK2_SIZE:=""}"
+: "${DISK3_SIZE:=""}"
+: "${DISK4_SIZE:=""}"
+
+: "${DEVICE:=""}"        # Docker variables to passthrough a block device, like /dev/vdc1.
+: "${DEVICE2:=""}"
+: "${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"
+
+DISK_FILES=( "$DISK1_FILE" "$DISK2_FILE" "$DISK3_FILE" "$DISK4_FILE" )
+DISK_DESCS=( "disk" "disk2" "disk3" "disk4" )
+DISK_SIZES=( "$DISK_SIZE" "$DISK2_SIZE" "$DISK3_SIZE" "$DISK4_SIZE" )
+DISK_DEVICES=( "$DEVICE" "$DEVICE2" "$DEVICE3" "$DEVICE4" )
+DISK_INDEXES=( "3" "4" "5" "6" )
+DISK_ADDRESSES=( "0xc" "0xd" "0xe" "0xf" )
+
+for i in "${!DISK_FILES[@]}"; do
+
+  if [ -n "${DISK_DEVICES[i]}" ]; then
+    addDevice "${DISK_DEVICES[i]}" "$DISK_TYPE" "${DISK_INDEXES[i]}" "${DISK_ADDRESSES[i]}" || exit $?
+  else
+    addDisk "${DISK_FILES[i]}" "$DISK_TYPE" "${DISK_DESCS[i]}" "${DISK_SIZES[i]}" "${DISK_INDEXES[i]}" "${DISK_ADDRESSES[i]}" "$DISK_FMT" "$DISK_IO" "$DISK_CACHE" || exit $?
+  fi
+
+done
+
+finishDisks
 
 return 0

src/display.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Docker environment variables
+
+: "${GPU:="N"}"         # GPU passthrough
+: "${VGA:="virtio"}"    # VGA adaptor
+: "${DISPLAY:="none"}"  # Display type
+: "${RENDERNODE:="/dev/dri/renderD128"}"  # Render node
+
+# Sanitize variables
+VGA=$(strip "$VGA")
+DISPLAY=$(strip "$DISPLAY")
+RENDERNODE=$(strip "$RENDERNODE")
+
+CPU_VENDOR=$(lscpu | awk '/Vendor ID/{print $3}')
+
+if ! enabled "$GPU" || [[ "$CPU_VENDOR" != "GenuineIntel" || "$ARCH" != "amd64" ]]; then
+
+  [[ "${DISPLAY,,}" == "none" ]] && VGA="none"
+  DISPLAY_OPTS="-display $DISPLAY -vga $VGA"
+  return 0
+
+fi
+
+msg="Configuring display drivers..."
+html "$msg"
+enabled "$DEBUG" && echo "$msg"
+
+DISPLAY_OPTS="-display egl-headless,rendernode=$RENDERNODE"
+DISPLAY_OPTS+=" -vga $VGA"
+
+[ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
+
+# Extract the card number from the render node
+CARD_NUMBER=$(echo "$RENDERNODE" | grep -oP '(?<=renderD)\d+')
+CARD_DEVICE="/dev/dri/card$((CARD_NUMBER - 128))"
+
+if [ ! -c "$CARD_DEVICE" ]; then
+  if mknod "$CARD_DEVICE" c 226 $((CARD_NUMBER - 128)); then
+    chmod 666 "$CARD_DEVICE"
+  fi
+fi
+
+if [ ! -c "$RENDERNODE" ]; then
+  if mknod "$RENDERNODE" c 226 "$CARD_NUMBER"; then
+    chmod 666 "$RENDERNODE"
+  fi
+fi
+
+addPackage "xserver-xorg-video-intel" "Intel GPU drivers"
+addPackage "qemu-system-modules-opengl" "OpenGL module"
+
+return 0

src/entry.sh

@@ -1,33 +1,46 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-echo "❯ Starting Virtual DSM for Docker v$(</run/version)..."
+: "${PLATFORM:="x64"}"
-echo "❯ For support visit https://github.com/vdsm/virtual-dsm/"
+: "${APP:="Virtual DSM"}"
+: "${SUPPORT:="https://github.com/vdsm/virtual-dsm"}"
 
 cd /run
 
+. start.sh      # Startup hook
+. utils.sh      # Load functions
 . reset.sh      # Initialize system
+. server.sh     # Start webserver
 . install.sh    # Run installation
 . disk.sh       # Initialize disks
+. display.sh    # Initialize graphics
 . network.sh    # Initialize network
-. gpu.sh        # Initialize graphics
+. proc.sh       # Initialize processor
 . serial.sh     # Initialize serialport
 . power.sh      # Configure shutdown
+. memory.sh     # Check available memory
 . config.sh     # Configure arguments
+. finish.sh     # Finish initialization
 
 trap - ERR
 
-if [[ "${CONSOLE}" == [Yy]* ]]; then
+cmd=(qemu-system-x86_64)
-  exec qemu-system-x86_64 -pidfile "${QEMU_PID}" ${ARGS:+ $ARGS}
+version=$("${cmd[@]}" --version | awk 'NR==1 { print $4 }')
-  exit $?
+info "Booting $APP using QEMU v$version..." && echo
+
+if ! enabled "$SHUTDOWN"; then
+  exec "${cmd[@]}" ${ARGS:+ $ARGS}
 fi
 
-set -m
+if [ ! -t 1 ] || [ ! -c /dev/tty ]; then
-(
+  "${cmd[@]}" ${ARGS:+ $ARGS} &
-  [[ "${DEBUG}" == [Yy1]* ]] && info "$VERS" && set -x
+else
-  qemu-system-x86_64 ${ARGS:+ $ARGS} & echo $! > "${QEMU_PID}"
+  "${cmd[@]}" ${ARGS:+ $ARGS} </dev/tty >/dev/tty &
-  { set +x; } 2>/dev/null
+fi
-)
-set +m
 
-tail --pid "$(cat "${QEMU_PID}")" --follow /dev/null & wait $!
+rc=0
+wait $! || rc=$?
+[ -f "$QEMU_END" ] && exit "$rc"
+
+sleep 1 & wait $!
+finish "$rc"

src/finish.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+if enabled "$DEBUG"; then
+  printf "QEMU arguments:\n\n%s\n\n" "${ARGS// -/$'\n-'}"
+fi
+
+return 0

src/gpu.sh

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

src/install.sh

@@ -1,24 +1,52 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-: ${URL:=''}    # URL of the PAT file to be downloaded.
+: "${URL:=""}"    # URL of the PAT file to be downloaded.
-: ${DEV:='Y'}   # Controls whether device nodes are created.
 
-if [ -f "$STORAGE"/dsm.ver ]; then
+if [ -f "$STORAGE/dsm.ver" ]; then
-  BASE=$(cat "${STORAGE}/dsm.ver")
+  BASE=$(<"$STORAGE/dsm.ver")
+  BASE="${BASE//[![:print:]]/}"
+  [ -z "$BASE" ] && BASE="DSM_VirtualDSM_69057"
 else
   # Fallback for old installs
   BASE="DSM_VirtualDSM_42962"
 fi
 
-[ -n "$URL" ] && BASE=$(basename "$URL" .pat)
+FN="boot.pat"
+DIR=$(find / -maxdepth 1 -type d -iname "$FN" -print -quit)
+[ ! -d "$DIR" ] && DIR=$(find "$STORAGE" -maxdepth 1 -type d -iname "$FN" -print -quit)
 
-if [[ -f "$STORAGE/$BASE.boot.img" ]] && [[ -f "$STORAGE/$BASE.system.img" ]]; then
+if [ -d "$DIR" ]; then
+  BASE="DSM_VirtualDSM" && URL="file://$DIR" 
+  if [[ ! -s "$STORAGE/$BASE.boot.img" || ! -s "$STORAGE/$BASE.system.img" ]]; then
+    error "The bind $DIR maps to a file that does not exist!" && exit 65
+  fi
+fi
+
+FILE=$(find / -maxdepth 1 -type f -iname "$FN" -print -quit)
+[ ! -s "$FILE" ] && FILE=$(find "$STORAGE" -maxdepth 1 -type f -iname "$FN" -print -quit)
+[ -s "$FILE" ] && BASE="DSM_VirtualDSM" && URL="file://$FILE" 
+
+URL=$(strip "$URL")
+
+if [ -n "$URL" ] && [ ! -s "$FILE" ] && [ ! -d "$DIR" ]; then
+  BASE=$(basename "$URL" .pat)
+  if [ ! -s "$STORAGE/$BASE.system.img" ]; then
+    BASE=$(basename "${URL%%\?*}" .pat)
+    printf -v BASE '%b' "${BASE//%/\\x}"
+    BASE="${BASE//[!A-Za-z0-9._-]/_}"
+  fi
+  if [[ "${URL,,}" != "http"* && "${URL,,}" != "file:"* ]] ; then
+    [ ! -s "$STORAGE/$BASE.pat" ] && error "Invalid URL:  $URL" && exit 65
+    URL="file://$STORAGE/$BASE.pat"
+  fi
+fi
+
+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"
@@ -29,17 +57,75 @@ DL_GLOBAL="https://global.synologydownload.com/download/DSM"
 
 if [ -z "$DL" ]; then
   [ -z "$COUNTRY" ] && setCountry
+  [ -z "$COUNTRY" ] && info "Warning: could not detect country to select mirror!"
   [[ "${COUNTRY^^}" == "CN" ]] && DL="$DL_CHINA" || DL="$DL_GLOBAL"
 fi
 
 if [ -z "$URL" ]; then
-  if [ "$ARCH" == "amd64" ]; then
+  URL="$DL/release/7.2.2/72806/DSM_VirtualDSM_72806.pat"
-    URL="$DL/release/7.2.1/69057-1/DSM_VirtualDSM_69057.pat"
-  else
-    URL="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
-  fi
 fi
 
+if [ ! -s "$FILE" ]; then
+  BASE=$(basename "${URL%%\?*}" .pat)
+  printf -v BASE '%b' "${BASE//%/\\x}"
+  BASE="${BASE//[!A-Za-z0-9._-]/_}"
+fi
+
+if [[ "$URL" != "file://$STORAGE/$BASE.pat" ]]; then
+  rm -f "$STORAGE/$BASE.pat"
+fi
+
+rm -f "$STORAGE/$BASE.agent"
+rm -f "$STORAGE/$BASE.boot.img"
+rm -f "$STORAGE/$BASE.system.img"
+
+# Check filesystem
+FS=$(stat -f -c %T "$STORAGE")
+
+if [[ "${FS,,}" == "overlay"* && "${ENGINE,,}" == "docker" ]]; then
+  warn "the filesystem of $STORAGE is OverlayFS, this usually means it was binded to an invalid path!"
+fi
+
+if [[ "${FS,,}" == "fuse"* ]]; then
+  warn "the filesystem of $STORAGE is FUSE, this extra layer will negatively affect performance!"
+fi
+
+if [[ "${FS,,}" == "ecryptfs" || "${FS,,}" == "tmpfs" ]]; then
+  warn "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"
+  rm -rf "$TMP"
+  if ! makeDir "$TMP"; then
+    error "Failed to create directory \"$TMP\" !" && exit 93
+  fi
+else
+  TMP="/tmp/dsm"
+  TMP_SPACE=2147483648
+  SPACE=$(df --output=avail -B 1 /tmp | tail -n 1)
+  SPACE_MB=$(formatBytes "$SPACE")
+  if (( TMP_SPACE > SPACE )); then
+    error "Not enough free space inside the container, have $SPACE_MB available but need at least 2 GB." && exit 93
+  fi
+  rm -rf "$TMP" && mkdir -p "$TMP"
+fi
+
+# Check free diskspace
+ROOT_SPACE=536870912
+SPACE=$(df --output=avail -B 1 / | tail -n 1)
+SPACE_MB=$(formatBytes "$SPACE" "down")
+(( ROOT_SPACE > SPACE )) && error "Not enough free space inside the container, have $SPACE_MB available but need at least 500 MB." && exit 96
+
+MIN_SPACE=15032385536
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
+SPACE_GB=$(formatBytes "$SPACE")
+(( MIN_SPACE > SPACE )) && error "Not enough free space for installation in $STORAGE, have $SPACE_GB available but need at least 14 GB." && exit 94
+
 # Check if output is to interactive TTY
 if [ -t 1 ]; then
   PROGRESS="--progress=bar:noscroll"
@@ -47,148 +133,50 @@ else
   PROGRESS="--progress=dot:giga"
 fi
 
-BASE=$(basename "$URL" .pat)
+if [[ "$URL" == "file://"* ]]; then
-
+  MSG="Copying DSM"
-if [[ "$URL" != "file://${STORAGE}/${BASE}.pat" ]]; then
+  ERR="Failed to copy ${URL:7}"
-  rm -f "$STORAGE"/"$BASE".pat
+  info "Install: Copying installation image..."
-fi
-
-rm -f "$STORAGE"/"$BASE".agent
-rm -f "$STORAGE"/"$BASE".boot.img
-rm -f "$STORAGE"/"$BASE".system.img
-
-[[ "${DEBUG}" == [Yy1]* ]] && set -x
-
-# Check filesystem
-MIN_ROOT=471859200
-MIN_SPACE=6442450944
-FS=$(stat -f -c %T "$STORAGE")
-
-if [[ "$FS" == "overlay"* ]]; then
-  info "Warning: the filesystem of ${STORAGE} is OverlayFS, this usually means it was binded to an invalid path!"
-fi
-
-if [[ "$FS" != "fat"* && "$FS" != "vfat"* && "$FS" != "exfat"* && \
-        "$FS" != "ntfs"* && "$FS" != "fuse"* && "$FS" != "msdos"* ]]; then
-  TMP="$STORAGE/tmp"
 else
-  TMP="/tmp/dsm"
+  MSG="Downloading DSM"
-  SPACE=$(df --output=avail -B 1 /tmp | tail -n 1)
+  ERR="Failed to download $URL"
-  if (( MIN_SPACE > SPACE )); then
+  info "Install: Downloading $BASE.pat..."
-    TMP="$STORAGE/tmp"
-    info "Warning: the ${FS} filesystem of ${STORAGE} does not support UNIX permissions.."
-  fi
 fi
 
-rm -rf "$TMP" && mkdir -p "$TMP"
+html "$MSG..."
-
-# Check free diskspace
-SPACE=$(df --output=avail -B 1 / | tail -n 1)
-(( MIN_ROOT > SPACE )) && error "Not enough free space in container root, need at least 450 MB available." && exit 96
-
-SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
-SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-(( MIN_SPACE > SPACE )) && error "Not enough free space for installation in ${STORAGE}, have ${SPACE_GB} GB available but need at least 6 GB." && exit 95
-
-if [[ "$TMP" != "$STORAGE/tmp" ]]; then
-  SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
-  SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-  (( MIN_SPACE > SPACE )) && error "Not enough free space for installation in ${STORAGE}, have ${SPACE_GB} GB available but need at least 6 GB." && exit 94
-fi
-
-# Download the required files from the Synology website
-
-RDC="$STORAGE/dsm.rd"
-
-if [ ! -f "${RDC}" ]; then
-
-  info "Install: Downloading installer..."
-
-  RD="$TMP/rd.gz"
-  POS="65627648-71021835"
-  VERIFY="b4215a4b213ff5154db0488f92c87864"
-  LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
-
-  { curl -r "$POS" -sfk -o "$RD" "$LOC"; rc=$?; } || :
-  (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
-
-  SUM=$(md5sum "$RD" | cut -f 1 -d " ")
-
-  if [ "$SUM" != "$VERIFY" ]; then
-
-    PAT="/install.pat"
-    rm "$RD"
-    rm -f "$PAT"
-
-    { wget "$LOC" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
-    (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
-
-    tar --extract --file="$PAT" --directory="$(dirname "${RD}")"/. "$(basename "${RD}")"
-    rm "$PAT"
-
-  fi
-
-  cp "$RD" "$RDC"
-
-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
-
-  if [[ "${DEV}" == [Nn]* ]]; then
-    # Exclude dev/ from cpio extract
-    { (cd "$TMP" && cpio -it < "$TMP/rd" | grep -Ev 'dev/' | while read -r entry; do cpio -idm "$entry" < "$TMP/rd" 2>/dev/null; done); rc=$?; } || :
-  else
-    { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-  fi
-
-  (( rc != 0 )) && error "Failed to extract $RDC, reason $rc" && exit 92
-
-  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 \
-              $TMP/usr/lib/libmbedx509.so.1 \
-              $TMP/usr/lib/libmsgpackc.so.2 \
-              $TMP/usr/lib/libsodium.so \
-              $TMP/usr/lib/libsynocodesign-ng-virtual-junior-wins.so.7 \
-              $TMP/usr/syno/bin/scemd; do
-    cp "$file" /run/extract/
-  done
-
-  if [ "$ARCH" != "amd64" ]; then
-    mkdir -p /lib64/
-    cp "$TMP/usr/lib/libc.so.6" /lib64/
-    cp "$TMP/usr/lib/libpthread.so.0" /lib64/
-    cp "$TMP/usr/lib/ld-linux-x86-64.so.2" /lib64/
-  fi
-
-  mv /run/extract/scemd /run/extract/syno_extract_system_patch
-  chmod +x /run/extract/syno_extract_system_patch
-
-fi
-
-rm -rf "$TMP" && mkdir -p "$TMP"
-
-info "Install: Downloading $(basename "$URL")..."
 
 PAT="/$BASE.pat"
 rm -f "$PAT"
 
 if [[ "$URL" == "file://"* ]]; then
 
+  if [ ! -f "${URL:7}" ]; then
+    error "File '${URL:7}' does not exist!" && exit 65
+  fi
+
   cp "${URL:7}" "$PAT"
 
 else
 
-  { 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,,}" == *"_72806.pat" ]] && SIZE=361010261
+  [[ "${URL,,}" == *"_69057.pat" ]] && SIZE=363837333
+  [[ "${URL,,}" == *"_42218.pat" ]] && SIZE=379637760
+
+  /run/progress.sh "$PAT" "$SIZE" "$MSG ([P])..." &
+
+  { wget "$URL" -O "$PAT" -q --no-check-certificate --timeout=10 --no-http-keep-alive --show-progress "$PROGRESS"; rc=$?; } || :
+
+  fKill "progress.sh"
+
+  (( rc == 3 )) && error "$ERR , cannot write file (disk full?)" && exit 69
+  (( rc == 4 )) && error "$ERR , network failure!" && exit 69
+  (( rc == 8 )) && error "$ERR , server issued an error response!" && exit 69
+  (( rc != 0 )) && error "$ERR , reason: $rc" && exit 69
 
 fi
 
-[ ! -f "$PAT" ] && error "Failed to download $URL" && exit 69
+[ ! -s "$PAT" ] && error "$ERR" && exit 69
 
 SIZE=$(stat -c%s "$PAT")
 
@@ -196,123 +184,139 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
+MSG="Extracting installation image..."
+info "Install: $MSG" && html "$MSG"
+
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
-  info "Install: Extracting downloaded image..."
   tar xpf "$PAT" -C "$TMP/."
 
 else
 
-  [ "$ARCH" != "amd64" ] && addPackage "qemu-user" "QEMU"
+  { (cd "$TMP" && python3 /run/extract.py -i "$PAT" -d 2>/run/extract.log); rc=$?; } || :
 
-  info "Install: Extracting downloaded image..."
+  if (( rc != 0 )); then
-
+    cat /run/extract.log
-  export LD_LIBRARY_PATH="/run/extract"
+    error "Failed to extract PAT file, reason $rc" && exit 63
-
-  if [ "$ARCH" == "amd64" ]; then
-    { /run/extract/syno_extract_system_patch "$PAT" "$TMP/."; rc=$?; } || :
-  else
-    { qemu-x86_64 /run/extract/syno_extract_system_patch "$PAT" "$TMP/."; rc=$?; } || :
   fi
 
-  export LD_LIBRARY_PATH=""
-
-  (( rc != 0 )) && error "Failed to extract PAT file, reason $rc" && exit 63
-
 fi
 
+MSG="Preparing system partition..."
+info "Install: $MSG" && html "$MSG"
+
+BOOT=$(find "$TMP" -name "*.bin.zip" -print -quit)
+[ -z "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
+[ ! -s "$BOOT" ] && error "The PAT boot image archive is empty." && exit 67
+
+unzip -q -o "$BOOT" -d "$TMP"
+BOOT="${BOOT%.zip}"
+
+SYSTEM="$STORAGE/$BASE.system.img"
+rm -f "$SYSTEM"
+
+# Check free diskspace
+SYSTEM_SIZE=10738466816
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
+SPACE_MB=$(formatBytes "$SPACE")
+
+if (( SYSTEM_SIZE > SPACE )); then
+  error "Not enough free space in $STORAGE to create a 10 GB system disk, have only $SPACE_MB available." && exit 97
+fi
+
+if ! touch "$SYSTEM"; then
+  error "Could not create file $SYSTEM for the system disk." && exit 98
+fi
+
+! setOwner "$SYSTEM" && error "Failed to set the owner for \"$SYSTEM\" !"
+
+if [[ "${FS,,}" == "btrfs" ]]; then
+  { chattr +C "$SYSTEM"; } || :
+  FA=$(lsattr "$SYSTEM")
+  if [[ "$FA" != *"C"* ]]; then
+    error "Failed to disable COW for system image $SYSTEM on ${FS^^} filesystem."
+  fi
+fi
+
+if ! fallocate -l "$SYSTEM_SIZE" "$SYSTEM" &>/dev/null; then
+  if ! fallocate -l -x "$SYSTEM_SIZE" "$SYSTEM"; then
+    if ! truncate -s "$SYSTEM_SIZE" "$SYSTEM"; then
+      rm -f "$SYSTEM"
+      error "Could not allocate file $SYSTEM for the system disk." && exit 98
+    fi
+  fi
+fi
+
+PART="$TMP/partition.fdisk"
+
+{       echo "label: dos"
+        echo "label-id: 0x6f9ee2e9"
+        echo "device: $SYSTEM"
+        echo "unit: sectors"
+        echo "sector-size: 512"
+        echo ""
+        echo "${SYSTEM}1 : start=        2048, size=    16777216, type=83"
+        echo "${SYSTEM}2 : start=    16779264, size=     4194304, type=82"
+} > "$PART"
+
+sfdisk -q "$SYSTEM" < "$PART"
+
+MOUNT="$TMP/system"
+rm -rf "$MOUNT"
+
+if ! makeDir "$MOUNT"; then
+  error "Failed to create directory \"$MOUNT\" !" && exit 93
+fi
+
+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
-
-BOOT=$(find "$TMP" -name "*.bin.zip")
-[ ! -f "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
-
-BOOT=$(echo "$BOOT" | head -c -5)
-unzip -q -o "$BOOT".zip -d "$TMP"
-
-SYSTEM="$TMP/sys.img"
-SYSTEM_SIZE=4954537983
-
-# Check free diskspace
-SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
-SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
-(( SYSTEM_SIZE > SPACE )) && error "Not enough free space to create a 4 GB system disk, have only ${SPACE_GB} GB available." && exit 87
-
-if ! fallocate -l "${SYSTEM_SIZE}" "${SYSTEM}"; then
-  if ! truncate -s "${SYSTEM_SIZE}" "${SYSTEM}"; then
-    rm -f "${SYSTEM}" && error "Could not allocate a file for the system disk." && exit 88
-  fi
-fi
-
-# Check if file exists
-[ ! -f "${SYSTEM}" ] && error "System disk does not exist ($SYSTEM)" && exit 89
-
-# Check the filesize
-SIZE=$(stat -c%s "${SYSTEM}")
-[[ SIZE -ne SYSTEM_SIZE ]] && rm -f "${SYSTEM}" && error "System disk has the wrong size: ${SIZE}" && exit 90
-
-PART="$TMP/partition.fdisk"
-
-{       echo "label: dos"
-        echo "label-id: 0x6f9ee2e9"
-        echo "device: ${SYSTEM}"
-        echo "unit: sectors"
-        echo "sector-size: 512"
-        echo ""
-        echo "${SYSTEM}1 : start=        2048, size=     4980480, type=83"
-        echo "${SYSTEM}2 : start=     4982528, size=     4194304, type=82"
-} > "$PART"
-
-sfdisk -q "$SYSTEM" < "$PART"
-
-info "Install: Extracting system partition..."
-
-MOUNT="$TMP/system"
-rm -rf "$MOUNT" && mkdir -p "$MOUNT"
-
 mv "$HDA.tgz" "$HDA.txz"
 
-if [[ "${DEV}" == [Nn]* ]]; then
-  # Exclude dev/ from tar extract
-  tar xpfJ "$HDA.txz" --absolute-names --exclude="dev" -C "$MOUNT/"
-else
-  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/"
+INDEX_DB="$MOUNT/usr/syno/synoman/indexdb"
-[ -f "$IDB.txz" ] && tar xpfJ "$IDB.txz" --absolute-names -C "$MOUNT/usr/syno/synoman/indexdb/"
 
-info "Install: Installing system partition..."
+if [ -s "$IDB.txz" ]; then
-
+  mkdir -p "$INDEX_DB"
-LABEL="1.44.1-42218"
-OFFSET="1048576" # 2048 * 512
-NUMBLOCKS="622560" # (4980480 * 512) / 4096
-
-mke2fs -q -t ext4 -b 4096 -d "$MOUNT/" -L "$LABEL" -F -E "offset=$OFFSET" "$SYSTEM" "$NUMBLOCKS"
-
-rm -rf "$MOUNT"
-
-echo "$BASE" > "$STORAGE"/dsm.ver
-
-if [[ "$URL" == "file://${STORAGE}/${BASE}.pat" ]]; then
-  rm -f "$PAT"
-else
-  mv -f "$PAT" "$STORAGE"/"$BASE".pat
 fi
 
-mv -f "$BOOT" "$STORAGE"/"$BASE".boot.img
+LABEL="1.44.1-42218"
-mv -f "$SYSTEM" "$STORAGE"/"$BASE".system.img
+OFFSET="1048576"    # 2048 * 512
+NUMBLOCKS="2097152" # (16777216 * 512) / 4096
+MSG="Installing system partition..."
+
+fakeroot -- bash -c "set -Eeu;\
+  [ -s $HDP.txz ] && tar xpfJ $HDP.txz --absolute-names -C $MOUNT/;\
+  [ -s $IDB.txz ] && tar xpfJ $IDB.txz --absolute-names -C $INDEX_DB/;\
+  tar xpfJ $HDA.txz --absolute-names --skip-old-files -C $MOUNT/;\
+  printf '%b%s%b' '\E[1;34m❯ \E[1;36m' 'Install: $MSG' '\E[0m\n';\
+  mke2fs -q -t ext4 -b 4096 -d $MOUNT/ -L $LABEL -F -E offset=$OFFSET $SYSTEM $NUMBLOCKS"
+
+rm -rf "$MOUNT"
+echo "$BASE" > "$STORAGE/dsm.ver"
+! setOwner "$STORAGE/dsm.ver" && error "Failed to set the owner for \"$STORAGE/dsm.ver\" !"
+
+if [[ "$URL" == "file://$STORAGE/$BASE.pat" ]]; then
+  rm -f "$PAT"
+else
+  mv -f "$PAT" "$STORAGE/$BASE.pat"
+fi
+
+if [ -f "$STORAGE/$BASE.pat" ]; then
+  ! setOwner "$STORAGE/$BASE.pat" && error "Failed to set the owner for \"$STORAGE/$BASE.pat\" !"
+fi
+
+mv -f "$BOOT" "$STORAGE/$BASE.boot.img"
+! setOwner "$STORAGE/$BASE.boot.img" && error "Failed to set the owner for \"$STORAGE/$BASE.boot.img\" !"
 
 rm -rf "$TMP"
 
-{ set +x; } 2>/dev/null
-[[ "${DEBUG}" == [Yy1]* ]] && echo
-
 return 0

src/memory.sh

@@ -0,0 +1,111 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+msg="Checking memory..."
+enabled "$DEBUG" && echo "$msg"
+
+RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
+AVAIL_MEM=$(formatBytes "$RAM_AVAIL")
+
+checkConfiguredMemory() {
+
+  local wanted msg
+
+  if disabled "$RAM_CHECK" || [[ "${RAM_SIZE,,}" == "max" || "${RAM_SIZE,,}" == "half" ]]; then
+    return 0
+  fi
+
+  wanted=$(numfmt --from=iec "$RAM_SIZE")
+
+  if (( (wanted + RAM_SPARE) > RAM_AVAIL )); then
+    msg="Your configured RAM_SIZE of ${RAM_SIZE/G/ GB} is too high for the $AVAIL_MEM of free memory available,"
+    if [[ "${FS,,}" == "zfs" ]]; then
+      info "$msg but since ZFS is active this will be ignored."
+    else
+      RAM_SIZE="max"
+      warn "$msg it will automatically be adjusted to a lower amount."
+    fi
+  else
+    if (( (wanted + (RAM_SPARE * 3)) > RAM_AVAIL )); then
+      msg="your configured RAM_SIZE of ${RAM_SIZE/G/ GB} is very close to the $AVAIL_MEM of free memory available,"
+      if [[ "${FS,,}" == "zfs" ]]; then
+        info "$msg but since ZFS is active this will be ignored."
+      else
+        warn "$msg please consider a lower amount."
+      fi
+    fi
+  fi
+
+  return 0
+}
+
+configureHalfMemory() {
+
+  local wanted
+
+  if [[ "${RAM_SIZE,,}" != "half" ]]; then
+    return 0
+  fi
+
+  if (( (RAM_AVAIL / 2) > RAM_SPARE )); then
+    wanted=$(( (RAM_AVAIL / 2) / 1048577 ))
+    RAM_SIZE="${wanted}M"
+    info "Allocated $wanted MB of RAM for the virtual machine."
+  else
+    RAM_SIZE="max"
+  fi
+
+  return 0
+}
+
+configureMaxMemory() {
+
+  local wanted
+
+  if [[ "${RAM_SIZE,,}" != "max" ]]; then
+    return 0
+  fi
+
+  if (( RAM_AVAIL < (RAM_SPARE * 2) )); then
+
+    wanted=$(( RAM_AVAIL / 2 ))
+
+  else
+
+    wanted=$(( RAM_AVAIL - (RAM_SPARE * 3) ))
+
+    if (( wanted < (RAM_SPARE * 6) )); then
+      wanted=$(( RAM_AVAIL - RAM_SPARE ))
+    fi
+
+  fi
+
+  wanted=$(( wanted / 1048577 ))
+  RAM_SIZE="${wanted}M"
+
+  info "Allocated $wanted MB of RAM for the virtual machine."
+
+  return 0
+}
+
+checkMinimumMemory() {
+
+  local wanted
+
+  wanted=$(numfmt --from=iec "$RAM_SIZE")
+
+  if [ "$wanted" -lt "$RAM_MINIMUM" ]; then
+    wanted=$(( wanted / 1048577 ))
+    error "Not enough memory available, there is only $wanted MB left!"
+    exit 16
+  fi
+
+  return 0
+}
+
+checkConfiguredMemory
+configureHalfMemory
+configureMaxMemory
+checkMinimumMemory
+
+return 0

src/power.sh

@@ -1,73 +1,257 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+: "${SHUTDOWN:="Y"}"        # Graceful ACPI shutdown
+: "${TIMEOUT:="115"}"       # QEMU termination timeout
+: "${API_TIMEOUT:="90"}"    # External API call timeout
+
 # Configure QEMU for graceful shutdown
 
-QEMU_PORT=7100
+API_CMD=6
-QEMU_TIMEOUT=50
+API_HOST="127.0.0.1:$COM_PORT"
-QEMU_PID=/run/qemu.pid
-QEMU_COUNT=/run/qemu.count
 
-rm -f "${QEMU_PID}"
+# Configure QEMU for graceful shutdown
-rm -f "${QEMU_COUNT}"
 
-_trap(){
+QEMU_END="$QEMU_DIR/qemu.end"
-    func="$1" ; shift
+
-    for sig ; do
+_trap() {
-        trap "$func $sig" "$sig"
+
-    done
+  local func="$1"; shift
+  local sig
+  TRAP_PID=$BASHPID
+
+  for sig; do
+    trap "$func $sig" "$sig"
+  done
+
+  return 0
 }
 
-_graceful_shutdown() {
+signalCode() {
 
-  set +e
+  local sig="$1"
 
-  [ ! -f "${QEMU_PID}" ] && exit 130
+  case "$sig" in
-  [ -f "${QEMU_COUNT}" ] && return
+    SIGHUP)  echo 129 ;;
+    SIGINT)  echo 130 ;;
+    SIGQUIT) echo 131 ;;
+    SIGABRT) echo 134 ;;
+    SIGTERM) echo 143 ;;
+    *)       echo 0 ;;
+  esac
 
-  echo 0 > "${QEMU_COUNT}"
+  return 0
-  echo && info "Received $1 signal, shutting down..."
+}
+
+displayReason() {
+
+  local reason="$1"
+
+  case "$reason" in
+    129 ) echo "SIGHUP" ;;
+    130 ) echo "SIGINT" ;;
+    131 ) echo "SIGQUIT" ;;
+    134 ) echo "SIGABRT" ;;
+    143 ) echo "SIGTERM" ;;
+    * )   echo "$reason" ;;
+  esac
+
+  return 0
+}
+
+readQemuPid() {
+
+  local -n _pid="$1"
+
+  if [ ! -s "$QEMU_PID" ] || ! read -r _pid <"$QEMU_PID"; then
+    return 1
+  fi
+
+  return 0
+}
+
+forceKillQemu() {
+
+  local reason="$1"
+  local pid=""
+  local display
+
+  ! readQemuPid pid && return 0
+  ! isAlive "$pid" && return 0
+
+  display=$(displayReason "$reason")
+  error "Forcefully terminating $(app), reason: $display..."
+  { disown "$pid" || :; kill -9 -- "$pid" || :; } 2>/dev/null
+
+  return 0
+}
+
+cleanupHelpers() {
+
+  local pids=( "${HOST_PID:-}" "${WSD_PID:-}" \
+               "${WEB_PID:-}" "${PASST_PID:-}" "${DNSMASQ_PID:-}" )
+
+  mKill "${pids[@]}"
+  fKill "print.sh"
+
+  closeNetwork
+  return 0
+}
+
+finish() {
+
+  local reason=$1
+  touch "$QEMU_END"
+
+  forceKillQemu "$reason"
+  cleanupHelpers
+
+  if ! waitPidFile "$QEMU_PID" 10; then
+    warn "Timed out while waiting for $(app) to exit!"
+  fi
+
+  (( reason != 1 )) && echo && echo "❯ Shutdown completed!"
+
+  exit "$reason"
+}
+
+sendGuestShutdown() {
+
+  local pid="$1"
+  local response
+  local url
 
   # Don't send the powerdown signal because vDSM ignores ACPI signals
-  # echo 'system_powerdown' | nc -q 1 -w 1 localhost "${QEMU_PORT}" > /dev/null
+  # nc -q 1 -w 1 -U "$QEMU_DIR/monitor.sock" &> /dev/null <<<'system_powerdown' || :
 
   # Send shutdown command to guest agent via serial port
-  RESPONSE=$(curl -s -m 30 -S http://127.0.0.1:2210/read?command=6 2>&1)
+  API_TIMEOUT=$(strip "$API_TIMEOUT")
+  url="http://$API_HOST/read?command=$API_CMD&timeout=$API_TIMEOUT"
+  response=$(curl -sk -m "$(( API_TIMEOUT+2 ))" -S "$url" 2>&1)
 
-  if [[ ! "${RESPONSE}" =~ "\"success\"" ]]; then
+  if [[ "$response" =~ "\"success\"" ]]; then
 
-    echo && error "Failed to send shutdown command ( ${RESPONSE} )."
+    echo && info "Virtual DSM is now ready to shutdown..."
 
-    kill -15 "$(cat "${QEMU_PID}")"
+  else
-    pkill -f qemu-system-x86_64 || true
+
+    response="${response#*message\"\: \"}"
+    [ -z "$response" ] && response="second signal"
+
+    echo && error "Forcefully terminating because of: ${response%%\"*}"
+    kill -15 -- "$pid" 2>/dev/null || :
 
   fi
 
-  while [ "$(cat ${QEMU_COUNT})" -lt "${QEMU_TIMEOUT}" ]; do
+  return 0
+}
 
-    # Increase the counter
+normalizeTimeout() {
-    echo $(($(cat ${QEMU_COUNT})+1)) > ${QEMU_COUNT}
 
-    # Try to connect to qemu
+  local term_grace=3      # seconds before loop ends to send SIGTERM
-    if echo 'info version'| nc -q 1 -w 1 localhost "${QEMU_PORT}" >/dev/null 2>&1 ; then
+  local cleanup_grace=3   # seconds reserved after the loop for cleanup
+  local elapsed
+  local timeout_left
+  local min
 
-      sleep 1
+  TIMEOUT=$(strip "$TIMEOUT")
+  if [[ ! "$TIMEOUT" =~ ^[0-9]+$ ]]; then
+    TIMEOUT=115
+  fi
 
-      CNT="$(cat ${QEMU_COUNT})/${QEMU_TIMEOUT}"
+  if (( TIMEOUT >= 30 )); then
-      [[ "${DEBUG}" == [Yy1]* ]] && info "Shutting down, waiting... (${CNT})"
+    term_grace=5
+    cleanup_grace=5
+  elif (( TIMEOUT >= 15 )); then
+    term_grace=4
+    cleanup_grace=4
+  fi
 
+  elapsed=$((SECONDS - start))
+  timeout_left=$((TIMEOUT - elapsed))
+
+  min=$((term_grace + cleanup_grace + 1))
+  (( timeout_left < min )) && timeout_left=$min
+
+  wait_until=$((timeout_left - cleanup_grace))
+  sigterm_at=$((wait_until - term_grace))
+
+  return 0
+}
+
+waitForShutdown() {
+
+  local cnt=0
+  local pid="$1"
+  local name="$APP"
+  local slp
+
+  while (( cnt <= wait_until )); do
+
+    sleep 1 &
+    slp=$!
+
+    # Stop waiting if the process has exited
+    ! isAlive "$pid" && break
+
+    # Workaround for stale/zombie QEMU pid file
+    [ ! -s "$QEMU_PID" ] && break
+
+    if (( cnt == sigterm_at )); then
+      info "${name^} is still running, sending SIGTERM... ($cnt/$wait_until)"
+      kill -15 -- "$pid" 2>/dev/null || :
+    elif (( cnt > 0 )) && enabled "${DEBUG:-}"; then
+      info "Waiting for $name to shut down... ($cnt/$wait_until)"
     fi
 
+    wait "$slp"
+    (( cnt++ ))
+
   done
 
-  echo && echo "❯ Quitting..."
+  return 0
-  echo 'quit' | nc -q 1 -w 1 localhost "${QEMU_PORT}" >/dev/null 2>&1 || true
-
-  closeNetwork
-
-  return
 }
 
-_trap _graceful_shutdown SIGTERM SIGHUP SIGINT SIGABRT SIGQUIT
+graceful_shutdown() {
 
-MON_OPTS="-monitor telnet:localhost:${QEMU_PORT},server,nowait,nodelay"
+  local sig="$1"
+  local pid=""
+  local code=0
+
+  [[ $BASHPID != "$TRAP_PID" ]] && return
+
+  code=$(signalCode "$sig")
+
+  if [ -f "$QEMU_END" ]; then
+    echo && info "Received $1 signal while already shutting down..."
+    return
+  fi
+
+  set +e
+  start=$SECONDS
+  touch "$QEMU_END"
+  echo && info "Received $1 signal, sending shutdown command..."
+
+  if ! readQemuPid pid; then
+    warn "QEMU PID file ($QEMU_PID) does not exist?"
+    finish "$code"
+  fi
+
+  if ! isAlive "$pid"; then
+    warn "QEMU process with PID $pid does not exist?"
+    finish "$code"
+  fi
+
+  sendGuestShutdown "$pid"
+  normalizeTimeout
+  waitForShutdown "$pid"
+
+  finish "$code"
+}
+
+! enabled "$SHUTDOWN" && return 0
+[ -n "${QEMU_TIMEOUT:-}" ] && TIMEOUT="$QEMU_TIMEOUT"
+
+_trap graceful_shutdown SIGTERM SIGHUP SIGABRT SIGQUIT
+
+return 0

src/print.sh

@@ -1,66 +1,205 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2329
 set -Eeuo pipefail
 
-info () { echo -e >&2 "\E[1;34m❯\E[1;36m $1\E[0m" ; }
+: "${DHCP:="N"}"
-error () { echo -e >&2 "\E[1;31m❯ ERROR: $1\E[0m" ; }
+: "${NETWORK:="Y"}"
 
-file="/run/dsm.url"
+cd /run
+. utils.sh      # Load functions
 
-while [ ! -f  "$file" ]
+info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n" >&2; }
-do
+error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
 
-  sleep 3
+disabled "$NETWORK" && exit 0
-  [ -f "$file" ] && continue
 
-  # Retrieve IP from guest VM
+file="/run/shm/dsm.url"
+msgs="/run/shm/msg.html"
+driver="/run/shm/qemu.nic"
+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"
 
-  set +e
+resp_err="Guest returned an invalid response:"
-  RESPONSE=$(curl -s -m 30 -S http://127.0.0.1:2210/read?command=10 2>&1)
+curl_err="Failed to connect to guest: curl error"
-  set -e
+jq_err="Failed to parse response from guest: jq error"
 
-  if [[ ! "${RESPONSE}" =~ "\"success\"" ]] ; then
+exitIfShuttingDown() {
-    error "Failed to connect to guest: $RESPONSE" && continue
+
+  [ -f "$shutdown" ] && exit 1
+
+  return 0
+}
+
+queryGuest() {
+
+  local rc
+
+  { json=$(curl -m 20 -sk "$url"); rc=$?; } || :
+
+  exitIfShuttingDown
+
+  if (( rc != 0 )); then
+    error "$curl_err $rc"
+    return 1
   fi
 
-  # Retrieve the HTTP port number
+  return 0
-  if [[ ! "${RESPONSE}" =~ "\"http_port\"" ]] ; then
+}
-    error "Failed to parse response from guest: $RESPONSE" && continue
+
+readJsonField() {
+
+  local query="$1"
+  local result
+  local rc
+
+  { result=$(jq -r "$query" <<< "$json"); rc=$?; } || :
+
+  if (( rc != 0 )); then
+    error "$jq_err $rc ( $json )"
+    return 1
   fi
 
-  rest=${RESPONSE#*http_port}
+  if [[ "$result" == "null" ]]; then
-  rest=${rest#*:}
+    error "$resp_err $json"
-  rest=${rest%%,*}
+    return 1
-  PORT=${rest%%\"*}
-
-  [ -z "${PORT}" ] && continue
-
-  # Retrieve the IP address
-  if [[ ! "${RESPONSE}" =~ "eth0" ]] ; then
-    error "Failed to parse response from guest: $RESPONSE" && continue
   fi
 
-  rest=${RESPONSE#*eth0}
+  printf '%s\n' "$result"
-  rest=${rest#*ip}
+  return 0
-  rest=${rest#*:}
+}
-  rest=${rest#*\"}
-  IP=${rest%%\"*}
 
-  [ -z "${IP}" ] && continue
+readGuestStatus() {
 
-  echo "${IP}:${PORT}" > $file
+  local result msg rc
 
-done
+  result=$(readJsonField '.status') || return 1
 
-LOCATION=$(cat "$file")
+  if [[ "$result" != "success" ]]; then
+    { msg=$(jq -r '.message // empty' <<< "$json"); rc=$?; } || :
 
-if [[ "$LOCATION" == "20.20"* ]]; then
+    if (( rc != 0 )); then
-  MSG="port ${LOCATION##*:}"
+      error "$jq_err $rc ( $json )"
+      return 1
+    fi
+
+    error "Guest replied $result: $msg"
+    return 1
+  fi
+
+  return 0
+}
+
+readGuestPort() {
+
+  port=$(readJsonField '.data.data.dsm_setting.data.http_port') || return 1
+  [ -z "$port" ] && return 1
+
+  return 0
+}
+
+readGuestIp() {
+
+  ip=$(readJsonField '.data.data.ip.data[] | select(.name=="eth0" and has("ip")) | .ip | select(test("^[0-9]+\\."))') || return 1
+  [ -z "$ip" ] && return 1
+
+  return 0
+}
+
+writeDsmLocation() {
+
+  echo "$ip:$port" > "$file"
+
+  return 0
+}
+
+pollGuestLocation() {
+
+  while [ ! -s "$file" ]; do
+
+    # Check if not shutting down
+    exitIfShuttingDown
+
+    sleep 3
+
+    exitIfShuttingDown
+    [ -s "$file" ] && break
+
+    # Retrieve network info from guest VM
+    queryGuest || continue
+    readGuestStatus || continue
+    readGuestPort || continue
+    readGuestIp || continue
+    writeDsmLocation
+
+  done
+
+  return 0
+}
+
+writeDhcpPage() {
+
+  local title body script html
+
+  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" > "$msgs"
+
+  return 0
+}
+
+buildStaticMessage() {
+
+  local nic ip port
+
+  nic=$(<"$driver")
+  ip=$(<"$address")
+  port="${location##*:}"
+
+  if [[ "${nic,,}" != "macvlan" ]]; then
+    msg="port $port"
+  else
+    msg="http://$ip:$port"
+  fi
+
+  return 0
+}
+
+printLoginMessage() {
+
+  echo "" >&2
+  info "-----------------------------------------------------------"
+  info " You can now login to DSM at $msg"
+  info "-----------------------------------------------------------"
+  echo "" >&2
+
+  return 0
+}
+
+pollGuestLocation
+exitIfShuttingDown
+
+location=$(<"$file")
+
+if enabled "$DHCP"; then
+  writeDhcpPage
 else
-  MSG="http://${LOCATION}"
+  buildStaticMessage
 fi
 
-echo "" >&2
+printLoginMessage
-info "--------------------------------------------------------"
+
-info " You can now login to DSM at ${MSG}"
+exit 0
-info "--------------------------------------------------------"
-echo "" >&2

src/proc.sh

@@ -0,0 +1,201 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Docker environment variables
+
+: "${HOST_CPU:=""}"
+: "${CPU_FLAGS:=""}"
+: "${CPU_MODEL:=""}"
+
+HOST_CPU=$(strip "$HOST_CPU")
+CPU_FLAGS=$(strip "$CPU_FLAGS")
+CPU_MODEL=$(strip "$CPU_MODEL")
+
+selectClocksource() {
+
+  CLOCKSOURCE="tsc"
+  [[ "${ARCH,,}" == "arm64" ]] && CLOCKSOURCE="arch_sys_counter"
+  CLOCK="/sys/devices/system/clocksource/clocksource0/current_clocksource"
+
+  return 0
+}
+
+checkClocksource() {
+
+  local result
+
+  if [ ! -f "$CLOCK" ]; then
+    warn "file \"$CLOCK\" cannot be found?"
+    return 0
+  fi
+
+  result=$(<"$CLOCK")
+  result="${result//[![:print:]]/}"
+
+  case "${result,,}" in
+    "${CLOCKSOURCE,,}" ) ;;
+    "kvm-clock" ) info "Nested KVM virtualization detected.." ;;
+    "hyperv_clocksource_tsc_page" ) info "Nested Hyper-V virtualization detected.." ;;
+    "hpet" ) warn "unsupported clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'." ;;
+    *) warn "unexpected clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'." ;;
+  esac
+
+  return 0
+}
+
+checkSse42() {
+
+  if ! grep -qw "sse4_2" <<< "$flags"; then
+    error "Your CPU does not have the SSE4 instruction set that Virtual DSM requires!"
+    ! enabled "$DEBUG" && exit 88
+  fi
+
+  return 0
+}
+
+trimSpaces() {
+
+  local value="$1"
+
+  value="${value#"${value%%[![:space:]]*}"}"
+  value="${value%"${value##*[![:space:]]}"}"
+
+  echo "$value"
+  return 0
+}
+
+removeCpuArgument() {
+
+  local args=" ${ARGUMENTS:-} "
+
+  while [[ "$args" =~ [[:space:]]-cpu([[:space:]][^[:space:]]+|=[^[:space:]]+)? ]]; do
+    local cpu="${BASH_REMATCH[0]}"
+    args="${args/$cpu/ }"
+    warn "Ignoring '${cpu#" "}' from ARGUMENTS, use CPU_MODEL and CPU_FLAGS instead."
+  done
+
+  ARGUMENTS=$(trimSpaces "$args")
+
+  return 0
+}
+
+configureKvmCpuModel() {
+
+  CPU_FEATURES="kvm=on,l3-cache=on,+hypervisor"
+  KVM_OPTS=",accel=kvm -enable-kvm -global kvm-pit.lost_tick_policy=discard"
+
+  if [ -z "$CPU_MODEL" ]; then
+    CPU_MODEL="host"
+    CPU_FEATURES+=",migratable=no"
+  fi
+
+  return 0
+}
+
+appendKvmInvtscFeature() {
+
+  if grep -qw "svm" <<< "$flags"; then
+
+    # AMD processor
+    if grep -qw "tsc_scale" <<< "$flags"; then
+      CPU_FEATURES+=",+invtsc"
+    fi
+
+  else
+
+    # Intel processor
+    local vmx
+    vmx=$(sed -ne '/^vmx flags/s/^.*: //p' /proc/cpuinfo)
+
+    if grep -qw "tsc_scaling" <<< "$vmx"; then
+      CPU_FEATURES+=",+invtsc"
+    fi
+
+  fi
+
+  return 0
+}
+
+configureKvm() {
+
+  configureKvmCpuModel
+  checkSse42
+  appendKvmInvtscFeature
+
+  return 0
+}
+
+configureTcgCpuModel() {
+
+  if [ -n "$CPU_MODEL" ]; then
+    return 0
+  fi
+
+  if [[ "$ARCH" == "amd64" ]]; then
+    CPU_MODEL="max"
+    CPU_FEATURES+=",migratable=no"
+  else
+    CPU_MODEL="qemu64"
+  fi
+
+  return 0
+}
+
+configureTcg() {
+
+  KVM_OPTS=""
+  CPU_FEATURES="l3-cache=on,+hypervisor"
+
+  if [[ "$ARCH" == "amd64" ]]; then
+    KVM_OPTS=" -accel tcg,thread=multi"
+  fi
+
+  configureTcgCpuModel
+  CPU_FEATURES+=",+ssse3,+sse4.1,+sse4.2"
+
+  return 0
+}
+
+composeCpuFlags() {
+
+  CPU_FLAGS="${CPU_MODEL}${CPU_FEATURES:+,$CPU_FEATURES}${CPU_FLAGS:+,$CPU_FLAGS}"
+
+  return 0
+}
+
+configureHostCpuName() {
+
+  if [ -z "$HOST_CPU" ]; then
+    [[ "${CPU,,}" != "unknown" ]] && HOST_CPU="$CPU"
+  fi
+
+  if [ -n "$HOST_CPU" ]; then
+    HOST_CPU="${HOST_CPU%%,*},,"
+  else
+    HOST_CPU="QEMU, Virtual CPU,"
+    if [ "$ARCH" == "amd64" ]; then
+      HOST_CPU+=" X86_64"
+    else
+      HOST_CPU+=" $ARCH"
+    fi
+  fi
+
+  return 0
+}
+
+selectClocksource
+checkClocksource
+
+flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
+
+if ! disabled "$KVM"; then
+  configureKvm
+else
+  configureTcg
+fi
+
+removeCpuArgument
+composeCpuFlags
+configureHostCpuName
+
+return 0

src/progress.sh

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

src/reset.sh

@@ -1,106 +1,289 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-info () { echo -e "\E[1;34m❯ \E[1;36m$1\E[0m" ; }
+trap 'error "Status $? while: $BASH_COMMAND (line $LINENO/$BASH_LINENO)"' ERR
-error () { echo -e >&2 "\E[1;31m❯ ERROR: $1\E[0m" ; }
+enabled "${TRACE:-}" && set -o functrace && trap 'echo "# $BASH_COMMAND" >&2' DEBUG
-trap 'error "Status $? while: ${BASH_COMMAND} (line $LINENO/$BASH_LINENO)"' ERR
 
-[ ! -f "/run/entry.sh" ] && error "Script must run inside Docker container!" && exit 11
+[ ! -f "/run/entry.sh" ] && error "Script must be run inside the container!" && exit 11
 [ "$(id -u)" -ne "0" ] && error "Script must be executed with root privileges." && exit 12
 
 # Docker environment variables
 
-: ${GPU:='N'}           # Enable GPU passthrough
+: "${TZ:=""}"              # System timezone
-: ${DEBUG:='N'}         # Enable debugging mode
+: "${KVM:="Y"}"            # KVM acceleration
-: ${COUNTRY:=''}        # Country code for mirror
+: "${DEBUG:="N"}"          # Disable debugging mode
-: ${CONSOLE:='N'}       # Start in console mode
+: "${COUNTRY:=""}"         # Country code for mirror
-: ${ALLOCATE:='Y'}      # Preallocate diskspace
+: "${ALLOCATE:=""}"        # Preallocate diskspace
-: ${ARGUMENTS:=''}      # Extra QEMU parameters
+: "${ARGUMENTS:=""}"       # Extra QEMU parameters
-: ${CPU_CORES:='1'}     # Amount of CPU cores
+: "${CPU_CORES:="2"}"      # Amount of CPU cores
-: ${RAM_SIZE:='1G'}     # Maximum RAM amount
+: "${RAM_SIZE:="2G"}"      # Maximum RAM amount
-: ${DISK_SIZE:='16G'}   # Initial data disk size
+: "${RAM_CHECK:="Y"}"      # Check available RAM
+: "${DISK_SIZE:="16G"}"    # Initial data disk size
+: "${STORAGE:="/storage"}" # Storage folder location
+
+detectEngine() {
+
+  if [ -f "/run/.containerenv" ]; then
+    ENGINE="${container:-}"
+    if [[ "${ENGINE,,}" == *"podman"* ]]; then
+      ROOTLESS="Y"
+      ENGINE="Podman"
+    else
+      [ -z "$ENGINE" ] && ENGINE="Kubernetes"
+    fi
+  fi
+
+  return 0
+}
+
+checkPrivileged() {
+
+  local cap_bnd
+  local last_cap
+  local max_cap
+
+  # Get the capability bounding set
+  cap_bnd=$(grep '^CapBnd:' /proc/$$/status | awk '{print $2}')
+  cap_bnd=$(printf "%d" "0x${cap_bnd}")
+
+  # Get the last capability number
+  last_cap=$(cat /proc/sys/kernel/cap_last_cap)
+
+  # Calculate the maximum capability value
+  max_cap=$(((1 << (last_cap + 1)) - 1))
+
+  if [ "$cap_bnd" -eq "$max_cap" ]; then
+    ROOTLESS="N"
+    PRIVILEGED="Y"
+  fi
+
+  return 0
+}
+
+normalizeCpuCores() {
+
+  CPU_CORES=$(strip "$CPU_CORES")
+  [ -z "$CPU_CORES" ] && CPU_CORES=2
+  [[ "${CPU_CORES,,}" == "max" ]] && CPU_CORES="$CORES"
+  [[ "${CPU_CORES,,}" == "half" ]] && CPU_CORES=$(( CORES / 2 ))
+  [ -z "${CPU_CORES##*[!0-9]*}" ] && error "Invalid amount of CPU_CORES: $CPU_CORES" && exit 15
+
+  [ "$CPU_CORES" -lt "1" ] && CPU_CORES=1
+  if [ "$CPU_CORES" -gt "$CORES" ]; then
+    warn "The amount for CPU_CORES (${CPU_CORES}) exceeds the amount of logical cores available (${CORES}) and will be limited."
+    CPU_CORES="$CORES"
+  fi
+
+  return 0
+}
+
+checkStorage() {
+
+  # Check system
+
+  QEMU_DIR="/run/shm"
+
+  if [ ! -d "/dev/shm" ]; then
+    error "Directory /dev/shm not found!" && exit 14
+  else
+    [ ! -d "$QEMU_DIR" ] && ln -s /dev/shm "$QEMU_DIR"
+  fi
+
+  QEMU_PID="$QEMU_DIR/qemu.pid"
+
+  # Check folder
+
+  if [[ "${STORAGE,,}" != "/storage" ]]; then
+    mkdir -p "$STORAGE"
+  fi
+
+  if [ ! -d "$STORAGE" ]; then
+    error "Storage folder ($STORAGE) not found!" && exit 13
+  fi
+
+  if [ ! -w "$STORAGE" ]; then
+    msg="Storage folder ($STORAGE) is not writeable!"
+    msg+=" If SELinux is active, you need to add the \":Z\" flag to the bind mount."
+    error "$msg" && exit 13
+  fi
+
+  return 0
+}
+
+checkFilesystem() {
+
+  # Check filesystem
+  FS=$(stat -f -c %T "$STORAGE")
+
+  if [[ "${FS,,}" == "ecryptfs" || "${FS,,}" == "tmpfs" ]]; then
+    DISK_IO="threads"
+    DISK_CACHE="writeback"
+  fi
+
+  return 0
+}
+
+normalizeRamSize() {
+
+  # Read memory
+  RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
+  RAM_TOTAL=$(free -b | grep -m 1 Mem: | awk '{print $2}')
+
+  RAM_SPARE=500000000
+  RAM_MINIMUM=136314880
+
+  RAM_SIZE=$(strip "$RAM_SIZE")
+  RAM_SIZE="${RAM_SIZE// /}"
+  [ -z "$RAM_SIZE" ] && RAM_SIZE="2G"
+
+  if [[ "${RAM_SIZE,,}" != "max" && "${RAM_SIZE,,}" != "half" ]]; then
+
+    if [ -z "${RAM_SIZE//[0-9. ]}" ]; then
+      [ "${RAM_SIZE%%.*}" -lt "130" ] && RAM_SIZE="${RAM_SIZE}G" || RAM_SIZE="${RAM_SIZE}M"
+    fi
+
+    RAM_SIZE=$(echo "${RAM_SIZE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+    ! numfmt --from=iec "$RAM_SIZE" &>/dev/null && error "Invalid RAM_SIZE: $RAM_SIZE" && exit 16
+    wanted=$(numfmt --from=iec "$RAM_SIZE")
+    [ "$wanted" -lt "$RAM_MINIMUM" ] && error "RAM_SIZE is too low: $RAM_SIZE" && exit 16
+
+  fi
+
+  return 0
+}
+
+checkKvm() {
+
+  # Check KVM support
+
+  if [[ "${PLATFORM,,}" == "x64" ]]; then
+    TARGET="amd64"
+  else
+    TARGET="arm64"
+  fi
+
+  if disabled "$KVM"; then
+    warn "KVM acceleration is disabled, this will cause the machine to run about 10 times slower!"
+  else
+    if [[ "${ARCH,,}" != "$TARGET" ]]; then
+      KVM="N"
+      warn "your CPU architecture is ${ARCH^^} and cannot provide KVM acceleration for ${PLATFORM^^} instructions, so the machine will run about 10 times slower."
+    fi
+  fi
+
+  if ! disabled "$KVM"; then
+
+    KVM_ERR=""
+
+    if [ ! -e /dev/kvm ]; then
+      KVM_ERR="(/dev/kvm is missing)"
+    else
+      if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
+        KVM_ERR="(/dev/kvm is unwriteable)"
+      else
+        if [[ "${PLATFORM,,}" == "x64" ]]; then
+          flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
+          if ! grep -qw "vmx\|svm" <<< "$flags"; then
+            KVM_ERR="(not enabled in BIOS)"
+          fi
+          if ! grep -qw "sse4_2" <<< "$flags"; then
+            error "Your CPU does not have the SSE4 instruction set that Virtual DSM requires!"
+            ! enabled "$DEBUG" && exit 88
+          fi
+        fi
+      fi
+    fi
+
+    if [ -n "$KVM_ERR" ]; then
+      KVM="N"
+      if [[ "$OSTYPE" =~ ^darwin ]]; then
+        warn "you are using macOS which has no KVM support, so the machine will run about 10 times slower."
+      else
+        kernel=$(uname -a)
+        case "${kernel,,}" in
+          *"microsoft"* )
+            error "Please bind '/dev/kvm' as a volume in the optional container settings when using Docker Desktop." ;;
+          *"synology"* )
+            error "Please make sure that Synology VMM (Virtual Machine Manager) is installed and that '/dev/kvm' is binded to this container." ;;
+          *)
+            error "KVM acceleration is not available $KVM_ERR, this will cause the machine to run about 10 times slower."
+            error "See the FAQ for possible causes, or disable acceleration by adding the \"KVM=N\" variable (not recommended)." ;;
+        esac
+        ! enabled "$DEBUG" && exit 88
+      fi
+    fi
+
+  fi
+
+  return 0
+}
+
+# Sanitize variables
+TZ=$(strip "$TZ")
+STORAGE=$(strip "$STORAGE")
+COUNTRY=$(strip "$COUNTRY")
+DISK_SIZE=$(strip "$DISK_SIZE")
 
 # Helper variables
+ROOTLESS="N"
+PRIVILEGED="N"
+ENGINE="Docker"
+PROCESS="${APP,,}"
+PROCESS="${PROCESS// /-}"
 
-KERNEL=$(uname -r | cut -b 1)
+detectEngine
-MINOR=$(uname -r | cut -d '.' -f2)
+
+echo "❯ Starting $APP for $ENGINE v$(</etc/version)..."
+echo "❯ For support visit $SUPPORT"
+
+checkPrivileged
+
+INFO="/run/shm/msg.html"
+PAGE="/run/shm/index.html"
+TEMPLATE="/var/www/index.html"
+FOOTER1="$APP for $ENGINE v$(</etc/version)"
+FOOTER2="<a href='$SUPPORT'>$SUPPORT</a>"
+
+SOCKETS=1
+CPU=$(cpu)
+SYS=$(uname -r)
+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)
+CORES=$(grep -c '^processor' /proc/cpuinfo)
 
-# Check folder
+if grep -qi "socket(s)" <<< "$(lscpu)"; then
+  SOCKETS=$(lscpu | grep -m 1 -i 'socket(s)' | awk '{print $2}')
+  [ -z "${SOCKETS##*[!0-9]*}" ] && SOCKETS=1
+  [ "$SOCKETS" -lt "1" ] && SOCKETS=1
+fi
 
-STORAGE="/storage"
+normalizeCpuCores
-[ ! -d "$STORAGE" ] && error "Storage folder (${STORAGE}) not found!" && exit 13
+checkStorage
+checkFilesystem
+normalizeRamSize
+
+# Print system info
+SYS="${SYS/-generic/}"
+FS="${FS/UNKNOWN //}"
+FS="${FS/ext2\/ext3/ext4}"
+FS=$(echo "$FS" | sed 's/[)(]//g')
+SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
+SPACE_GB=$(formatBytes "$SPACE" "down")
+AVAIL_MEM=$(formatBytes "$RAM_AVAIL" "down")
+TOTAL_MEM=$(formatBytes "$RAM_TOTAL" "up")
+
+echo "❯ CPU: ${CPU} | RAM: ${AVAIL_MEM/ GB/}/$TOTAL_MEM | DISK: $SPACE_GB (${FS}) | KERNEL: ${SYS}..."
+echo
+
+checkKvm
 
 # Cleanup files
-
+rm -f "$QEMU_DIR"/dsm.url
-rm -f /run/dsm.url
+rm -f "$QEMU_DIR"/qemu.* "$QEMU_DIR"/*.pid "$QEMU_DIR"/*.sock
-rm -f /run/qemu.pid
-rm -f /run/qemu.count
 
 # Cleanup dirs
-
 rm -rf /tmp/dsm
 rm -rf "$STORAGE/tmp"
 
-# Helper functions
-
-getCountry () {
-
-  local rc
-  local json
-  local result
-  local url=$1
-  local query=$2
-
-  { json=$(curl -m 5 -H "Accept: application/json" -sfk "$url"); rc=$?; } || :
-  (( rc != 0 )) && return 0
-
-  { result=$(echo "$json" | jq -r "$query" 2> /dev/null); rc=$?; } || :
-  (( rc != 0 )) && return 0
-
-  [[ ${#result} -ne 2 ]] && return 0
-  [[ "${result^^}" == "XX" ]] && return 0
-
-  COUNTRY="${result^^}"
-
-  return 0
-}
-
-setCountry () {
-
-  [ -z "$COUNTRY" ] && getCountry "https://api.ipapi.is" ".location.country_code"
-  [ -z "$COUNTRY" ] && getCountry "https://ifconfig.co/json" ".country_iso"
-  [ -z "$COUNTRY" ] && getCountry "https://ipinfo.io/json" ".country"
-  [ -z "$COUNTRY" ] && getCountry "https://api.myip.com" ".cc"
-
-  return 0
-}
-
-addPackage () {
-
-  local pkg=$1
-  local desc=$2
-
-  if apt-mark showinstall | grep -qx "$pkg"; then
-    return 0
-  fi
-
-  info "Installing $desc..."
-
-  export DEBCONF_NOWARNINGS="yes"
-  export DEBIAN_FRONTEND="noninteractive"
-
-  [ -z "$COUNTRY" ] && setCountry
-
-  if [[ "${COUNTRY^^}" == "CN" ]]; then
-    sed -i 's/deb.debian.org/mirrors.ustc.edu.cn/g' /etc/apt/sources.list.d/debian.sources
-  fi
-
-  apt-get -qq update
-  apt-get -qq --no-install-recommends -y install "$pkg" > /dev/null
-
-  return 0
-}
-
 return 0

src/serial.sh

@@ -1,72 +1,109 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -Eeuo pipefail
 
 # Docker environment variables
 
-: ${HOST_CPU:=''}
+: "${HOST_MAC:=""}"
-: ${HOST_MAC:=''}
+: "${HOST_DEBUG:=""}"
-: ${HOST_DEBUG:=''}
+: "${HOST_MODEL:=""}"
-: ${HOST_SERIAL:=''}
+: "${HOST_SERIAL:=""}"
-: ${HOST_MODEL:=''}
+: "${GUEST_SERIAL:=""}"
-: ${GUEST_SERIAL:=''}
 
-if [ -z "$HOST_CPU" ]; then
+# Sanitize variables
-  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_MAC=$(strip "$HOST_MAC")
-fi
+HOST_MODEL=$(strip "$HOST_MODEL")
+HOST_SERIAL=$(strip "$HOST_SERIAL")
+GUEST_SERIAL=$(strip "$GUEST_SERIAL")
 
-if [ -n "$HOST_CPU" ]; then
+validateHostMac() {
-  HOST_CPU="$HOST_CPU,,"
+  local m
-else
+
-  if [ "$ARCH" == "amd64" ]; then
+  if [ -z "$HOST_MAC" ]; then
-    HOST_CPU="QEMU, Virtual CPU, X86_64"
+    return 0
-  else
-    HOST_CPU="QEMU, Virtual CPU, $ARCH"
   fi
-fi
 
-HOST_ARGS=()
+  HOST_MAC="${HOST_MAC//-/:}"
-HOST_ARGS+=("-cpu=${CPU_CORES}")
-HOST_ARGS+=("-cpu_arch=${HOST_CPU}")
 
-[ -n "$HOST_MAC" ] && HOST_ARGS+=("-mac=${HOST_MAC}")
+  if [[ ${#HOST_MAC} == 12 ]]; then
-[ -n "$HOST_MODEL" ] && HOST_ARGS+=("-model=${HOST_MODEL}")
+    m="$HOST_MAC"
-[ -n "$HOST_SERIAL" ] && HOST_ARGS+=("-hostsn=${HOST_SERIAL}")
+    HOST_MAC="${m:0:2}:${m:2:2}:${m:4:2}:${m:6:2}:${m:8:2}:${m:10:2}"
-[ -n "$GUEST_SERIAL" ] && HOST_ARGS+=("-guestsn=${GUEST_SERIAL}")
+  fi
 
-if [[ "${HOST_DEBUG}" == [Yy1]* ]]; then
+  if [[ ${#HOST_MAC} != 17 ]]; then
-  set -x
+    error "Invalid HOST_MAC address: '$HOST_MAC', should be 12 or 17 digits long!" && exit 28
-  ./host.bin "${HOST_ARGS[@]}" &
+  fi
-  { set +x; } 2>/dev/null
-  echo
-else
-  ./host.bin "${HOST_ARGS[@]}" >/dev/null &
-fi
 
-cnt=0
+  return 0
-sleep 0.2
+}
 
-while ! nc -z -w2 127.0.0.1 2210 > /dev/null 2>&1; do
+buildHostArguments() {
-  sleep 0.1
-  cnt=$((cnt + 1))
-  (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit 58
-done
 
-cnt=0
+  HOST_ARGS=()
+  HOST_ARGS+=("-cpu=$CPU_CORES")
+  HOST_ARGS+=("-cpu_arch=$HOST_CPU")
 
-while ! nc -z -w2 127.0.0.1 12345 > /dev/null 2>&1; do
+  [ -n "$HOST_MAC" ] && HOST_ARGS+=("-mac=$HOST_MAC")
-  sleep 0.1
+  [ -n "$HOST_MODEL" ] && HOST_ARGS+=("-model=$HOST_MODEL")
-  cnt=$((cnt + 1))
+  [ -n "$HOST_SERIAL" ] && HOST_ARGS+=("-hostsn=$HOST_SERIAL")
-  (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit 59
+  [ -n "$GUEST_SERIAL" ] && HOST_ARGS+=("-guestsn=$GUEST_SERIAL")
-done
 
-# Configure serial ports
+  return 0
+}
 
-SERIAL_OPTS="\
+startHostBinary() {
-        -serial mon:stdio \
+
+  if enabled "$HOST_DEBUG"; then
+    set -x
+    ./host.bin "${HOST_ARGS[@]}" &
+    { set +x; } 2>/dev/null
+    echo "$!" > "$HOST_PID"
+    echo
+  else
+    ./host.bin "${HOST_ARGS[@]}" >/dev/null &
+    echo "$!" > "$HOST_PID"
+  fi
+
+  return 0
+}
+
+waitForPort() {
+
+  local port="$1"
+  local exit_code="$2"
+  local cnt=0
+
+  while ! nc -z -w2 127.0.0.1 "$port" > /dev/null 2>&1; do
+    sleep 0.1
+    cnt=$((cnt + 1))
+    (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit "$exit_code"
+  done
+
+  return 0
+}
+
+configureSerialPorts() {
+
+  # Configure serial ports
+  SERIAL_OPTS="-serial mon:stdio \
         -device virtio-serial-pci,id=virtio-serial0,bus=pcie.0,addr=0x3 \
-        -chardev pty,id=charserial0 \
+        -chardev socket,id=charchannel0,host=127.0.0.1,port=$CHR_PORT,reconnect=10 \
-        -device isa-serial,chardev=charserial0,id=serial0 \
-        -chardev socket,id=charchannel0,host=127.0.0.1,port=12345,reconnect=10 \
         -device virtserialport,bus=virtio-serial0.0,nr=1,chardev=charchannel0,id=channel0,name=vchannel"
 
+  return 0
+}
+
+validateHostMac
+
+HOST_PID="$QEMU_DIR/host.pid"
+
+buildHostArguments
+startHostBinary
+
+sleep 0.2
+
+waitForPort "$COM_PORT" 58
+waitForPort "$CHR_PORT" 59
+
+configureSerialPorts
+
 return 0

src/server.sh

@@ -1,66 +1,76 @@
 #!/usr/bin/env bash
-set -eu
+set -Eeuo pipefail
 
-TMP_FILE=$(mktemp -q /tmp/server.XXXXXX)
+: "${COM_PORT:="2210"}"    # Comm port
+: "${WEB_PORT:="5000"}"    # Webserver port
+: "${CHR_PORT:="12345"}"   # Character port
+: "${WSD_PORT:="8004"}"    # Websockets port
 
-stop() {
+# Sanitize port variables
-  trap - SIGINT EXIT
+COM_PORT=$(strip "$COM_PORT")
-  { pkill -f socat || true; } 2>/dev/null
+WEB_PORT=$(strip "$WEB_PORT")
-  [ -f "$TMP_FILE" ] && rm -f "$TMP_FILE"
+CHR_PORT=$(strip "$CHR_PORT")
+WSD_PORT=$(strip "$WSD_PORT")
+
+WEB_PID="/run/nginx.pid"
+WSD_PID="$QEMU_DIR/websocketd.pid"
+
+prepareWebFiles() {
+  cp -r /var/www/* "$QEMU_DIR"
+  rm -f "$WSD_PID" "$WEB_PID"
+
+  return 0
 }
 
-trap 'stop' EXIT SIGINT SIGTERM SIGHUP
+configureWebPorts() {
+  sed -i "s/listen 5000 default_server;/listen $WEB_PORT default_server;/g" /etc/nginx/sites-enabled/web.conf
+  sed -i "s/proxy_pass http:\/\/127.0.0.1:8004\/;/proxy_pass http:\/\/127.0.0.1:$WSD_PORT\/;/g" /etc/nginx/sites-enabled/web.conf
 
-html()
+  return 0
-{
-    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
+configureIpv6Listen() {
 
-  BODY="$2"
+  # shellcheck disable=SC2143
-
+  if [ -f /proc/net/if_inet6 ] && [[ "$(cat /proc/sys/net/ipv6/conf/all/disable_ipv6 2>/dev/null)" != "1" ]] && [ -n "$(ifconfig -a | grep inet6)" ]; then
-  if [[ "$BODY" == "install" ]]; then
+    sed -i "s/listen $WEB_PORT default_server;/listen [::]:$WEB_PORT default_server ipv6only=off;/g" /etc/nginx/sites-enabled/web.conf
-    BODY="Please wait while Virtual DSM is being installed..."
-    BODY="$BODY<script>setTimeout(() => { document.location.reload(); }, 9999);</script>"
   fi
 
-  HTML=$(html "$BODY")
+  return 0
-  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 &
+configureWebServer() {
-  socat TCP4-LISTEN:"${1:-5000}",reuseaddr,fork,crlf SYSTEM:"cat ${TMP_FILE}" 2> /dev/null & wait $!
 
-  exit
+  mkdir -p /etc/nginx/sites-enabled
+  cp /etc/nginx/default.conf /etc/nginx/sites-enabled/web.conf
 
+  configureWebPorts
+  configureIpv6Listen
+
+  return 0
+}
+
+startWebServer() {
+
+  # Start webserver
+  nginx -e stderr
+}
+
+startWebsocketServer() {
+
+  # Start websocket server
+  websocketd --address 127.0.0.1 --port="$WSD_PORT" /run/socket.sh >/var/log/websocketd.log &
+  echo "$!" > "$WSD_PID"
+}
+
+prepareWebFiles
+
+html "Starting $APP for $ENGINE..."
+
+if ! disabled "${WEB:-}"; then
+  configureWebServer
+  startWebServer
+  startWebsocketServer
 fi
 
-if [[ "$2" != "/run/ip.sh" ]]; then
+return 0
-
-  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 $!

src/socket.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+lastmsg=""
+path="/run/shm/msg.html"
+
+refresh() {
+
+  [ ! -f "$path" ] && return 0
+  [ ! -s "$path" ] && return 0
+
+  msg=$(< "$path") || return 0
+  msg="${msg%$'\n'}"
+
+  [ -z "$msg" ] && return 0
+  [[ "$msg" == "$lastmsg" ]] && return 0
+
+  lastmsg="$msg"
+  echo "s: $msg"
+  return 0
+}
+
+refresh
+
+inotifywait -m "$path" |
+  while read -r fp event fn; do
+    case "${event,,}" in
+      "modify"* ) refresh ;;
+      "delete_self" ) echo "c: vnc" ;;
+    esac    
+  done

src/start.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# You can override this hook to execute a script before startup!
+
+return 0

src/utils.sh

@@ -0,0 +1,370 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Helper functions
+
+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; }
+warn () { printf "%b%s%b" "\E[1;31m❯ " "Warning: ${1:-}" "\E[0m\n" >&2; }
+
+strip() {
+  local value="${1:-}"
+
+  # Remove surrounding whitespace
+  value="${value#"${value%%[![:space:]]*}"}"
+  value="${value%"${value##*[![:space:]]}"}"
+
+  # Remove leading/trailing single/double quotes
+  value="${value%\"}"
+  value="${value#\"}"
+  value="${value%\'}"
+  value="${value#\'}"
+
+  # Remove surrounding whitespace again
+  value="${value#"${value%%[![:space:]]*}"}"
+  value="${value%"${value##*[![:space:]]}"}"
+
+  printf '%s' "$value"
+}
+
+enabled() {
+  case "$(strip "${1:-}")" in
+    Y|y|YES|Yes|yes|TRUE|True|true|1|ON|On|on) return 0 ;;
+    *) return 1 ;;
+  esac
+}
+
+disabled() {
+  case "$(strip "${1:-}")" in
+    N|n|NO|No|no|FALSE|False|false|0|OFF|Off|off) return 0 ;;
+    *) return 1 ;;
+  esac
+}
+
+formatBytes() {
+  local result
+  result=$(numfmt --to=iec --suffix=B "$1" | sed -r 's/([A-Z])/ \1/' | sed 's/ B/ bytes/g;')
+  local unit="${result//[0-9. ]}"
+  result="${result//[a-zA-Z ]/}"
+  if [[ "${2:-}" == "up" ]]; then
+    if [[ "$result" == *"."* ]]; then
+      result="${result%%.*}"
+      result=$((result+1))
+    fi
+  else
+    if [[ "${2:-}" == "down" ]]; then
+      result="${result%%.*}"
+    fi
+  fi
+  echo "$result $unit"
+  return 0
+}
+
+isAlive() {
+  local pid="$1"
+  [ -z "$pid" ] && return 1
+
+  if kill -0 "$pid" 2>/dev/null; then
+    return 0
+  fi
+
+  return 1
+}
+
+waitPid() {
+  local i=0
+  local pid="$1"
+  local timeout="${2:-10}"
+
+  while [ -n "$pid" ] && isAlive "$pid"; do
+    sleep 0.2
+    i=$((i + 1))
+    (( i >= timeout * 5 )) && return 1
+  done
+
+  return 0
+}
+
+waitPidFile() {
+  local i=0
+  local pid=""
+  local file="$1"
+  local timeout="${2:-10}"
+
+  [ ! -s "$file" ] && return 0
+  ! read -r pid <"$file" && return 0
+  [ -z "$pid" ] && return 0
+
+  while [ -s "$file" ] && isAlive "$pid"; do
+    sleep 0.2
+    i=$((i + 1))
+    (( i >= timeout * 5 )) && return 1
+  done
+
+  rm -f -- "$file"
+  return 0
+}
+
+pKill() {
+  local pid="$1"
+  local timeout="${2:-10}"
+
+  { kill -15 -- "$pid" || :; } 2>/dev/null
+
+  if ! waitPid "$pid" "$timeout"; then
+    warn "Timed out while waiting for PID $pid"
+  fi
+
+  return 0
+}
+
+fWait() {
+  local i=0
+  local name="$1"
+  local timeout="${2:-10}"
+
+  [ -z "$name" ] && return 0
+
+  while pgrep -f -l "$name" >/dev/null; do
+    sleep 0.2
+    i=$((i + 1))
+    if (( i >= timeout * 5 )); then
+      warn "Timed out while waiting for process: $name"
+      break
+    fi
+  done
+
+  return 0
+}
+
+fKill() {
+  local name="$1"
+  local timeout="${2:-10}"
+
+  [ -z "$name" ] && return 0
+
+  { pkill -f "$name" || :; } 2>/dev/null
+  fWait "$name" "$timeout"
+
+  return 0
+}
+
+sKill() {
+  local pid=""
+  local file="$1"
+
+  [ ! -s "$file" ] && return 0
+  ! read -r pid <"$file" && return 0
+  [ -z "$pid" ] && return 0
+
+  if isAlive "$pid"; then
+    { kill -15 -- "$pid" || :; } 2>/dev/null
+  fi
+
+  return 0
+}
+
+mKill() {
+  local timeout=10
+  local files=("$@")
+
+  for file in "${files[@]}"; do
+    sKill "$file"
+  done
+
+  for file in "${files[@]}"; do
+    if ! waitPidFile "$file" "$timeout"; then
+      warn "Timed out while waiting for PID file: $file"
+    fi
+  done
+
+  return 0
+}
+
+setOwner() {
+  local file="$1"
+  local dir uid gid
+
+  [ ! -f "$file" ] && return 1
+
+  dir=$(dirname -- "$file")
+  uid=$(stat -c '%u' "$dir") || return 1
+  gid=$(stat -c '%g' "$dir") || return 1
+
+  ! chown "$uid:$gid" "$file" && return 1
+
+  return 0
+}
+
+makeDir() {
+  local path="$1"
+  local dir uid gid
+
+  [ -d "$path" ] && return 0
+  ! mkdir -p "$path" && return 1
+
+  dir=$(dirname -- "$path")
+  uid=$(stat -c '%u' "$dir") || return 1
+  gid=$(stat -c '%g' "$dir") || return 1
+
+  ! chown "$uid:$gid" "$path" && return 1
+
+  return 0
+}
+
+escape () {
+  local s
+  s=${1//&/\&amp;}
+  s=${s//</\&lt;}
+  s=${s//>/\&gt;}
+  s=${s//'"'/\&quot;}
+  printf -- %s "$s"
+  return 0
+}
+
+html() {
+  local title
+  local body
+  local script
+  local footer
+
+  title=$(escape "$APP")
+  title="<title>$title</title>"
+  footer=$(escape "$FOOTER1")
+
+  body=$(escape "$1")
+  if [[ "$body" == *"..." ]]; then
+    body="<p class=\"loading\">${body/.../}</p>"
+  fi
+
+  [ -n "${2:-}" ] && script="$2" || script=""
+
+  local HTML
+  HTML=$(<"$TEMPLATE")
+  HTML="${HTML/\[1\]/$title}"
+  HTML="${HTML/\[2\]/$script}"
+  HTML="${HTML/\[3\]/$body}"
+  HTML="${HTML/\[4\]/$footer}"
+  HTML="${HTML/\[5\]/$FOOTER2}"
+
+  echo "$HTML" > "$PAGE" || return 1
+  echo "$body" > "$INFO" || return 1
+
+  return 0
+}
+
+cpu() {
+  local ret
+  local cpu=""
+
+  ret=$(lscpu)
+
+  if grep -qi "model name" <<< "$ret"; then
+    cpu=$(echo "$ret" | 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')
+  fi
+
+  if [ -z "${cpu// /}" ] && grep -qi "model:" <<< "$ret"; then
+    cpu=$(echo "$ret" | grep -m 1 -i 'model:' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+  fi
+
+  cpu="${cpu// CPU/}"
+  cpu="${cpu// [0-9][0-9][0-9] Core}"
+  cpu="${cpu// [0-9][0-9] Core}"
+  cpu="${cpu// [0-9] Core}"
+  cpu="${cpu//[0-9][0-9]th Gen }"
+  cpu="${cpu//[0-9]th Gen }"
+  cpu="${cpu// Processor/}"
+  cpu="${cpu// Quad core/}"
+  cpu="${cpu// Dual core/}"
+  cpu="${cpu// Octa core/}"
+  cpu="${cpu// Hexa core/}"
+  cpu="${cpu// Core TM/ Core}"
+  cpu="${cpu// with Radeon Graphics/}"
+  cpu="${cpu// with Radeon Vega Graphics/}"
+  cpu="${cpu// with Radeon Vega Mobile Gfx/}"
+  cpu="${cpu// w Radeon [0-9][0-9][0-9]M Graphics/}"
+
+  [ -z "${cpu// /}" ] && cpu="Unknown"
+
+  echo "$cpu"
+  return 0
+}
+
+hasDisk() {
+
+  enabled "${DISK_DISABLE:-}" && return 1
+
+  [ -b "/disk" ] && return 0
+  [ -b "/disk1" ] && return 0
+  [ -b "/dev/disk1" ] && return 0
+  [ -b "${DEVICE:-}" ] && return 0
+
+  [ -z "${DISK_NAME:-}" ] && DISK_NAME="data"
+  [ -s "$STORAGE/$DISK_NAME.img" ]  && return 0
+  [ -s "$STORAGE/$DISK_NAME.qcow2" ] && return 0
+
+  return 1
+}
+
+getCountry() {
+  local url=$1
+  local query=$2
+  local rc json result
+
+  { json=$(curl -m 5 -H "Accept: application/json" -sfk "$url"); rc=$?; } || :
+  (( rc != 0 )) && return 0
+
+  { result=$(echo "$json" | jq -r "$query" 2> /dev/null); rc=$?; } || :
+  (( rc != 0 )) && return 0
+
+  [[ ${#result} -ne 2 ]] && return 0
+  [[ "${result^^}" == "XX" ]] && return 0
+
+  COUNTRY="${result^^}"
+
+  return 0
+}
+
+setCountry() {
+
+  [[ "${TZ,,}" == "asia/harbin" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/beijing" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/urumqi" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/kashgar" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/shanghai" ]] && COUNTRY="CN"
+  [[ "${TZ,,}" == "asia/chongqing" ]] && COUNTRY="CN"
+
+  [ -z "$COUNTRY" ] && getCountry "https://api.ipapi.is" ".location.country_code"
+  [ -z "$COUNTRY" ] && getCountry "https://ifconfig.co/json" ".country_iso"
+  [ -z "$COUNTRY" ] && getCountry "https://api.ip2location.io" ".country_code"
+  [ -z "$COUNTRY" ] && getCountry "https://ipinfo.io/json" ".country"
+  [ -z "$COUNTRY" ] && getCountry "https://api.ipquery.io/?format=json" ".location.country_code" 
+  [ -z "$COUNTRY" ] && getCountry "https://api.myip.com" ".cc"
+
+  return 0
+}
+
+addPackage() {
+  local pkg=$1
+  local desc=$2
+
+  if apt-mark showinstall | grep -qx "$pkg"; then
+    return 0
+  fi
+
+  MSG="Installing $desc..."
+  info "$MSG" && html "$MSG"
+
+  [ -z "$COUNTRY" ] && setCountry
+
+  if [[ "${COUNTRY^^}" == "CN" ]]; then
+    sed -i 's/deb.debian.org/mirrors.ustc.edu.cn/g' /etc/apt/sources.list.d/debian.sources
+  fi
+
+  DEBIAN_FRONTEND=noninteractive apt-get -qq update
+  DEBIAN_FRONTEND=noninteractive apt-get -qq --no-install-recommends -y install "$pkg" > /dev/null
+
+  return 0
+}
+
+return 0

web/conf/nginx.conf

@@ -0,0 +1,44 @@
+server {
+    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;
+
+    }
+
+    location /status {
+
+      proxy_http_version 1.1;
+
+      proxy_set_header Connection 'upgrade';
+      proxy_set_header Upgrade $http_upgrade;
+
+      proxy_buffering off;
+      proxy_read_timeout 3600s;
+      proxy_send_timeout 3600s;
+
+      proxy_pass http://127.0.0.1:8004/;
+    }    
+}

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,208 @@
+var request;
+var booting = false;
+var interval = 1000;
+
+function getInfo() {
+
+    var url = "msg.html";
+
+    try {
+        if (request) {
+            request.abort();
+        }
+
+        if (window.XMLHttpRequest) {
+            request = new XMLHttpRequest();
+        } else {
+            throw new Error("XMLHttpRequest not available!");
+        }
+
+        request.onreadystatechange = processInfo;
+        request.open("GET", url, true);
+        request.send();
+
+    } catch (e) {
+        setError("Error: " + e.message);
+    }
+}
+
+function getURL() {
+
+    var protocol = window.location.protocol === "https:" ? "wss:" : "ws:";
+    var path = window.location.pathname.replace(/[^/]*$/, '').replace(/\/$/, '');
+
+    return protocol + "//" + window.location.host + path;
+}
+
+function processMsg(msg) {
+
+    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;
+}
+
+function processInfo() {
+    try {
+
+        if (request.readyState != 4) {
+            return true;
+        }
+
+        var msg = request.responseText;
+        if (msg == null || msg.length == 0) {
+
+            if (booting) {
+                schedule();
+                return true;
+            }
+
+            window.location.reload();
+            return false;
+        }
+
+        var notFound = (request.status == 404);
+
+        if (request.status == 200) {
+            if (msg.toLowerCase().indexOf("<html>") !== -1) {
+                notFound = true;
+            } else {
+                processMsg(msg);
+                if (msg.toLowerCase().indexOf("href=") == -1) {
+                    schedule();
+                }
+                return true;
+            }
+        }
+
+        if (notFound) {
+            setInfo("Connecting to web portal", true);
+            reload();
+            return true;
+        }
+
+        setError("Error: Received statuscode " + request.status);
+        return false;
+
+    } catch (e) {
+        setError("Error: " + e.message);
+        return false;
+    }
+}
+
+function extractContent(s) {
+    var span = document.createElement('span');
+    span.innerHTML = s;
+    return span.textContent || span.innerText;
+};
+
+function setInfo(msg, loading, error) {
+    try {
+
+        if (msg == null || msg.length == 0) {
+            return false;
+        }
+
+        if (msg.includes("Booting ")) {
+            booting = true;
+        }
+
+        var el = document.getElementById("info");
+
+        if (el.innerText == msg || el.innerHTML == msg) {
+            return true;
+        }
+
+        var spin = document.getElementById("spinner");
+
+        error = !!error;
+        if (!error) {
+            spin.style.visibility = 'visible';
+        } else {
+            spin.style.visibility = 'hidden';
+        }
+
+        var p = "<p class=\"loading\">";
+        loading = !!loading;
+        if (loading) {
+            msg = p + msg + "</p>";
+        }
+
+        if (msg.includes(p)) {
+            if (el.innerHTML.includes(p)) {
+                el.getElementsByClassName('loading')[0].textContent = extractContent(msg);
+                return true;
+            }
+        }
+
+        el.innerHTML = msg;
+        return true;
+
+    } catch (e) {
+        console.log("Error: " + e.message);
+        return false;
+    }
+}
+
+function setError(text) {
+    console.warn(text);
+    return setInfo(text, false, true);
+}
+
+function schedule() {
+    setTimeout(getInfo, interval);
+}
+
+function reload() {
+    setTimeout(() => {
+        window.location.reload();
+    }, 3000);
+}
+
+function connect() {
+
+    var wsUrl = getURL() + "/status";
+    var ws = new WebSocket(wsUrl);
+
+    ws.onmessage = function(e) {
+
+        var pos = e.data.indexOf(":");
+        var cmd = e.data.substring(0, pos);
+        var msg = e.data.substring(pos + 2);
+
+        switch (cmd) {
+            case "s":
+                processMsg(msg);
+                break;
+            case "e":
+                setError(msg);
+                break;
+            default:
+                console.warn("Unknown event: " + cmd);
+                break;
+        }
+    };
+
+    ws.onclose = function(e) {
+        setTimeout(function() {
+            connect();
+        }, interval);
+    };
+
+    ws.onerror = function(e) {
+        ws.close();
+        if (!booting) {
+            window.location.reload();
+        }
+    };
+}
+
+schedule();
+connect();