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

.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/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/BUG_REPORT.yml

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

.github/ISSUE_TEMPLATE/QUESTION.yml

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/workflows/build.yml

@@ -2,20 +2,6 @@ name: Build
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - master
-    paths-ignore:
-      - '**/*.md'
-      - '**/*.yml'
-      - '**/*.js'
-      - '**/*.css'
-      - '**/*.html'
-      - 'web/**'
-      - '.gitignore'
-      - '.dockerignore'
-      - '.github/**'
-      - '.github/workflows/**'
 
 concurrency:
   group: build
@@ -36,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: |
@@ -54,31 +40,31 @@ jobs:
           labels: |
             org.opencontainers.image.title=${{ vars.NAME }}
         env:
-          DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index            
+          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 }}

.github/workflows/check.yml

@@ -7,9 +7,10 @@ jobs:
     name: shellcheck
     runs-on: ubuntu-latest
     steps:
-      - 
+    - 
-        name: Checkout
+      name: Checkout
-        uses: actions/checkout@v4
+      uses: actions/checkout@v7
+    - parallel:
       -
         name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master
@@ -17,8 +18,13 @@ jobs:
           SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2034 -e SC2064 -e SC2317 -e SC2153 -e SC2028
       - 
         name: Lint Dockerfile
-        uses: hadolint/hadolint-action@v3.1.0
+        uses: hadolint/hadolint-action@v3.3.0
         with:
           dockerfile: Dockerfile
-          ignore: DL3008,DL3003,DL3006
+          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@v4
+      - 
-      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,11 +1,6 @@
 on:
   workflow_dispatch:
   pull_request:
-    paths:
-      - '**/*.sh'
-      - 'Dockerfile'
-      - '.github/workflows/test.yml'
-      - '.github/workflows/check.yml'
 
 name: "Test"
 permissions: {}

Dockerfile

@@ -1,64 +1,87 @@
-FROM qemux/qemu-host:2.04 as builder
+# syntax=docker/dockerfile:1
-
-#  FROM golang as builder
-#  WORKDIR /
-#  RUN git clone https://github.com/qemus/qemu-host.git
-#  WORKDIR /qemu-host/src
-#  RUN go mod download
-#  RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o /qemu-host.bin .
 
+FROM qemux/qemu-host:2.05 AS builder
 FROM debian:trixie-slim
 
+ARG TARGETARCH
 ARG TARGETPLATFORM
-ARG DEBCONF_NOWARNINGS "yes"
+ARG VERSION_ARG="0.0"
-ARG DEBIAN_FRONTEND "noninteractive"
+ARG VERSION_PASST="2026_06_11"
-ARG DEBCONF_NONINTERACTIVE_SEEN "true"
 
-RUN if [ "$TARGETPLATFORM" != "linux/amd64" ]; then extra="qemu-user"; fi && \
+ARG DEBCONF_NOWARNINGS="yes"
-    apt-get update && \
+ARG DEBIAN_FRONTEND="noninteractive"
-    apt-get --no-install-recommends -y install \
+ARG DEBCONF_NONINTERACTIVE_SEEN="true"
-        jq \
-        tini \
-        curl \
-        cpio \
-        wget \
-        fdisk \
-        unzip \
-        nginx \
-        procps \
-        xz-utils \
-        iptables \
-        iproute2 \
-        apt-utils \
-        dnsmasq \
-        fakeroot \
-        net-tools \
-        qemu-utils \
-        ca-certificates \
-        netcat-openbsd \
-        qemu-system-x86 \
-        "$extra" && \
-    apt-get clean && \
-    unlink /etc/nginx/sites-enabled/default && \
-    sed -i 's/^worker_processes.*/worker_processes 1;/' /etc/nginx/nginx.conf && \
-    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
-COPY ./src /run/
+RUN <<EOF
-COPY ./web /var/www/
+  set -eu
-COPY --from=builder /qemu-host.bin /run/host.bin
 
