feat: Generate unique MAC address (#611)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.github/workflows/build.yml

@@ -8,6 +8,10 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.yml'
+      - '**/*.js'
+      - '**/*.css'
+      - '**/*.html'
+      - 'web/**'
       - '.gitignore'
       - '.dockerignore'
       - '.github/**'

.github/workflows/check.yml

@@ -7,8 +7,18 @@ jobs:
     name: shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - 
-      - name: Run ShellCheck
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master
         env:
           SHELLCHECK_OPTS: -x --source-path=src -e SC2001 -e SC2034 -e SC2064 -e SC2317 -e SC2153 -e SC2028
+      - 
+        name: Lint Dockerfile
+        uses: hadolint/hadolint-action@v3.1.0
+        with:
+          dockerfile: Dockerfile
+          ignore: DL3008,DL3003,DL3006
+          failure-threshold: warning

.github/workflows/hub.yml

@@ -15,7 +15,7 @@ jobs:
     - uses: actions/checkout@v4
     - 
       name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v3
+      uses: peter-evans/dockerhub-description@v4
       with:
         username: ${{ secrets.DOCKERHUB_USERNAME }}
         password: ${{ secrets.DOCKERHUB_TOKEN }}

.github/workflows/test.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     paths:
       - '**/*.sh'
+      - 'Dockerfile'
       - '.github/workflows/test.yml'
       - '.github/workflows/check.yml'
 

readme.md

@@ -17,7 +17,6 @@ Virtual DSM in a docker container.
 
  - Multiple disks
  - KVM acceleration
- - GPU pass-through
  - Upgrades supported
  
 ## Usage
@@ -56,13 +55,11 @@ docker run -it --rm -p 5000:5000 --device=/dev/kvm --cap-add NET_ADMIN --stop-ti
 
   Very simple! These are the steps:
   
-    - Start the container and get some coffee.
+  - Start the container and connect to [port 5000](http://localhost:5000) using your web browser.
-
-    - Connect to [port 5000](http://localhost:5000) of the container in your web browser.
 
   - Wait until DSM is ready, choose an username and password, and you will be taken to the desktop.
   
-    - Enjoy your brand new machine, and don't forget to star this repo!
+  Enjoy your brand new machine, and don't forget to star this repo!
 
 * ### How do I change the size of the disk?
 

src/disk.sh

@@ -113,7 +113,7 @@ createDisk() {
   fi
 
   html "Creating a $DISK_DESC image..."
-  info "Creating a $DISK_TYPE $DISK_DESC image in $DISK_FMT format with a size of $DISK_SPACE..."
+  info "Creating a $DISK_SPACE $DISK_TYPE $DISK_DESC image in $DISK_FMT format..."
 
   local FAIL="Could not create a $DISK_TYPE $DISK_FMT $DISK_DESC image of $DISK_SPACE ($DISK_FILE)"
 

src/display.sh

@@ -15,7 +15,9 @@ if [[ "$GPU" != [Yy1]* ]] || [[ "$ARCH" != "amd64" ]]; then
 
 fi
 
-DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128 -vga $VGA"
+[[ "${VGA,,}" == "virtio" ]] && VGA="virtio-vga"
+DISPLAY_OPTS="-display egl-headless,rendernode=/dev/dri/renderD128"
+DISPLAY_OPTS="$DISPLAY_OPTS -vga none -device $VGA"
 
 [ ! -d /dev/dri ] && mkdir -m 755 /dev/dri
 

src/install.sh

@@ -105,6 +105,7 @@ RDC="$STORAGE/dsm.rd"
 if [ ! -f "$RDC" ]; then
 
   MSG="Downloading installer..."
+  PRG="Downloading installer ([P])..."
   info "Install: $MSG" && html "$MSG"
 
   RD="$TMP/rd.gz"
@@ -112,7 +113,11 @@ if [ ! -f "$RDC" ]; then
   VERIFY="b4215a4b213ff5154db0488f92c87864"
   LOC="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
 
+  rm -f "$RD"
+  /run/progress.sh "$RD" "$PRG" &
   { curl -r "$POS" -sfk -S -o "$RD" "$LOC"; rc=$?; } || :
+
+  fKill "progress.sh"
   (( rc != 0 )) && error "Failed to download $LOC, reason: $rc" && exit 60
 
   SUM=$(md5sum "$RD" | cut -f 1 -d " ")
@@ -123,7 +128,11 @@ if [ ! -f "$RDC" ]; then
     rm "$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")"
@@ -175,7 +184,10 @@ fi
 rm -rf "$TMP" && mkdir -p "$TMP"
 
 info "Install: Downloading $BASE.pat..."
-html "Install: Downloading DSM from Synology..."
+
+MSG="Downloading DSM..."
+PRG="Downloading DSM ([P])..."
+html "$MSG"
 
 PAT="/$BASE.pat"
 rm -f "$PAT"
@@ -186,7 +198,11 @@ if [[ "$URL" == "file://"* ]]; then
 
 else
 
+  /run/progress.sh "$PAT" "$PRG" &
+
   { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+
+  fKill "progress.sh"
   (( rc != 0 )) && error "Failed to download $URL , reason: $rc" && exit 69
 
 fi

src/network.sh

@@ -3,8 +3,8 @@ set -Eeuo pipefail
 
 # Docker environment variables
 
+: "${MAC:=""}"
 : "${DHCP:="N"}"
-: "${MAC:="02:11:32:AA:BB:CC"}"
 
 : "${VM_NET_DEV:=""}"
 : "${VM_NET_TAP:="dsm"}"
@@ -33,7 +33,7 @@ configureDHCP() {
   fi
 
   while ! ip link set "$VM_NET_TAP" up; do
-    info "Waiting for address to become available..."
+    info "Waiting for MAC address $VM_NET_MAC to become available..."
     sleep 2
   done
 
@@ -83,7 +83,9 @@ configureDNS() {
   DNSMASQ_OPTS=$(echo "$DNSMASQ_OPTS" | sed 's/\t/ /g' | tr -s ' ' | sed 's/^ *//')
 
   [[ "$DEBUG" == [Yy1]* ]] && set -x
-  $DNSMASQ ${DNSMASQ_OPTS:+ $DNSMASQ_OPTS}
+  if ! $DNSMASQ ${DNSMASQ_OPTS:+ $DNSMASQ_OPTS}; then
+    error "Failed to start dnsmasq, reason: $?" && exit 29
+  fi
   { set +x; } 2>/dev/null
   [[ "$DEBUG" == [Yy1]* ]] && echo
 
@@ -126,7 +128,7 @@ configureNAT() {
   ip address add ${VM_NET_IP%.*}.1/24 broadcast ${VM_NET_IP%.*}.255 dev dockerbridge
 
   while ! ip link set dockerbridge up; do
-    info "Waiting for address to become available..."
+    info "Waiting for IP address to become available..."
     sleep 2
   done
 
@@ -134,7 +136,7 @@ configureNAT() {
   ip tuntap add dev "$VM_NET_TAP" mode tap
 
   while ! ip link set "$VM_NET_TAP" up promisc on; do
-    info "Waiting for tap to become available..."
+    info "Waiting for TAP to become available..."
     sleep 2
   done
 
@@ -209,14 +211,20 @@ getInfo() {
     error "$ADD_ERR -e \"VM_NET_DEV=NAME\" to specify another interface name." && exit 27
   fi
 
-  VM_NET_MAC="${VM_NET_MAC//-/:}"
+  if [ -z "$VM_NET_MAC" ]; then
+    # Generate MAC address based on Docker container ID in hostname
+    VM_NET_MAC=$(echo "$HOST" | md5sum | sed 's/^\(..\)\(..\)\(..\)\(..\)\(..\).*$/02:11:32:\3:\4:\5/')
+  fi
+
+  VM_NET_MAC="${VM_NET_MAC,,//-/:}"
+
   if [[ ${#VM_NET_MAC} == 12 ]]; then
     m="$VM_NET_MAC"
     VM_NET_MAC="${m:0:2}:${m:2:2}:${m:4:2}:${m:6:2}:${m:8:2}:${m:10:2}"
   fi
 
   if [[ ${#VM_NET_MAC} != 17 ]]; then
-    error "Invalid mac address: '$VM_NET_MAC', should be 12 or 17 digits long!" && exit 28
+    error "Invalid MAC address: '$VM_NET_MAC', should be 12 or 17 digits long!" && exit 28
   fi
 
   GATEWAY=$(ip r | grep default | awk '{print $3}')
@@ -240,16 +248,16 @@ getInfo
 html "Initializing network..."
 
 if [[ "$DEBUG" == [Yy1]* ]]; then
-  info "Container IP is $IP with gateway $GATEWAY on interface $VM_NET_DEV" && echo
+  info "Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC"
+  [ -f /etc/resolv.conf ] && cat /etc/resolv.conf 
+  echo
 fi
 
 if [[ "$DHCP" == [Yy1]* ]]; then
 
-  if [[ "$GATEWAY" == "172."* ]]; then
+  if [[ "$GATEWAY" == "172."* ]] && [[ "$DEBUG" != [Yy1]* ]]; then
-    if [[ "$DEBUG" != [Yy1]* ]]; then
     error "You can only enable DHCP while the container is on a macvlan network!" && exit 26
   fi
-  fi
 
   # Configuration for DHCP IP
   configureDHCP

src/progress.sh

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

src/reset.sh

@@ -35,6 +35,7 @@ TEMPLATE="/var/www/index.html"
 FOOTER1="$APP for Docker v$(</run/version)"
 FOOTER2="<a href='$SUPPORT'>$SUPPORT</a>"
 
+HOST=$(hostname -s)
 KERNEL=$(uname -r | cut -b 1)
 MINOR=$(uname -r | cut -d '.' -f2)
 ARCH=$(dpkg --print-architecture)

src/serial.sh

@@ -9,6 +9,21 @@ set -Eeuo pipefail
 : "${HOST_MODEL:=""}"
 : "${GUEST_SERIAL:=""}"
 
+if [ -n "$HOST_MAC" ]; then
+
+  HOST_MAC="${HOST_MAC//-/:}"
+
+  if [[ ${#HOST_MAC} == 12 ]]; then
+    m="$HOST_MAC"
+    HOST_MAC="${m:0:2}:${m:2:2}:${m:4:2}:${m:6:2}:${m:8:2}:${m:10:2}"
+  fi
+
+  if [[ ${#HOST_MAC} != 17 ]]; then
+    error "Invalid HOST_MAC address: '$HOST_MAC', should be 12 or 17 digits long!" && exit 28
+  fi
+
+fi
+
 HOST_ARGS=()
 HOST_ARGS+=("-cpu=$CPU_CORES")
 HOST_ARGS+=("-cpu_arch=$HOST_CPU")

web/css/style.css

@@ -1,7 +1,14 @@
 body {
 	color: white;
 	background-color: #125bdb;
-	font-family: Verdana, Arial, sans-serif;
+	font-smoothing: antialiased;
+	-webkit-font-smoothing: antialiased;
+	-moz-osx-font-smoothing: grayscale;
+	font-family: Verdana, Geneva, sans-serif;
+}
+
+#info {
+	text-shadow: 1px 1px 1px rgba(0, 0, 0, 0.25);
 }
 
 #content {
@@ -17,6 +24,7 @@ footer {
 	height: 40px;
 	text-align: center;
 	color: #0c8aeb;
+	text-shadow: 0 0 1px #0c8aeb;
 }
 
 #empty {
@@ -33,8 +41,13 @@ a:visited {
 
 footer a:link,
 footer a:visited,
-footer a:active { color: #0c8aeb; }
+footer a:active {
-footer a:hover { color: #73e6ff; }
+	color: #0c8aeb;
+}
+
+footer a:hover {
+	color: #73e6ff;
+}
 
 .loading:after {
 	content: " .";