docs: Add input types (#245)

.github/ISSUE_TEMPLATE/1-issue.yml

@@ -21,6 +21,7 @@ body:
     attributes:
       label: Docker compose
       description: The compose file (or otherwise the `docker run` command used).
+      render: yaml
     validations:
       required: true
   - type: textarea
@@ -28,6 +29,7 @@ body:
     attributes:
       label: Docker log
       description: The logfile of the container (as shown by `docker logs qemu`).
+      render: shell
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/3-bug.yml

@@ -23,6 +23,7 @@ body:
     attributes:
       label: Docker compose
       description: The compose file (or otherwise the `docker run` command used).
+      render: yaml
     validations:
       required: true
   - type: textarea
@@ -30,6 +31,7 @@ body:
     attributes:
       label: Docker log
       description: The logfile of the container (as shown by `docker logs qemu`).
+      render: shell
     validations:
       required: true
   - type: textarea

.github/workflows/build.yml

@@ -46,8 +46,8 @@ jobs:
         with:
           context: git
           images: |
-            ${{ secrets.DOCKERHUB_REPO }}
             ghcr.io/${{ github.repository }}
+            ${{ secrets.DOCKERHUB_REPO }}
           tags: |
             type=raw,value=latest,priority=100
             type=raw,value=${{ vars.MAJOR }}.${{ vars.MINOR }}

Dockerfile

@@ -19,6 +19,7 @@ RUN set -eu && \
         wget \
         7zip \
         curl \
+        fdisk \
         nginx \
         procps \
         seabios \
@@ -33,12 +34,11 @@ RUN set -eu && \
         iputils-ping \
         genisoimage \
         ca-certificates \
-        netcat-openbsd \
         qemu-system-arm && \
     apt-get clean && \
     mkdir -p /etc/qemu && \
     echo "allow br0" > /etc/qemu/bridge.conf && \
-    wget "https://kali.download/kali/pool/main/e/edk2/qemu-efi-aarch64_2024.11-5_all.deb" -O /tmp/aavmf.deb -q --timeout=10 && \
+    wget "https://snapshot.debian.org/archive/debian/20250128T092032Z/pool/main/e/edk2/qemu-efi-aarch64_2024.11-5_all.deb" -O /tmp/aavmf.deb -q --timeout=10 && \
     dpkg -i /tmp/aavmf.deb && \
     mkdir -p /usr/share/novnc && \
     wget "https://github.com/novnc/noVNC/archive/refs/tags/v${VERSION_VNC}.tar.gz" -O /tmp/novnc.tar.gz -q --timeout=10 && \

readme.md

@@ -49,7 +49,7 @@ services:
 ##### Via Docker CLI:
 
 ```bash
-docker run -it --rm --name qemu -e "BOOT=alpine" -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v ${PWD:-.}/qemu:/storage --stop-timeout 120 qemux/qemu-arm
+docker run -it --rm --name qemu -e "BOOT=alpine" -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/qemu:/storage" --stop-timeout 120 qemux/qemu-arm
 ```
 
 ##### Via Kubernetes:

src/config.sh

@@ -12,7 +12,6 @@ SERIAL_OPTS="-serial $SERIAL"
 CPU_OPTS="-cpu $CPU_FLAGS -smp $SMP"
 RAM_OPTS=$(echo "-m ${RAM_SIZE^^}" | sed 's/MB/M/g;s/GB/G/g;s/TB/T/g')
 MON_OPTS="-monitor $MONITOR -name $PROCESS,process=$PROCESS,debug-threads=on"
-[ -n "$USB" ] && [[ "${USB,,}" != "no"* ]] && USB_OPTS="-device $USB -device usb-kbd -device usb-tablet"
 MAC_OPTS="-machine type=${MACHINE},secure=${SECURE},dump-guest-core=off${KVM_OPTS}"
 
 [ -n "$UUID" ] && MAC_OPTS+=" -uuid $UUID"
@@ -23,11 +22,14 @@ DEV_OPTS+=" -device virtio-rng-pci,rng=objrng0,id=rng0,bus=pcie.0"
 
 if [[ "${BOOT_MODE,,}" != "windows"* ]]; then
   DEV_OPTS+=" -device virtio-balloon-pci,id=balloon0,bus=pcie.0"
-  if [ -d "/shared" ]; then
+fi
+
+if [ -d "/shared" ] && [[ "${BOOT_MODE,,}" != "windows"* ]]; then
   DEV_OPTS+=" -fsdev local,id=fsdev0,path=/shared,security_model=none"
   DEV_OPTS+=" -device virtio-9p-pci,id=fs0,fsdev=fsdev0,mount_tag=shared"
 fi
-fi
+
+[ -n "$USB" ] && [[ "${USB,,}" != "no"* ]] && USB_OPTS="-device $USB -device usb-kbd -device usb-tablet"
 
 ARGS="$DEF_OPTS $CPU_OPTS $RAM_OPTS $MAC_OPTS $DISPLAY_OPTS $MON_OPTS $SERIAL_OPTS ${USB_OPTS:-} $NET_OPTS $DISK_OPTS $BOOT_OPTS $DEV_OPTS $ARGUMENTS"
 ARGS=$(echo "$ARGS" | sed 's/\t/ /g' | tr -s ' ')

src/proc.sh

@@ -34,10 +34,10 @@ if [[ "$KVM" != [Nn]* ]]; then
   KVM_ERR=""
 
   if [ ! -e /dev/kvm ]; then
-    KVM_ERR="(device file missing)"
+    KVM_ERR="(/dev/kvm is missing)"
   else
     if ! sh -c 'echo -n > /dev/kvm' &> /dev/null; then
-      KVM_ERR="(no write access)"
+      KVM_ERR="(/dev/kvm is unwriteable)"
     fi
   fi
 
@@ -46,8 +46,16 @@ if [[ "$KVM" != [Nn]* ]]; then
     if [[ "$OSTYPE" =~ ^darwin ]]; then
       warn "you are using macOS which has no KVM support, this will cause a major loss of performance."
     else      
-      error "KVM acceleration not available $KVM_ERR, this will cause a major loss of performance."
+      kernel=$(uname -a)
-      error "See the FAQ on how to diagnose the cause, or continue without KVM by setting KVM=N (not recommended)."
+      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 a major loss of performance."
+          error "See the FAQ for possible causes, or continue without it by adding KVM: \"N\" (not recommended)." ;;
+      esac
       [[ "$DEBUG" != [Yy1]* ]] && exit 88
     fi
   fi