-RUN chmod +x /run/*.sh && chmod +x /run/*.bin
+  apt-get update
-RUN mv /var/www/nginx.conf /etc/nginx/sites-enabled/web.conf 
+  apt-get --no-install-recommends -y install \
+    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
 
-ENV RAM_SIZE "1G"
+ENV RAM_SIZE="2G"
-ENV DISK_SIZE "16G"
+ENV CPU_CORES="2"
-ENV CPU_CORES "1"
+ENV DISK_SIZE="256G"
-
-ARG VERSION_ARG "0.0"
-RUN echo "$VERSION_ARG" > /run/version
 
 HEALTHCHECK --interval=60s --start-period=45s --retries=2 CMD /run/check.sh
 

compose.yml

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

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

@@ -7,130 +7,139 @@
 [![Build]][build_url]
 [![Version]][tag_url]
 [![Size]][tag_url]
+[![Package]][pkg_url]
 [![Pulls]][hub_url]
 
 </div></h1>
 
 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
- - Upgrades supported
+- Web-based access to the DSM desktop
- 
+- Near-native performance with KVM acceleration
-## Usage
+- Customizable CPU, memory, and storage allocation
+- Supports multiple disks and physical disk passthrough
+- Supports NAT, user-mode, macvlan, and macvtap networking
 
-Via Docker Compose:
+## Usage  🐳
+
+##### Docker Compose:
 
 ```yaml
-version: "3"
 services:
   dsm:
     container_name: dsm
     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:
-      - /var/dsm:/storage
+      - ./dsm:/storage
-    restart: on-failure
+    restart: always
     stop_grace_period: 2m
 ```
 
-Via Docker CLI:
+##### Docker CLI:
 
 ```bash
-docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 vdsm/virtual-dsm
+docker run -it --rm --name dsm -e "DISK_SIZE=256G" -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/dsm:/storage" --stop-timeout 120 docker.io/vdsm/virtual-dsm
 ```
 
-## FAQ
+##### Kubernetes:
 
-* ### How do I use it?
+```shell
+kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/master/kubernetes.yml
+```
+
+##### GitHub Codespaces:
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/vdsm/virtual-dsm)
+
+## Requirements ⚙️
+
+ - 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.
+
+> [!NOTE]
+> Docker Desktop on macOS and Windows 10 do not currently provide the required KVM support for this image.
+
+## FAQ 💬
+
+### How do I use it?
 
   Very simple! These are the steps:
   
-  - Start the container and connect to [port 5000](http://localhost:5000) using your web browser.
+  - Start the container and connect to [port 5000](http://127.0.0.1:5000/) using your web browser.
 
-  - Wait until DSM is ready, choose an username and password, and you will be taken to the desktop.
+  - Wait until DSM finishes its installation
+ 
+  - Choose a username and password, and you will be taken to the desktop.
   
-  Enjoy your brand new machine, and don't forget to star this repo!
+  Enjoy your brand new NAS, and don't forget to star this repo!
 
-* ### How do I change the size of the disk?
+### How do I change the storage location?
-
-  To expand the default size of 16 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
-
-  ```yaml
-  environment:
-    DISK_SIZE: "128G"
-  ```
-  
-  This can also be used to resize the existing disk to a larger capacity without any data loss. 
-
-* ### How do I change the storage location?
 
   To change the storage location, include the following bind mount in your compose file:
 
   ```yaml
   volumes:
-    - /var/dsm:/storage
+    - ./dsm:/storage
   ```
 
-  Replace the example path `/var/dsm` with the desired storage folder.
+  Replace the example path `./dsm` with the desired storage folder or named volume.
+ 
+### How do I change the size of the disk?
 
-* ### How do I create a growable disk?
+  To expand the default size of 256 GB, locate the `DISK_SIZE` setting in your compose file and modify it to your preferred capacity:
-
-  By default, the entire capacity of the disk is reserved in advance.
-
-  To create a growable disk that only allocates space that is actually used, add the following environment variable:
 
   ```yaml
   environment:
-    DISK_FMT: "qcow2"
+    DISK_SIZE: "512G"
   ```
+  
+> [!TIP]
+> This can also be used to resize an existing disk to a larger capacity without any data loss.
 
-  Please note that this may reduce the write performance of the disk.
+### How do I add multiple disks?
-
-* ### How do I add multiple disks?
 
   To create additional disks, modify your compose file like this:
   
   ```yaml
   environment:
-    DISK2_SIZE: "32G"
+    DISK2_SIZE: "500G"
-    DISK3_SIZE: "64G"
+    DISK3_SIZE: "750G"
   volumes:
-    - /home/example:/storage2
+    - ./example2:/storage2
-    - /mnt/data/example:/storage3
+    - ./example3:/storage3
   ```
 
-* ### How do I pass-through a disk?
+### How do I pass through a disk?
 
-   It is possible to pass-through disk devices directly by adding them to your compose file in this way:
+   You can pass through disk devices or partitions directly by adding them to your compose file in this way:
 
   ```yaml
-  environment:
-    DEVICE2: "/dev/sda"
-    DEVICE3: "/dev/sdb"
   devices:
-    - /dev/sda
+    - /dev/sdb:/disk1
-    - /dev/sdb
+    - /dev/sdc1:/disk2
   ```
 
-  Please note that the device needs to be totally empty (without any partition table) otherwise DSM does not always format it into a volume.
+  Make sure it is totally empty (without any filesystem), otherwise DSM may not format it as a volume.
 
-  Do NOT use this feature with the goal of sharing files from the host, they will all be lost without warning when DSM creates the volume.
+### How do I change the amount of CPU or RAM?
 
-* ### How do I increase the amount of CPU or RAM?
+  By default, Virtual DSM will be allowed to use 2 CPU cores and 2 GB of RAM.
 
-  By default, a single CPU core and 1 GB of RAM are allocated to the container.
+  If you want to adjust this, you can specify the desired amount using the following environment variables:
-
-  To increase this, add the following environment variables:
 
   ```yaml
   environment:
@@ -138,18 +147,35 @@ docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMI
     CPU_CORES: "4"
   ```
 
-* ### How do I verify if my system supports KVM?
+### How do I verify if my system supports KVM?
 
-  To verify if your system supports KVM, run the following commands:
+  First check if your software is compatible using this chart:
+
+  | **Product**  | **Linux** | **Win11** | **Win10** | **macOS** |
+  |---|---|---|---|---|
+  | Docker CLI        | ✅   | ✅       | ❌        | ❌ |
+  | Docker Desktop    | ❌   | ✅       | ❌        | ❌ | 
+  | Podman CLI        | ✅   | ✅       | ❌        | ❌ | 
+  | Podman Desktop    | ✅   | ✅       | ❌        | ❌ | 
+
+  After that you can run the following commands in Linux to check your system:
 
   ```bash
   sudo apt install cpu-checker
   sudo kvm-ok
   ```
 
-  If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check the virtualization settings in the BIOS.
+  If you receive an error from `kvm-ok` indicating that KVM cannot be used, please check whether:
 
-* ### How do I assign an individual IP address to the container?
+  - the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your BIOS.
+
+  - you enabled "nested virtualization" if you are running the container inside a virtual machine.
+
+  - you are not using a cloud provider, as most of them do not allow nested virtualization for their VPSs.
+
+  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.
+
+### How do I assign an individual IP address to the container?
 
   By default, the container uses bridge networking, which shares the IP address with the host. 
 
@@ -183,13 +209,14 @@ docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMI
  
   An added benefit of this approach is that you won't have to perform any port mapping anymore, since all ports will be exposed by default.
 
-  Please note that this IP address won't be accessible from the Docker host due to the design of macvlan, which doesn't permit communication between the two. If this is a concern, you need to create a [second macvlan](https://blog.oddbit.com/post/2018-03-12-using-docker-macvlan-networks/#host-access) as a workaround.
+> [!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?
+### How can DSM acquire an IP address from my router?
 
-  After configuring the container for macvlan (see above), it is possible for DSM to become part of your home network by requesting an IP from your router, just like your other devices.
+  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, add the following lines to your compose file:
+  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:
@@ -200,11 +227,9 @@ docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMI
     - 'c *:* rwm'
   ```
 
-  Please note that even if you don't need DHCP, it's still recommended to enable this mode, as it prevents NAT issues and increases performance by using a `macvtap` interface. You can just set a static IP from the DSM control panel afterwards.
+### How do I pass through the GPU?
 
-* ### How do I pass-through the GPU?
+  To pass through your Intel GPU, add the following lines to your compose file:
-
-  To pass-through your Intel GPU, add the following lines to your compose file:
 
   ```yaml
   environment:
@@ -213,41 +238,57 @@ docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMI
     - /dev/dri
   ```
 
-  This can be used to enable the facial recognition function in Synology Photos for example.
+> [!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?
+### How do I install a specific version of vDSM?
 
-  By default, version 7.2 will be installed, but if you prefer an older version, you can add its download URL to your compose file as follows:
+  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 between different versions while keeping all your file data intact.
+  With this method, it is even possible to switch back and forth between versions while keeping your file data intact.
 
-* ### What are the differences compared to the standard DSM?
+  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 copyrighted material. Neither does it try to circumvent any copyright protection measures. So under all applicable laws, this project would be considered legal. 
+### 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
+## Stars 🌟
-[![Stars](https://starchart.cc/vdsm/virtual-dsm.svg?variant=adaptive)](https://starchart.cc/vdsm/virtual-dsm)
+[![Stargazers](https://raw.githubusercontent.com/star-stats/stars/refs/heads/data/charts/vdsm-virtual-dsm.svg)](https://github.com/vdsm/virtual-dsm/stargazers)
 
-## Disclaimer
+## 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.
+*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,28 +1,33 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+cd /run
+. utils.sh      # Load functions
+
+: "${DHCP:="N"}"
 : "${NETWORK:="Y"}"
 
-[ -f "/run/shm/qemu.end" ] && echo "QEMU is shutting down.." && exit 1
+[ -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
+[ ! -s "/run/shm/qemu.pid" ] && echo "QEMU is not running yet..." && exit 0
-[[ "$NETWORK" != [Yy1]* ]] && echo "Networking is disabled.." && exit 0
+disabled "$NETWORK" && echo "Networking is disabled." && exit 0
 
 file="/run/shm/dsm.url"
 address="/run/shm/qemu.ip"
+gateway="/run/shm/qemu.gw"
 
-[ ! -s  "$file" ] && echo "DSM has not enabled networking yet.." && exit 1
+[ ! -s  "$file" ] && echo "DSM has not enabled networking yet..." && exit 1
 
 location=$(<"$file")
 
 if ! curl -m 20 -ILfSs "http://$location/" > /dev/null; then
 
-  if [[ "$location" == "20.20"* ]]; then
+  if enabled "$DHCP"; then
-    ip="20.20.20.1"
+    ip=$(<"$address")
+    echo "Failed to reach DSM at http://$location"
+  else
+    ip=$(<"$gateway")
     port="${location##*:}"
     echo "Failed to reach DSM at port $port"
-  else
-    echo "Failed to reach DSM at http://$location"
-    ip=$(<"$address")
   fi
 
   echo "You might need to whitelist IP $ip in the DSM firewall." && exit 1

src/config.sh

@@ -2,12 +2,13 @@
 set -Eeuo pipefail
 
 DEF_OPTS="-nodefaults -boot strict=on"
-RAM_OPTS=$(echo "-m $RAM_SIZE" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+RAM_OPTS=$(echo "-m ${RAM_SIZE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
+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,usb=off,vmport=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
+MAC_OPTS="-machine type=q35,smm=off,usb=off,vmport=off,dump-guest-core=off,hpet=off${KVM_OPTS}"
 DEV_OPTS="-device virtio-balloon-pci,id=balloon0,bus=pcie.0,addr=0x4"
-DEV_OPTS="$DEV_OPTS -object rng-random,id=objrng0,filename=/dev/urandom"
+DEV_OPTS+=" -object rng-random,id=objrng0,filename=/dev/urandom"
-DEV_OPTS="$DEV_OPTS -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
+DEV_OPTS+=" -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0,addr=0x1c"
 
 ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS $NET_OPTS $DISK_OPTS $DEV_OPTS $ARGUMENTS"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')

src/display.sh

@@ -6,8 +6,16 @@ set -Eeuo pipefail
 : "${GPU:="N"}"         # GPU passthrough
 : "${VGA:="virtio"}"    # VGA adaptor
 : "${DISPLAY:="none"}"  # Display type
+: "${RENDERNODE:="/dev/dri/renderD128"}"  # Render node
 
-if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
+# 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"
@@ -15,20 +23,28 @@ if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
 
 fi
 
-DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128"
+msg="Configuring display drivers..."
-DISPLAY_OPTS="$DISPLAY_OPTS -vga $VGA"
+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
 
-if [ ! -c /dev/dri/card0 ]; then
+# Extract the card number from the render node
-  if mknod /dev/dri/card0 c 226 0; then
+CARD_NUMBER=$(echo "$RENDERNODE" | grep -oP '(?<=renderD)\d+')
-    chmod 666 /dev/dri/card0
+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 /dev/dri/renderD128 ]; then
+if [ ! -c "$RENDERNODE" ]; then
-  if mknod /dev/dri/renderD128 c 226 128; then
+  if mknod "$RENDERNODE" c 226 "$CARD_NUMBER"; then
-    chmod 666 /dev/dri/renderD128
+    chmod 666 "$RENDERNODE"
   fi
 fi
 

src/entry.sh

@@ -1,12 +1,16 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-APP="Virtual DSM"
+: "${PLATFORM:="x64"}"
-SUPPORT="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
@@ -14,23 +18,29 @@ cd /run
 . 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
 
-info "Booting ${APP} on a ${CPU} using QEMU v${VERS} with kernel $(uname -r)..."
+cmd=(qemu-system-x86_64)
-[[ "$DEBUG" == [Yy1]* ]] && echo "Arguments: $ARGS" && echo
+version=$("${cmd[@]}" --version | awk 'NR==1 { print $4 }')
+info "Booting $APP using QEMU v$version..." && echo
 
-if [[ "$CONSOLE" == [Yy]* ]]; then
+if ! enabled "$SHUTDOWN"; then
-  exec qemu-system-x86_64 ${ARGS:+ $ARGS}
+  exec "${cmd[@]}" ${ARGS:+ $ARGS}
 fi
 
-{ qemu-system-x86_64 ${ARGS:+ $ARGS} >"$QEMU_OUT" 2>"$QEMU_LOG"; rc=$?; } || :
+if [ ! -t 1 ] || [ ! -c /dev/tty ]; then
-(( rc != 0 )) && error "$(<"$QEMU_LOG")" && exit 15
+  "${cmd[@]}" ${ARGS:+ $ARGS} &
+else
+  "${cmd[@]}" ${ARGS:+ $ARGS} </dev/tty >/dev/tty &
+fi
 
-terminal
+rc=0
-tail -fn +0 "$QEMU_LOG" 2>/dev/null &
+wait $! || rc=$?
-cat "$QEMU_TERM" 2>/dev/null & wait $! || :
+[ -f "$QEMU_END" ] && exit "$rc"
 
 sleep 1 & wait $!
-finish 0
+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/install.sh

@@ -5,22 +5,44 @@ set -Eeuo pipefail
 
 if [ -f "$STORAGE/dsm.ver" ]; then
   BASE=$(<"$STORAGE/dsm.ver")
+  BASE="${BASE//[![:print:]]/}"
   [ -z "$BASE" ] && BASE="DSM_VirtualDSM_69057"
 else
   # Fallback for old installs
   BASE="DSM_VirtualDSM_42962"
 fi
 
-if [ -n "$URL" ]; then
+FN="boot.pat"
-  BASE=$(basename "$URL" .pat)
+DIR=$(find / -maxdepth 1 -type d -iname "$FN" -print -quit)
-  if [ ! -s "$STORAGE/$BASE.system.img" ]; then
+[ ! -d "$DIR" ] && DIR=$(find "$STORAGE" -maxdepth 1 -type d -iname "$FN" -print -quit)
-    BASE=$(basename "${URL%%\?*}" .pat)
+
-    : "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+if [ -d "$DIR" ]; then
-    BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
+  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
 
-if [[ -s "$STORAGE/$BASE.boot.img" ]] && [[ -s "$STORAGE/$BASE.system.img" ]]; then
+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
 
@@ -39,11 +61,15 @@ if [ -z "$DL" ]; then
   [[ "${COUNTRY^^}" == "CN" ]] && DL="$DL_CHINA" || DL="$DL_GLOBAL"
 fi
 
-[ -z "$URL" ] && URL="$DL/release/7.2.1/69057-1/DSM_VirtualDSM_69057.pat"
+if [ -z "$URL" ]; then
+  URL="$DL/release/7.2.2/72806/DSM_VirtualDSM_72806.pat"
+fi
 
-BASE=$(basename "${URL%%\?*}" .pat)
+if [ ! -s "$FILE" ]; then
-: "${BASE//+/ }"; printf -v BASE '%b' "${_//%/\\x}"
+  BASE=$(basename "${URL%%\?*}" .pat)
-BASE=$(echo "$BASE" | sed -e 's/[^A-Za-z0-9._-]/_/g')
+  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"
@@ -53,17 +79,19 @@ rm -f "$STORAGE/$BASE.agent"
 rm -f "$STORAGE/$BASE.boot.img"
 rm -f "$STORAGE/$BASE.system.img"
 
-[[ "$DEBUG" == [Yy1]* ]] && set -x
-
 # Check filesystem
 FS=$(stat -f -c %T "$STORAGE")
 
-if [[ "${FS,,}" == "overlay"* ]]; then
+if [[ "${FS,,}" == "overlay"* && "${ENGINE,,}" == "docker" ]]; then
-  info "Warning: the filesystem of $STORAGE is OverlayFS, this usually means it was binded to an invalid path!"
+  warn "the filesystem of $STORAGE is OverlayFS, this usually means it was binded to an invalid path!"
 fi
 
 if [[ "${FS,,}" == "fuse"* ]]; then
-  info "Warning: the filesystem of $STORAGE is FUSE, this extra layer will negatively affect performance!"
+  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
@@ -72,28 +100,31 @@ 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=$(( (SPACE + 1048575)/1048576 ))
+  SPACE_MB=$(formatBytes "$SPACE")
   if (( TMP_SPACE > SPACE )); then
-    error "Not enough free space inside the container, have $SPACE_MB MB available but need at least 2 GB." && exit 93
+    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
 
-rm -rf "$TMP" && mkdir -p "$TMP"
-
 # Check free diskspace
 ROOT_SPACE=536870912
 SPACE=$(df --output=avail -B 1 / | tail -n 1)
-SPACE_MB=$(( (SPACE + 1048575)/1048576 ))
+SPACE_MB=$(formatBytes "$SPACE" "down")
-(( ROOT_SPACE > SPACE )) && error "Not enough free space inside the container, have $SPACE_MB MB available but need at least 500 MB." && exit 96
+(( 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=8589934592
+MIN_SPACE=15032385536
 SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
-SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
+SPACE_GB=$(formatBytes "$SPACE")
-(( MIN_SPACE > SPACE )) && error "Not enough free space for installation in $STORAGE, have $SPACE_GB GB available but need at least 8 GB." && exit 94
+(( 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
@@ -102,122 +133,50 @@ else
   PROGRESS="--progress=dot:giga"
 fi
 
-# Download the required files from the Synology website
+if [[ "$URL" == "file://"* ]]; then
-
+  MSG="Copying DSM"
-ROOT="Y"
+  ERR="Failed to copy ${URL:7}"
-RDC="$STORAGE/dsm.rd"
+  info "Install: Copying installation image..."
-
+else
-if [ ! -s "$RDC" ]; then
+  MSG="Downloading DSM"
-
+  ERR="Failed to download $URL"
-  MSG="Downloading installer..."
+  info "Install: Downloading $BASE.pat..."
-  PRG="Downloading installer ([P])..."
-  info "Install: $MSG" && html "$MSG"
-
-  RD="$TMP/rd.gz"
-  POS="65627648-71021835"
-  VERIFY="b4215a4b213ff5154db0488f92c87864"
-  LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
-
-  rm -f "$RD"
-  rm -f "$RDC"
-  /run/progress.sh "$RD" "$PRG" &
-  { curl -r "$POS" -sfk -S -o "$RD" "$LOC"; rc=$?; } || :
-
-  fKill "progress.sh"
-
-  if (( rc != 0 )); then
-    (( rc != 22 )) && error "Failed to download $LOC, reason: $rc" && exit 60
-    SUM="skip"
-  else
-    SUM=$(md5sum "$RD" | cut -f 1 -d " ")
-  fi
-
-  if [ "$SUM" != "$VERIFY" ]; then
-
-    PAT="/install.pat"
-    rm -f "$RD"
-    rm -f "$PAT"
-
-    html "$MSG"
-    /run/progress.sh "$PAT" "$PRG" &
-    { wget "$LOC" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
-
-    fKill "progress.sh"
-    (( rc != 0 )) && error "Failed to download $LOC , reason: $rc" && exit 60
-
-    tar --extract --file="$PAT" --directory="$(dirname "$RD")"/. "$(basename "$RD")"
-    rm "$PAT"
-
-  fi
-
-  cp "$RD" "$RDC"
-
 fi
 
-if [ -f "$RDC" ]; then
+html "$MSG..."
-
-  { xz -dc <"$RDC" >"$TMP/rd" 2>/dev/null; rc=$?; } || :
-  (( rc != 1 )) && error "Failed to unxz $RDC on $FS, reason $rc" && exit 91
-
-  { (cd "$TMP" && cpio -idm <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-
-  if (( rc != 0 )); then
-    ROOT="N"
-    { (cd "$TMP" && fakeroot cpio -idmu <"$TMP/rd" 2>/dev/null); rc=$?; } || :
-    (( rc != 0 )) && error "Failed to extract $RDC on $FS, reason $rc" && exit 92
-  fi
-
-  rm -rf /run/extract && mkdir -p /run/extract
-  for file in $TMP/usr/lib/libcurl.so.4 \
-              $TMP/usr/lib/libmbedcrypto.so.5 \
-              $TMP/usr/lib/libmbedtls.so.13 \
-              $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 $BASE.pat..."
-
-MSG="Downloading DSM..."
-PRG="Downloading DSM ([P])..."
-html "$MSG"
 
 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
 
-  /run/progress.sh "$PAT" "$PRG" &
+  SIZE=0
+  [[ "${URL,,}" == *"_72806.pat" ]] && SIZE=361010261
+  [[ "${URL,,}" == *"_69057.pat" ]] && SIZE=363837333
+  [[ "${URL,,}" == *"_42218.pat" ]] && SIZE=379637760
 
-  { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+  /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 != 0 )) && error "Failed to download $URL , reason: $rc" && exit 69
+
+  (( 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
 
-[ ! -s "$PAT" ] && error "Failed to download $URL" && exit 69
+[ ! -s "$PAT" ] && error "$ERR" && exit 69
 
 SIZE=$(stat -c%s "$PAT")
 
@@ -225,7 +184,7 @@ if ((SIZE<250000000)); then
   error "The specified PAT file is probably an update pack as it's too small." && exit 62
 fi
 
-MSG="Extracting downloaded image..."
+MSG="Extracting installation image..."
 info "Install: $MSG" && html "$MSG"
 
 if { tar tf "$PAT"; } >/dev/null 2>&1; then
@@ -234,47 +193,43 @@ if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
 else
 
-  export LD_LIBRARY_PATH="/run/extract"
+  { (cd "$TMP" && python3 /run/extract.py -i "$PAT" -d 2>/run/extract.log); rc=$?; } || :
 
-  if [ "$ARCH" == "amd64" ]; then
+  if (( rc != 0 )); then
-    { /run/extract/syno_extract_system_patch "$PAT" "$TMP/."; rc=$?; } || :
+    cat /run/extract.log
-  else
+    error "Failed to extract PAT file, reason $rc" && exit 63
-    { 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
 
-rm -rf /run/extract
-
 MSG="Preparing system partition..."
 info "Install: $MSG" && html "$MSG"
 
-BOOT=$(find "$TMP" -name "*.bin.zip")
+BOOT=$(find "$TMP" -name "*.bin.zip" -print -quit)
-[ ! -s "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
+[ -z "$BOOT" ] && error "The PAT file contains no boot image." && exit 67
+[ ! -s "$BOOT" ] && error "The PAT boot image archive is empty." && exit 67
 
-BOOT=$(echo "$BOOT" | head -c -5)
+unzip -q -o "$BOOT" -d "$TMP"
-unzip -q -o "$BOOT".zip -d "$TMP"
+BOOT="${BOOT%.zip}"
 
 SYSTEM="$STORAGE/$BASE.system.img"
 rm -f "$SYSTEM"
 
 # Check free diskspace
-SYSTEM_SIZE=4954537983
+SYSTEM_SIZE=10738466816
 SPACE=$(df --output=avail -B 1 "$STORAGE" | tail -n 1)
-SPACE_MB=$(( (SPACE + 1048575)/1048576 ))
+SPACE_MB=$(formatBytes "$SPACE")
 
 if (( SYSTEM_SIZE > SPACE )); then
-  error "Not enough free space in $STORAGE to create a 5 GB system disk, have only $SPACE_MB MB available." && exit 97
+  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")
@@ -283,10 +238,12 @@ if [[ "${FS,,}" == "btrfs" ]]; then
   fi
 fi
 
-if ! fallocate -l "$SYSTEM_SIZE" "$SYSTEM"; then
+if ! fallocate -l "$SYSTEM_SIZE" "$SYSTEM" &>/dev/null; then
-  if ! truncate -s "$SYSTEM_SIZE" "$SYSTEM"; then
+  if ! fallocate -l -x "$SYSTEM_SIZE" "$SYSTEM"; then
-    rm -f "$SYSTEM"
+    if ! truncate -s "$SYSTEM_SIZE" "$SYSTEM"; then
-    error "Could not allocate file $SYSTEM for the system disk." && exit 98
+      rm -f "$SYSTEM"
+      error "Could not allocate file $SYSTEM for the system disk." && exit 98
+    fi
   fi
 fi
 
@@ -298,14 +255,18 @@ PART="$TMP/partition.fdisk"
         echo "unit: sectors"
         echo "sector-size: 512"
         echo ""
-        echo "${SYSTEM}1 : start=        2048, size=     4980480, type=83"
+        echo "${SYSTEM}1 : start=        2048, size=    16777216, type=83"
-        echo "${SYSTEM}2 : start=     4982528, size=     4194304, type=82"
+        echo "${SYSTEM}2 : start=    16779264, size=     4194304, type=82"
 } > "$PART"
 
 sfdisk -q "$SYSTEM" < "$PART"
 
 MOUNT="$TMP/system"
-rm -rf "$MOUNT" && mkdir -p "$MOUNT"
+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"
@@ -321,38 +282,27 @@ mv "$HDA.tgz" "$HDA.txz"
 [ -d "$PKG" ] && mv "$PKG/" "$MOUNT/.SynoUpgradePackages/"
 rm -f "$MOUNT/.SynoUpgradePackages/ActiveInsight-"*
 
-[ -s "$HDP.txz" ] && tar xpfJ "$HDP.txz" --absolute-names -C "$MOUNT/"
+INDEX_DB="$MOUNT/usr/syno/synoman/indexdb"
 
 if [ -s "$IDB.txz" ]; then
-  INDEX_DB="$MOUNT/usr/syno/synoman/indexdb/"
   mkdir -p "$INDEX_DB"
-  tar xpfJ "$IDB.txz" --absolute-names -C "$INDEX_DB"
 fi
 
 LABEL="1.44.1-42218"
-OFFSET="1048576" # 2048 * 512
+OFFSET="1048576"    # 2048 * 512
-NUMBLOCKS="622560" # (4980480 * 512) / 4096
+NUMBLOCKS="2097152" # (16777216 * 512) / 4096
 MSG="Installing system partition..."
 
-if [[ "$ROOT" != [Nn]* ]]; then
+fakeroot -- bash -c "set -Eeu;\
-
+  [ -s $HDP.txz ] && tar xpfJ $HDP.txz --absolute-names -C $MOUNT/;\
-  tar xpfJ "$HDA.txz" --absolute-names --skip-old-files -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/;\
-  info "Install: $MSG" && html "$MSG"
+  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"
-  mke2fs -q -t ext4 -b 4096 -d "$MOUNT/" -L "$LABEL" -F -E "offset=$OFFSET" "$SYSTEM" "$NUMBLOCKS"
-
-else
-
-  fakeroot -- bash -c "set -Eeu;\
-        tar xpfJ $HDA.txz --absolute-names --skip-old-files -C $MOUNT/;\
-        printf '%b%s%b' '\E[1;34m❯ \E[1;36m' 'Install: $MSG' '\E[0m\n';\
-        mke2fs -q -t ext4 -b 4096 -d $MOUNT/ -L $LABEL -F -E offset=$OFFSET $SYSTEM $NUMBLOCKS"
-
-fi
 
 rm -rf "$MOUNT"
 echo "$BASE" > "$STORAGE/dsm.ver"
+! setOwner "$STORAGE/dsm.ver" && error "Failed to set the owner for \"$STORAGE/dsm.ver\" !"
 
 if [[ "$URL" == "file://$STORAGE/$BASE.pat" ]]; then
   rm -f "$PAT"
@@ -360,11 +310,13 @@ 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
-
-html "Installation finished successfully..."
 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,134 +1,131 @@
 #!/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
 
 API_CMD=6
-API_TIMEOUT=50
+API_HOST="127.0.0.1:$COM_PORT"
-API_HOST="127.0.0.1:2210"
 
-QEMU_TERM=""
+# Configure QEMU for graceful shutdown
-QEMU_PORT=7100
-QEMU_TIMEOUT=50
-QEMU_PID="/run/shm/qemu.pid"
-QEMU_LOG="/run/shm/qemu.log"
-QEMU_OUT="/run/shm/qemu.out"
-QEMU_END="/run/shm/qemu.end"
 
-if [[ "$KVM" == [Nn]* ]]; then
+QEMU_END="$QEMU_DIR/qemu.end"
-  API_TIMEOUT=$(( API_TIMEOUT*2 ))
-  QEMU_TIMEOUT=$(( QEMU_TIMEOUT*2 ))
-fi
-
-touch "$QEMU_LOG"
 
 _trap() {
-  func="$1" ; shift
+
-  for sig ; do
+  local func="$1"; shift
+  local sig
+  TRAP_PID=$BASHPID
+
+  for sig; do
     trap "$func $sig" "$sig"
   done
+
+  return 0
+}
+
+signalCode() {
+
+  local sig="$1"
+
+  case "$sig" in
+    SIGHUP)  echo 129 ;;
+    SIGINT)  echo 130 ;;
+    SIGQUIT) echo 131 ;;
+    SIGABRT) echo 134 ;;
+    SIGTERM) echo 143 ;;
+    *)       echo 0 ;;
+  esac
+
+  return 0
+}
+
+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 pid
   local reason=$1
-
   touch "$QEMU_END"
 
-  if [ -s "$QEMU_PID" ]; then
+  forceKillQemu "$reason"
+  cleanupHelpers
 
-    pid=$(<"$QEMU_PID")
+  if ! waitPidFile "$QEMU_PID" 10; then
-    echo && error "Forcefully terminating QEMU process, reason: $reason..."
+    warn "Timed out while waiting for $(app) to exit!"
-    { kill -15 "$pid" || true; } 2>/dev/null
-
-    while isAlive "$pid"; do
-      sleep 1
-      # Workaround for zombie pid
-      [ ! -s "$QEMU_PID" ] && break
-    done
   fi
 
-  fKill "print.sh"
+  (( reason != 1 )) && echo && echo "❯ Shutdown completed!"
-  fKill "host.bin"
-
-  closeNetwork
-
-  sleep 1
-  echo && echo "❯ Shutdown completed!"
 
   exit "$reason"
 }
 
-terminal() {
+sendGuestShutdown() {
 
-  local dev=""
+  local pid="$1"
-
+  local response
-  if [ -s "$QEMU_OUT" ]; then
+  local url
-
-    local msg
-    msg=$(<"$QEMU_OUT")
-
-    if [ -n "$msg" ]; then
-
-      if [[ "${msg,,}" != "char"* ||  "$msg" != *"serial0)" ]]; then
-        echo "$msg"
-      fi
-
-      dev="${msg#*/dev/p}"
-      dev="/dev/p${dev%% *}"
-
-    fi
-  fi
-
-  if [ ! -c "$dev" ]; then
-    dev=$(echo 'info chardev' | nc -q 1 -w 1 localhost "$QEMU_PORT" | tr -d '\000')
-    dev="${dev#*serial0}"
-    dev="${dev#*pty:}"
-    dev="${dev%%$'\n'*}"
-    dev="${dev%%$'\r'*}"
-  fi
-
-  if [ ! -c "$dev" ]; then
-    error "Device '$dev' not found!"
-    finish 34 && return 34
-  fi
-
-  QEMU_TERM="$dev"
-  return 0
-}
-
-_graceful_shutdown() {
-
-  local code=$?
-  local pid url response
-
-  set +e
-
-  if [ -f "$QEMU_END" ]; then
-    echo && info "Received $1 signal while already shutting down..."
-    return
-  fi
-
-  touch "$QEMU_END"
-  echo && info "Received $1 signal, sending shutdown command..."
-
-  if [ ! -s "$QEMU_PID" ]; then
-    echo && error "QEMU PID file does not exist?"
-    finish "$code" && return "$code"
-  fi
-
-  pid=$(<"$QEMU_PID")
-
-  if ! isAlive "$pid"; then
-    echo && error "QEMU process does not exist?"
-    finish "$code" && return "$code"
-  fi
 
   # Don't send the powerdown signal because vDSM ignores ACPI signals
-  # echo 'system_powerdown' | nc -q 1 -w 1 localhost "${QEMU_PORT}" > /dev/null
+  # nc -q 1 -w 1 -U "$QEMU_DIR/monitor.sock" &> /dev/null <<<'system_powerdown' || :
 
   # Send shutdown command to guest agent via serial port
+  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)
 
@@ -140,45 +137,121 @@ _graceful_shutdown() {
 
     response="${response#*message\"\: \"}"
     [ -z "$response" ] && response="second signal"
+
     echo && error "Forcefully terminating because of: ${response%%\"*}"
-    { kill -15 "$pid" || true; } 2>/dev/null
+    kill -15 -- "$pid" 2>/dev/null || :
 
   fi
 
+  return 0
+}
+
+normalizeTimeout() {
+
+  local term_grace=3      # seconds before loop ends to send SIGTERM
+  local cleanup_grace=3   # seconds reserved after the loop for cleanup
+  local elapsed
+  local timeout_left
+  local min
+
+  TIMEOUT=$(strip "$TIMEOUT")
+  if [[ ! "$TIMEOUT" =~ ^[0-9]+$ ]]; then
+    TIMEOUT=115
+  fi
+
+  if (( TIMEOUT >= 30 )); then
+    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" -lt "$QEMU_TIMEOUT" ]; do
+  while (( cnt <= wait_until )); do
 
+    sleep 1 &
+    slp=$!
+
+    # Stop waiting if the process has exited
     ! isAlive "$pid" && break
 
-    sleep 1
+    # Workaround for stale/zombie QEMU pid file
-    cnt=$((cnt+1))
-
-    [[ "$DEBUG" == [Yy1]* ]] && info "Shutting down, waiting... ($cnt/$QEMU_TIMEOUT)"
-
-    # Workaround for zombie pid
     [ ! -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
 
-  if [ "$cnt" -ge "$QEMU_TIMEOUT" ]; then
+  return 0
-    echo && error "Shutdown timeout reached, aborting..."
-  fi
-
-  finish "$code" && return "$code"
 }
 
-MON_OPTS="\
+graceful_shutdown() {
-        -pidfile $QEMU_PID \
-        -name $PROCESS,process=$PROCESS,debug-threads=on \
-        -monitor telnet:localhost:$QEMU_PORT,server,nowait,nodelay"
 
-if [[ "$CONSOLE" != [Yy]* ]]; then
+  local sig="$1"
+  local pid=""
+  local code=0
 
-  MON_OPTS="$MON_OPTS -daemonize -D $QEMU_LOG"
+  [[ $BASHPID != "$TRAP_PID" ]] && return
 
-  _trap _graceful_shutdown SIGTERM SIGHUP SIGINT SIGABRT SIGQUIT
+  code=$(signalCode "$sig")
 
-fi
+  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,16 +1,21 @@
 #!/usr/bin/env bash
+# shellcheck disable=SC2329
 set -Eeuo pipefail
 
 : "${DHCP:="N"}"
 : "${NETWORK:="Y"}"
 
-[[ "$NETWORK" != [Yy1]* ]] && exit 0
+cd /run
+. utils.sh      # Load functions
 
 info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n" >&2; }
 error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
 
+disabled "$NETWORK" && exit 0
+
 file="/run/shm/dsm.url"
-info="/run/shm/msg.html"
+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"
@@ -21,88 +26,180 @@ resp_err="Guest returned an invalid response:"
 curl_err="Failed to connect to guest: curl error"
 jq_err="Failed to parse response from guest: jq error"
 
-while [ ! -s  "$file" ]
+exitIfShuttingDown() {
-do
-
-  # Check if not shutting down
-  [ -f "$shutdown" ] && exit 1
-
-  sleep 3
 
   [ -f "$shutdown" ] && exit 1
-  [ -s "$file" ] && break
 
-  # Retrieve network info from guest VM
+  return 0
+}
+
+queryGuest() {
+
+  local rc
+
   { json=$(curl -m 20 -sk "$url"); rc=$?; } || :
 
-  [ -f "$shutdown" ] && exit 1
+  exitIfShuttingDown
-  (( rc != 0 )) && error "$curl_err $rc" && continue
 
-  { result=$(echo "$json" | jq -r '.status'); rc=$?; } || :
+  if (( rc != 0 )); then
-  (( rc != 0 )) && error "$jq_err $rc ( $json )" && continue
+    error "$curl_err $rc"
-  [[ "$result" == "null" ]] && error "$resp_err $json" && continue
+    return 1
-
-  if [[ "$result" != "success" ]] ; then
-    { msg=$(echo "$json" | jq -r '.message'); rc=$?; } || :
-    error "Guest replied $result: $msg" && continue
   fi
 
-  { port=$(echo "$json" | jq -r '.data.data.dsm_setting.data.http_port'); rc=$?; } || :
+  return 0
-  (( rc != 0 )) && error "$jq_err $rc ( $json )" && continue
+}
-  [[ "$port" == "null" ]] && error "$resp_err $json" && continue
-  [ -z "$port" ] && continue
 
-  { ip=$(echo "$json" | jq -r '.data.data.ip.data[] | select((.name=="eth0") and has("ip")).ip'); rc=$?; } || :
+readJsonField() {
-  (( rc != 0 )) && error "$jq_err $rc ( $json )" && continue
-  [[ "$ip" == "null" ]] && error "$resp_err $json" && continue
 
-  if [ -z "$ip" ]; then
+  local query="$1"
-    [[ "$DHCP" == [Yy1]* ]] && continue
+  local result
-    ip="20.20.20.21"
+  local rc
+
+  { result=$(jq -r "$query" <<< "$json"); rc=$?; } || :
+
+  if (( rc != 0 )); then
+    error "$jq_err $rc ( $json )"
+    return 1
   fi
 
-  echo "$ip:$port" > $file
+  if [[ "$result" == "null" ]]; then
+    error "$resp_err $json"
+    return 1
+  fi
 
-done
+  printf '%s\n' "$result"
+  return 0
+}
 
-[ -f "$shutdown" ] && exit 1
+readGuestStatus() {
 
-location=$(<"$file")
+  local result msg rc
 
-if [[ "$location" != "20.20"* ]]; then
+  result=$(readJsonField '.status') || return 1
+
+  if [[ "$result" != "success" ]]; then
+    { msg=$(jq -r '.message // empty' <<< "$json"); rc=$?; } || :
+
+    if (( rc != 0 )); then
+      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=$(<"$template")
-  HTML="${HTML/\[1\]/$title}"
+  html="${html/\[1\]/$title}"
-  HTML="${HTML/\[2\]/$script}"
+  html="${html/\[2\]/$script}"
-  HTML="${HTML/\[3\]/$body}"
+  html="${html/\[3\]/$body}"
-  HTML="${HTML/\[4\]/}"
+  html="${html/\[4\]/}"
-  HTML="${HTML/\[5\]/}"
+  html="${html/\[5\]/}"
 
-  echo "$HTML" > "$page"
+  echo "$html" > "$page"
-  echo "$body" > "$info"
+  echo "$body" > "$msgs"
 
-else
+  return 0
+}
 
+buildStaticMessage() {
+
+  local nic ip port
+
+  nic=$(<"$driver")
   ip=$(<"$address")
   port="${location##*:}"
 
-  if [[ "$ip" == "172."* ]]; then
+  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
+  buildStaticMessage
 fi
 
-echo "" >&2
+printLoginMessage
-info "-----------------------------------------------------------"
-info " You can now login to DSM at $msg"
-info "-----------------------------------------------------------"
-echo "" >&2
 
 exit 0

src/proc.sh

@@ -3,105 +3,199 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
-: "${KVM:="Y"}"
 : "${HOST_CPU:=""}"
 : "${CPU_FLAGS:=""}"
 : "${CPU_MODEL:=""}"
-: "${DEF_MODEL:="qemu64"}"
 
-[ "$ARCH" != "amd64" ] && KVM="N"
+HOST_CPU=$(strip "$HOST_CPU")
+CPU_FLAGS=$(strip "$CPU_FLAGS")
+CPU_MODEL=$(strip "$CPU_MODEL")
 
-if [[ "$KVM" != [Nn]* ]]; then
+selectClocksource() {
 
-  KVM_ERR=""
+  CLOCKSOURCE="tsc"
+  [[ "${ARCH,,}" == "arm64" ]] && CLOCKSOURCE="arch_sys_counter"
+  CLOCK="/sys/devices/system/clocksource/clocksource0/current_clocksource"
 
-  if [ ! -e /dev/kvm ]; then
+  return 0
-    KVM_ERR="(device file missing)"
+}
-  else
+
-    if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
+checkClocksource() {
-      KVM_ERR="(no write access)"
+
-    else
+  local result
-      flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
+
-      if ! grep -qw "vmx\|svm" <<< "$flags"; then
+  if [ ! -f "$CLOCK" ]; then
-        KVM_ERR="(vmx/svm disabled)"
+    warn "file \"$CLOCK\" cannot be found?"
-      fi
+    return 0
-    fi
   fi
 
-  if [ -n "$KVM_ERR" ]; then
+  result=$(<"$CLOCK")
-    KVM="N"
+  result="${result//[![:print:]]/}"
-    error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
-    error "See the FAQ on how to enable it, or continue without KVM by setting KVM=N (not recommended)."
-    [[ "$DEBUG" != [Yy1]* ]] && exit 88
-  fi
 
-fi
+  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
 
-if [[ "$KVM" != [Nn]* ]]; then
+  return 0
+}
 
-  CPU_FEATURES="kvm=on,l3-cache=on"
+checkSse42() {
-  KVM_OPTS=",accel=kvm -enable-kvm -global kvm-pit.lost_tick_policy=discard"
 
   if ! grep -qw "sse4_2" <<< "$flags"; then
-    info "Your CPU does not have the SSE4 instruction set that Virtual DSM requires, it will be emulated..."
+    error "Your CPU does not have the SSE4 instruction set that Virtual DSM requires!"
-    [ -z "$CPU_MODEL" ] && CPU_MODEL="$DEF_MODEL"
+    ! enabled "$DEBUG" && exit 88
-    CPU_FEATURES="$CPU_FEATURES,+ssse3,+sse4.1,+sse4.2"
   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="$CPU_FEATURES,migratable=no"
+    CPU_FEATURES+=",migratable=no"
   fi
 
-else
+  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"
+  CPU_FEATURES="l3-cache=on,+hypervisor"
 
   if [[ "$ARCH" == "amd64" ]]; then
     KVM_OPTS=" -accel tcg,thread=multi"
   fi
 
-  if [ -z "$CPU_MODEL" ]; then
+  configureTcgCpuModel
-    if [[ "$ARCH" == "amd64" ]]; then
+  CPU_FEATURES+=",+ssse3,+sse4.1,+sse4.2"
-      CPU_MODEL="max"
+
-      CPU_FEATURES="$CPU_FEATURES,migratable=no"
+  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
-      CPU_MODEL="$DEF_MODEL"
+      HOST_CPU+=" $ARCH"
     fi
   fi
 
-  CPU_FEATURES="$CPU_FEATURES,+ssse3,+sse4.1,+sse4.2"
+  return 0
+}
 
-fi
+selectClocksource
+checkClocksource
 
-if [ -z "$CPU_FLAGS" ]; then
+flags=$(sed -ne '/^flags/s/^.*: //p' /proc/cpuinfo)
-  if [ -z "$CPU_FEATURES" ]; then
+
-    CPU_FLAGS="$CPU_MODEL"
+if ! disabled "$KVM"; then
-  else
+  configureKvm
-    CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES"
-  fi
 else
-  if [ -z "$CPU_FEATURES" ]; then
+  configureTcg
-    CPU_FLAGS="$CPU_MODEL,$CPU_FLAGS"
-  else
-    CPU_FLAGS="$CPU_MODEL,$CPU_FEATURES,$CPU_FLAGS"
-  fi
 fi
 
-if [ -z "$HOST_CPU" ]; then
+removeCpuArgument
-  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')
+composeCpuFlags
-fi
+configureHostCpuName
-
-if [ -n "$HOST_CPU" ]; then
-  HOST_CPU="${HOST_CPU%%,*},,"
-else
-  HOST_CPU="QEMU, Virtual CPU,"
-  if [ "$ARCH" == "amd64" ]; then
-    HOST_CPU="$HOST_CPU X86_64"
-  else
-    HOST_CPU="$HOST_CPU $ARCH"
-  fi
-fi
 
 return 0

src/progress.sh

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
+info="/run/shm/msg.html"
+
 escape () {
     local s
     s=${1//&/\&}
@@ -11,22 +13,33 @@ escape () {
     return 0
 }
 
-file="$1"
+path="$1"
-body=$(escape "$2")
+total="$2"
-info="/run/shm/msg.html"
+body=$(escape "$3")
 
 if [[ "$body" == *"..." ]]; then
-  body="<p class=\"loading\">${body/.../}</p>"
+  body="<p class=\"loading\">${body::-3}</p>"
 fi
 
 while true
 do
-  if [ -s "$file" ]; then
+
-    bytes=$(du -sb "$file" | cut -f1)
+  if [ ! -s "$path" ] && [ ! -d "$path" ]; then
-    if (( bytes > 1000 )); then
+    bytes="0"
-      size=$(echo "$bytes" | numfmt --to=iec --suffix=B  | sed -r 's/([A-Z])/ \1/')
+  else
-      echo "${body//(\[P\])/($size)}"> "$info"
+    bytes=$(du -sb "$path" 2>/dev/null | cut -f1) || bytes="0"
-    fi
   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,220 +1,289 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-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; }
-
 trap 'error "Status $? while: $BASH_COMMAND (line $LINENO/$BASH_LINENO)"' ERR
+enabled "${TRACE:-}" && set -o functrace && trap 'echo "# $BASH_COMMAND" >&2' DEBUG
 
-[ ! -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
 
-echo "❯ Starting $APP for Docker v$(</run/version)..."
-echo "❯ For support visit $SUPPORT"
-echo
-
 # Docker environment variables
 
-: "${TZ:=""}"             # System local timezone
+: "${TZ:=""}"              # System timezone
-: "${DEBUG:="N"}"         # Disable debugging mode
+: "${KVM:="Y"}"            # KVM acceleration
-: "${COUNTRY:=""}"        # Country code for mirror
+: "${DEBUG:="N"}"          # Disable debugging mode
-: "${CONSOLE:="N"}"       # Disable console mode
+: "${COUNTRY:=""}"         # Country code for mirror
-: "${ALLOCATE:=""}"       # 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// /-}"
 
-STORAGE="/storage"
+detectEngine
+
+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 Docker v$(</run/version)"
+FOOTER1="$APP for $ENGINE v$(</etc/version)"
 FOOTER2="<a href='$SUPPORT'>$SUPPORT</a>"
 
-HOST=$(hostname -s)
+SOCKETS=1
-KERNEL=$(uname -r | cut -b 1)
+CPU=$(cpu)
-MINOR=$(uname -r | cut -d '.' -f2)
+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 | awk '{ print $NF }')
+CORES=$(grep -c '^processor' /proc/cpuinfo)
-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')
 
-# Check system
+if grep -qi "socket(s)" <<< "$(lscpu)"; then
-
+  SOCKETS=$(lscpu | grep -m 1 -i 'socket(s)' | awk '{print $2}')
-if [ ! -d "/dev/shm" ]; then
+  [ -z "${SOCKETS##*[!0-9]*}" ] && SOCKETS=1
-  error "Directory /dev/shm not found!" && exit 14
+  [ "$SOCKETS" -lt "1" ] && SOCKETS=1
-else
-  [ ! -d "/run/shm" ] && ln -s /dev/shm /run/shm
 fi
 
-# Check folder
+normalizeCpuCores
+checkStorage
+checkFilesystem
+normalizeRamSize
 
-if [ ! -d "$STORAGE" ]; then
+# Print system info
-  error "Storage folder ($STORAGE) not found!" && exit 13
+SYS="${SYS/-generic/}"
-fi
+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 /run/shm/qemu.*
+rm -f "$QEMU_DIR"/dsm.url
-rm -f /run/shm/dsm.url
+rm -f "$QEMU_DIR"/qemu.* "$QEMU_DIR"/*.pid "$QEMU_DIR"/*.sock
 
 # Cleanup dirs
 rm -rf /tmp/dsm
 rm -rf "$STORAGE/tmp"
 
-# Helper functions
-
-isAlive() {
-  local pid=$1
-
-  if kill -0 "$pid" 2>/dev/null; then
-    return 0
-  fi
-
-  return 1
-}
-
-pKill() {
-  local pid=$1
-
-  { kill -15 "$pid" || true; } 2>/dev/null
-
-  while isAlive "$pid"; do
-    sleep 0.2
-  done
-
-  return 0
-}
-
-fWait() {
-  local name=$1
-
-  while pgrep -f -l "$name" >/dev/null; do
-    sleep 0.2
-  done
-
-  return 0
-}
-
-fKill() {
-  local name=$1
-
-  { pkill -f "$name" || true; } 2>/dev/null
-  fWait "$name"
-
-  return 0
-}
-
-escape () {
-    local s
-    s=${1//&/\&amp;}
-    s=${s//</\&lt;}
-    s=${s//>/\&gt;}
-    s=${s//'"'/\&quot;}
-    printf -- %s "$s"
-    return 0
-}
-
-html()
-{
-    local title
-    local body
-    local script
-    local footer
-
-    title=$(escape "$APP")
-    title="<title>$title</title>"
-    footer=$(escape "$FOOTER1")
-
-    body=$(escape "$1")
-    if [[ "$body" == *"..." ]]; then
-      body="<p class=\"loading\">${body/.../}</p>"
-    fi
-
-    [ -n "${2:-}" ] && script="$2" || script=""
-
-    local HTML
-    HTML=$(<"$TEMPLATE")
-    HTML="${HTML/\[1\]/$title}"
-    HTML="${HTML/\[2\]/$script}"
-    HTML="${HTML/\[3\]/$body}"
-    HTML="${HTML/\[4\]/$footer}"
-    HTML="${HTML/\[5\]/$FOOTER2}"
-
-    echo "$HTML" > "$PAGE"
-    echo "$body" > "$INFO"
-
-    return 0
-}
-
-getCountry() {
-  local url=$1
-  local query=$2
-  local rc json result
-
-  { 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.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
-}
-
-# Start webserver
-cp -r /var/www/* /run/shm
-html "Starting $APP for Docker..."
-nginx -e stderr
-
 return 0

src/serial.sh

@@ -5,11 +5,22 @@ set -Eeuo pipefail
 
 : "${HOST_MAC:=""}"
 : "${HOST_DEBUG:=""}"
-: "${HOST_SERIAL:=""}"
 : "${HOST_MODEL:=""}"
+: "${HOST_SERIAL:=""}"
 : "${GUEST_SERIAL:=""}"
 
-if [ -n "$HOST_MAC" ]; then
+# Sanitize variables
+HOST_MAC=$(strip "$HOST_MAC")
+HOST_MODEL=$(strip "$HOST_MODEL")
+HOST_SERIAL=$(strip "$HOST_SERIAL")
+GUEST_SERIAL=$(strip "$GUEST_SERIAL")
+
+validateHostMac() {
+  local m
+
+  if [ -z "$HOST_MAC" ]; then
+    return 0
+  fi
 
   HOST_MAC="${HOST_MAC//-/:}"
 
@@ -22,54 +33,77 @@ if [ -n "$HOST_MAC" ]; then
     error "Invalid HOST_MAC address: '$HOST_MAC', should be 12 or 17 digits long!" && exit 28
   fi
 
-fi
+  return 0
+}
 
-HOST_ARGS=()
+buildHostArguments() {
-HOST_ARGS+=("-cpu=$CPU_CORES")
-HOST_ARGS+=("-cpu_arch=$HOST_CPU")
 
-[ -n "$HOST_MAC" ] && HOST_ARGS+=("-mac=$HOST_MAC")
+  HOST_ARGS=()
-[ -n "$HOST_MODEL" ] && HOST_ARGS+=("-model=$HOST_MODEL")
+  HOST_ARGS+=("-cpu=$CPU_CORES")
-[ -n "$HOST_SERIAL" ] && HOST_ARGS+=("-hostsn=$HOST_SERIAL")
+  HOST_ARGS+=("-cpu_arch=$HOST_CPU")
-[ -n "$GUEST_SERIAL" ] && HOST_ARGS+=("-guestsn=$GUEST_SERIAL")
 
-if [[ "$HOST_DEBUG" == [Yy1]* ]]; then
+  [ -n "$HOST_MAC" ] && HOST_ARGS+=("-mac=$HOST_MAC")
-  set -x
+  [ -n "$HOST_MODEL" ] && HOST_ARGS+=("-model=$HOST_MODEL")
-  ./host.bin "${HOST_ARGS[@]}" &
+  [ -n "$HOST_SERIAL" ] && HOST_ARGS+=("-hostsn=$HOST_SERIAL")
-  { set +x; } 2>/dev/null
+  [ -n "$GUEST_SERIAL" ] && HOST_ARGS+=("-guestsn=$GUEST_SERIAL")
-  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
+startHostBinary() {
-  sleep 0.1
-  cnt=$((cnt + 1))
-  (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit 58
-done
 
-cnt=0
+  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
 
-while ! nc -z -w2 127.0.0.1 12345 > /dev/null 2>&1; do
+  return 0
-  sleep 0.1
+}
-  cnt=$((cnt + 1))
-  (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit 59
-done
 
-# Configure serial ports
+waitForPort() {
 
-if [[ "$CONSOLE" != [Yy]* ]]; then
+  local port="$1"
-  SERIAL_OPTS="-serial pty"
+  local exit_code="$2"
-else
+  local cnt=0
-  SERIAL_OPTS="-serial mon:stdio"
-fi
 
-SERIAL_OPTS="$SERIAL_OPTS \
+  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 socket,id=charchannel0,host=127.0.0.1,port=12345,reconnect=10 \
+        -chardev socket,id=charchannel0,host=127.0.0.1,port=$CHR_PORT,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

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+: "${COM_PORT:="2210"}"    # Comm port
+: "${WEB_PORT:="5000"}"    # Webserver port
+: "${CHR_PORT:="12345"}"   # Character port
+: "${WSD_PORT:="8004"}"    # Websockets port
+
+# Sanitize port variables
+COM_PORT=$(strip "$COM_PORT")
+WEB_PORT=$(strip "$WEB_PORT")
+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
+}
+
+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
+
+  return 0
+}
+
+configureIpv6Listen() {
+
+  # 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
+    sed -i "s/listen $WEB_PORT default_server;/listen [::]:$WEB_PORT default_server ipv6only=off;/g" /etc/nginx/sites-enabled/web.conf
+  fi
+
+  return 0
+}
+
+configureWebServer() {
+
+  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
+
+return 0

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

@@ -1,5 +1,4 @@
 server {
-    listen 80;
     listen 5000 default_server;
 
     autoindex on;
@@ -28,4 +27,18 @@ server {
       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/index.html

@@ -5,8 +5,8 @@
         [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="stylesheet" type="text/css" href="css/style.css" />
-        <link rel="icon" href="/img/favicon.svg" type="image/x-icon">
+        <link rel="icon" href="img/favicon.svg" type="image/x-icon">
         [2]
     </head>
 
@@ -28,7 +28,7 @@
                 [5]
             </footer>
         </div>
-        <script type="text/javascript" src="/js/script.js"></script>
+        <script type="text/javascript" src="js/script.js"></script>
     </body>
 
 </html>

web/js/script.js

@@ -1,16 +1,20 @@
 var request;
+var booting = false;
 var interval = 1000;
 
 function getInfo() {
 
-    var url = "/msg.html";
+    var url = "msg.html";
 
     try {
+        if (request) {
+            request.abort();
+        }
 
         if (window.XMLHttpRequest) {
             request = new XMLHttpRequest();
         } else {
-            throw "XMLHttpRequest not available!";
+            throw new Error("XMLHttpRequest not available!");
         }
 
         request.onreadystatechange = processInfo;
@@ -18,22 +22,49 @@ function getInfo() {
         request.send();
 
     } catch (e) {
-        var err = "Error: " + e.message;
+        setError("Error: " + e.message);
-        console.log(err);
-        setError(err);
     }
 }
 
+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) {
-            setInfo("Booting DSM instance", true);
+
-            schedule();
+            if (booting) {
+                schedule();
+                return true;
+            }
+
+            window.location.reload();
             return false;
         }
 
@@ -43,20 +74,11 @@ function processInfo() {
             if (msg.toLowerCase().indexOf("<html>") !== -1) {
                 notFound = true;
             } else {
-                if (msg.toLowerCase().indexOf("href=") !== -1) {
+                processMsg(msg);
-                    var div = document.createElement("div");
+                if (msg.toLowerCase().indexOf("href=") == -1) {
-                    div.innerHTML = msg;
-                    var url = div.querySelector("a").href;
-                    setTimeout(() => {
-                        window.location.assign(url);
-                    }, 3000);
-                    setInfo(msg);
-                    return true;
-                } else {
-                    setInfo(msg);
                     schedule();
-                    return true;
                 }
+                return true;
             }
         }
 
@@ -67,44 +89,60 @@ function processInfo() {
         }
 
         setError("Error: Received statuscode " + request.status);
-        schedule();
         return false;
 
     } catch (e) {
-        var err = "Error: " + e.message;
+        setError("Error: " + e.message);
-        console.log(err);
-        setError(err);
         return false;
     }
 }
 
-function setInfo(msg, loading, error) {
+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;
         }
 
-        var el = document.getElementById("spinner");
+        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) {
-            el.style.visibility = 'visible';
+            spin.style.visibility = 'visible';
         } else {
-            el.style.visibility = 'hidden';
+            spin.style.visibility = 'hidden';
         }
 
+        var p = "<p class=\"loading\">";
         loading = !!loading;
         if (loading) {
-            msg = "<p class=\"loading\">" + msg + "</p>";
+            msg = p + msg + "</p>";
         }
 
-        el = document.getElementById("info");
+        if (msg.includes(p)) {
-
+            if (el.innerHTML.includes(p)) {
-        if (el.innerHTML != msg) {
+                el.getElementsByClassName('loading')[0].textContent = extractContent(msg);
-            el.innerHTML = msg;
+                return true;
+            }
         }
 
+        el.innerHTML = msg;
         return true;
 
     } catch (e) {
@@ -114,6 +152,7 @@ function setInfo(msg, loading, error) {
 }
 
 function setError(text) {
+    console.warn(text);
     return setInfo(text, false, true);
 }
 
@@ -123,8 +162,47 @@ function schedule() {
 
 function reload() {
     setTimeout(() => {
-        document.location.reload();
+        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();