Merge branch 'master' into glibc-revert-wip

.github/ISSUE_TEMPLATE/issue-running-docker-osx.md

@@ -0,0 +1,26 @@
+---
+name: Issue Running Docker-OSX
+about: OS related issued, please help us identify the issue by posting the output
+  of this
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# OS related issued, please help us identify the issue by posting the output of this
+uname -a \
+; echo "${DISPLAY}" \
+; echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs \
+; grep NAME /etc/os-release \
+; df -h . \
+; qemu-system-x86_64 --version \
+; libvirtd --version \
+; free -mh \
+; nproc \
+; egrep -c '(svm|vmx)' /proc/cpuinfo \
+; ls -lha /dev/kvm \
+; ls -lha /tmp/.X11-unix/ \
+; ps aux | grep dockerd \
+; docker ps | grep osx \
+; grep "docker\|kvm\|virt" /etc/group

.github/ISSUE_TEMPLATE/open-an-issue.md

@@ -0,0 +1,10 @@
+---
+name: Open an Issue
+about: About anything!
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "osx-serial-generator"]
+	path = osx-serial-generator
+	url = https://github.com/sickcodes/osx-serial-generator.git

CHANGELOG.md

@@ -1,5 +1,14 @@
 |Version|Date|Notes|
 |---|---|---|
+|   |2021-04-18|Add LIBGUESTFS debug & trace commands, exit on fail when creating bootdisks. Silence touch errors.| 
+|4.3|2021-03-24|Enable interactive QEMU again. Remove envsubst since we are already using bash... Add set -x flag| 
+|4.2|2021-03-24|Add all ENV variables to each dockerfile for readability. Add RAM allocation buffer and cache drop bug fix. Add kvm and libvirt groups. Add `IMAGE_FORMAT=qcow2` to allow `IMAGE_FORMAT=raw` too.|
+|   |2021-03-19|Use RAM=3 as the default RAM allocation. Add instructions to clear buff/cache.|
+|   |2021-03-17|Add RAM=max and RAM=half to dynamically select ram at runtime (DEFAULT).|
+|   |2021-03-06|Change envs to require --envs. Automatically enable --envs if --output-env is used. Same for plists, bootdisks. Fix help ugliness and sanity of generate serial scripts. Fix bootdisk not getting written to persistent file when using NOPICKER=true. NOPICKER=true is overridden by a custom plist now anyway. Remove useless case statements. Allow -e HEADLESS=true as human readable alternative to -e DISPLAY=:99.|
+|4.1|2021-03-04|Add `-e MASTER_PLIST_URL` to all images to allow using your own remote plist.|
+|   |2021-03-03|Add `WIDTH` and `HEIGHT` to set the x and y resolutions, use in conjuction with serial numbers.|
+|   |2021-03-02|Add ADDITIONAL_PORTS, for example `-e ADDITIONAL_PORTS='hostfwd=tcp::23-:23,'`|
 |4.0|2021-02-27|Add big-sur support. Use `sickcodes/docker-osx:big-sur` or build using `--build-arg VERSION=11`|
 |   |2021-02-26|Change `-e NOPICKER=true` to simply do `sed -i '/^.*InstallMedia.*/d' Launch.sh` and `export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2`.|
 |3.2|2021-02-25|Add a script to generate unique machine serial numbers. Add a script to generate a bootdisk from given serial numbers. Add Linux for libguestfs which allows the docker container to make QEMU bootdisks with specific serial numbers.|

CREDITS.md

@@ -1,8 +1,16 @@
 # Credits
 
-The upstream credits are available at [@Kholia](https://github.com/Kholia)'s repo https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md
+## Upstream Acknowledgements:
 
-These credits refer to the contributors to this repository:
+This project uses OSX-KVM from https://github.com/kholia/OSX-KVM and fully appreciates the work done by [@Kholia](https://github.com/Kholia) and all the contributors who are listed: [https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md](https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md)
+
+This project also uses KVM-OpenCore from https://github.com/Leoyzen/KVM-Opencore and fully appreciates the work done by [@Leoyzen](https://github.com/Leoyzen).
+
+We use a special fork by [Nicholas Sherlock](https://www.nicksherlock.com/) of KVM-Opencore https://github.com/thenickdude/KVM-Opencore and thank Nick for his awesome upstream work!
+
+This project now uses the fantastic OpenCore bootloader from the community OpenCore project: https://github.com/acidanthera/OpenCorePkg. You can join their [Subreddit here](https://www.reddit.com/r/hackintosh/)!
+
+## These credits refer to the contributors to this repository:
 
 [@GreeFine](https://github.com/GreeFine) - Readme Typo #9 
 
@@ -56,3 +64,18 @@ These credits refer to the contributors to this repository:
 
 [@MrBenFTW](https://github.com/MrBenFTW) - Tempfix for arch #150
 
+[@edsonboldrini](https://github.com/edsonboldrini) - Update README.md #161
+
+[@TheHackerCoding](https://github.com/TheHackerCoding) - Typo in README.md #194
+
+[@panos](https://github.com/panos) -  Improved README #212 
+
+[@ggjulio](https://github.com/ggjulio) - Restarting an "auto" container #216
+
+[@panos](https://github.com/panos) - Made further improvements to the README #219
+
+[@a10kiloham](https://github.com/a10kiloham) - Dockerfile for :naked image with VNC support #245 
+
+[@a10kiloham](https://github.com/a10kiloham) - Adding Bluebubbles as an example use case #250 
+
+[@aronzvi](https://github.com/aronzvi) - Fixed Failed to boot OSX with GENERATE_UNIQUE #244

Dockerfile

@@ -5,11 +5,12 @@
 #  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |
 # /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_|
 #
-# Repo:             https://github.com/sickcodes/Docker-OSX/
+# Title:            Docker-OSX (Mac on Docker)
-# Title:            Mac on Docker (Docker-OSX)
+# Author:           Sick.Codes https://twitter.com/sickcodes
-# Author:           Sick.Codes https://sick.codes/
+# Version:          4.3
-# Version:          4.0
 # License:          GPLv3+
+# Repository:       https://github.com/sickcodes/Docker-OSX
+# Website:          https://sick.codes
 #
 # All credits for OSX-KVM and the rest at @Kholia's repo: https://github.com/kholia/osx-kvm
 # OpenCore support go to https://github.com/Leoyzen/KVM-Opencore
@@ -113,7 +114,7 @@ RUN tee -a sshd_config <<< 'AllowTcpForwarding yes' \
 USER arch
 
 # download OSX-KVM
-RUN git clone --depth 1 https://github.com/kholia/OSX-KVM.git /home/arch/OSX-KVM
+RUN git clone --recurse-submodules --depth 1 https://github.com/kholia/OSX-KVM.git /home/arch/OSX-KVM
 
 # enable ssh
 # docker exec .... ./enable-ssh.sh
@@ -146,6 +147,8 @@ RUN yes | sudo pacman -Syu qemu libvirt dnsmasq virt-manager bridge-utils openre
 
 WORKDIR /home/arch/OSX-KVM
 
+RUN wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/fetch-macOS.py
+
 RUN [[ "${VERSION%%.*}" -lt 11 ]] && { python fetch-macOS.py --version "${VERSION}" \
         && qemu-img convert BaseSystem.dmg -O qcow2 -p -c BaseSystem.img \
         && qemu-img create -f qcow2 mac_hdd_ng.img "${SIZE}" \
@@ -164,9 +167,6 @@ RUN [[ "${VERSION%%.*}" -ge 11 ]] && { wget "${FETCH_MAC_OS_RAW}" \
         && rm -f BaseSystem.dmg \
     ; } || true
 
-# > Launch.sh
-# > Docker-OSX.xml
-
 WORKDIR /home/arch/OSX-KVM
 
 ARG LINUX=true
@@ -176,20 +176,30 @@ RUN if [[ "${LINUX}" == true ]]; then \
         sudo pacman -Syu linux libguestfs --noconfirm \
     ; fi
 
+# TEMP-FIX for file 5.40 libguestfs issue
+RUN yes | sudo pacman -U https://archive.archlinux.org/packages/f/file/file-5.39-1-x86_64.pkg.tar.zst \
+    && patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for file 5.40 libguestfs issue
+
 # optional --build-arg to change branches for testing
 ARG BRANCH=master
 ARG REPO='https://github.com/sickcodes/Docker-OSX.git'
-RUN git clone --branch "${BRANCH}" "${REPO}"
+RUN git clone --recurse-submodules --depth 1 --branch "${BRANCH}" "${REPO}"
 
 RUN touch Launch.sh \
     && chmod +x ./Launch.sh \
-    && tee -a Launch.sh <<< '#!/bin/sh' \
+    && tee -a Launch.sh <<< '#!/bin/bash' \
-    && tee -a Launch.sh <<< 'set -eu' \
+    && tee -a Launch.sh <<< 'set -eux' \
     && tee -a Launch.sh <<< 'sudo chown    $(id -u):$(id -g) /dev/kvm 2>/dev/null || true' \
     && tee -a Launch.sh <<< 'sudo chown -R $(id -u):$(id -g) /dev/snd 2>/dev/null || true' \
-    && tee -a Launch.sh <<< 'exec qemu-system-x86_64 -m ${RAM:-8}000 \' \
+    && tee -a Launch.sh <<< '[[ "${RAM}" = max ]] && export RAM="$(("$(head -n1 /proc/meminfo | tr -dc "[:digit:]") / 1000000"))"' \
+    && tee -a Launch.sh <<< '[[ "${RAM}" = half ]] && export RAM="$(("$(head -n1 /proc/meminfo | tr -dc "[:digit:]") / 2000000"))"' \
+    && tee -a Launch.sh <<< 'sudo chown -R $(id -u):$(id -g) /dev/snd 2>/dev/null || true' \
+    && tee -a Launch.sh <<< 'exec qemu-system-x86_64 -m ${RAM:-2}000 \' \
     && tee -a Launch.sh <<< '-cpu Penryn,vendor=GenuineIntel,+invtsc,vmware-cpuid-freq=on,+pcid,+ssse3,+sse4.2,+popcnt,+avx,+aes,+xsave,+xsaveopt,check \' \
-    && tee -a Launch.sh <<< '-machine q35,accel=kvm:tcg \' \
+    && tee -a Launch.sh <<< '-machine q35,${KVM-"accel=kvm:tcg"} \' \
     && tee -a Launch.sh <<< '-smp ${CPU_STRING:-${SMP:-4},cores=${CORES:-4}} \' \
     && tee -a Launch.sh <<< '-usb -device usb-kbd -device usb-tablet \' \
     && tee -a Launch.sh <<< '-device isa-applesmc,osk=ourhardworkbythesewordsguardedpleasedontsteal\(c\)AppleComputerInc \' \
@@ -202,10 +212,10 @@ RUN touch Launch.sh \
     && tee -a Launch.sh <<< '-device ide-hd,bus=sata.2,drive=OpenCoreBoot \' \
     && tee -a Launch.sh <<< '-device ide-hd,bus=sata.3,drive=InstallMedia \' \
     && tee -a Launch.sh <<< '-drive id=InstallMedia,if=none,file=/home/arch/OSX-KVM/BaseSystem.img,format=qcow2 \' \
-    && tee -a Launch.sh <<< '-drive id=MacHDD,if=none,file=${IMAGE_PATH:-/home/arch/OSX-KVM/mac_hdd_ng.img},format=qcow2 \' \
+    && tee -a Launch.sh <<< '-drive id=MacHDD,if=none,file=${IMAGE_PATH:-/home/arch/OSX-KVM/mac_hdd_ng.img},format=${IMAGE_FORMAT:-qcow2} \' \
     && tee -a Launch.sh <<< '-device ide-hd,bus=sata.4,drive=MacHDD \' \
-    && tee -a Launch.sh <<< '-netdev user,id=net0,hostfwd=tcp::${INTERNAL_SSH_PORT:-10022}-:22,hostfwd=tcp::${SCREEN_SHARE_PORT:-5900}-:5900, \' \
+    && tee -a Launch.sh <<< '-netdev user,id=net0,hostfwd=tcp::${INTERNAL_SSH_PORT:-10022}-:22,hostfwd=tcp::${SCREEN_SHARE_PORT:-5900}-:5900,${ADDITIONAL_PORTS} \' \
-    && tee -a Launch.sh <<< '-device ${NETWORKING:-e1000-82545em},netdev=net0,id=net0,mac=${MAC_ADDRESS:-52:54:00:09:49:17} \' \
+    && tee -a Launch.sh <<< '-device ${NETWORKING:-vmxnet3},netdev=net0,id=net0,mac=${MAC_ADDRESS:-52:54:00:09:49:17} \' \
     && tee -a Launch.sh <<< '-monitor stdio \' \
     && tee -a Launch.sh <<< '-vga vmware \' \
     && tee -a Launch.sh <<< '${EXTRA:-}'
@@ -221,21 +231,50 @@ USER arch
 
 ENV USER arch
 
-ENV BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2
+#### SPECIAL RUNTIME ARGUMENTS BELOW
+
+# env -e ADDITIONAL_PORTS with a comma
+# for example, -e ADDITIONAL_PORTS=hostfwd=tcp::23-:23,
+ENV ADDITIONAL_PORTS=
+
+ENV BOOTDISK=
 
 ENV DISPLAY=:0.0
 
 ENV ENV=/env
 
+# Boolean for generating a bootdisk with new random serials.
+ENV GENERATE_UNIQUE=false
+
+# Boolean for generating a bootdisk with specific serials.
+ENV GENERATE_SPECIFIC=false
+
 ENV IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img
+ENV IMAGE_FORMAT=qcow2
 
-ENV NETWORKING=e1000-82545em
+ENV KVM='accel=kvm:tcg'
-# ENV NETWORKING=vmxnet3
 
+ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-nopicker-custom.plist"
+
+# ENV NETWORKING=e1000-82545em
+ENV NETWORKING=vmxnet3
+
+# boolean for skipping the disk selection menu at in the boot process
 ENV NOPICKER=false
 
-ENV UNIQUE=false
+# dynamic RAM options for runtime
-# Boolean for generating a bootdisk with new serials.
+ENV RAM=3
+# ENV RAM=max
+# ENV RAM=half
+
+# The x and y coordinates for resolution.
+# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true.
+ENV WIDTH=1920
+ENV HEIGHT=1080
+
+# libguestfs verbose
+ENV LIBGUESTFS_DEBUG=1
+ENV LIBGUESTFS_TRACE=1
 
 VOLUME ["/tmp/.X11-unix"]
 
@@ -258,42 +297,38 @@ VOLUME ["/tmp/.X11-unix"]
 # the default serial numbers are already contained in ./OpenCore-Catalina/OpenCore.qcow2
 # And the default serial numbers
 
-CMD sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \
+CMD sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \
-    ; case "$(file --brief /image)" in \
+    ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \
-        QEMU\ QCOW2\ Image* ) export IMAGE_PATH=/image \
-            ;; \
-        directory* ) export IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img \
-            ;; \
-    esac \
     ; [[ "${NOPICKER}" == true ]] && { \
         sed -i '/^.*InstallMedia.*/d' Launch.sh \
-        && export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 \
+        && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \
     ; } \
+    || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
     ; [[ "${GENERATE_UNIQUE}" == true ]] && { \
-        ./Docker-OSX/custom/generate-unique-machine-values.sh \
+        ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
             --count 1 \
             --tsv ./serial.tsv \
             --bootdisks \
-        --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+            --width "${WIDTH:-1920}" \
-        --output-env "${ENV:=/env}" || exit 1 \
+            --height "${HEIGHT:-1080}" \
-    ; } \
+            --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+            --output-env "${ENV:=/env}" \
+    || exit 1 ; } \
     ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \
-            source "${ENV:=/env}" \
+            source "${ENV:=/env}" 2>/dev/null \
-            || ./Docker-OSX/custom/generate-specific-bootdisk.sh \
+            ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
             --model "${DEVICE_MODEL}" \
             --serial "${SERIAL}" \
             --board-serial "${BOARD_SERIAL}" \
             --uuid "${UUID}" \
             --mac-address "${MAC_ADDRESS}" \
-            --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" || exit 1 \
+            --width "${WIDTH:-1920}" \
-    ; } \
+            --height "${HEIGHT:-1080}" \
-    ; case "$(file --brief /bootdisk)" in \
+            --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
-        QEMU\ QCOW2\ Image* ) export BOOTDISK=/bootdisk \
+    || exit 1 ; } \
-            ;; \
+    ; ./enable-ssh.sh && /bin/bash -c ./Launch.sh
-        directory* ) export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 \
-            ;; \
-    esac \
-    ; ./enable-ssh.sh && envsubst < ./Launch.sh | bash
 
 # virt-manager mode: eta son
 # CMD virsh define <(envsubst < Docker-OSX.xml) && virt-manager || virt-manager

Dockerfile.auto

@@ -3,13 +3,14 @@
 #    / __ \____  _____/ /_____  _____/ __ \/ ___/ |/ /
 #   / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \|   / 
 #  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |  
-# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_|  AUTOINSTALL
+# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_|  :AUTO
 # 
-# Title:            Mac on Docker (Docker-OSX) [AUTOINSTALL]
+# Title:            Docker-OSX (Mac on Docker)
 # Author:           Sick.Codes https://twitter.com/sickcodes
-# Version:          4.0
+# Version:          4.3
 # License:          GPLv3+
 # Repository:       https://github.com/sickcodes/Docker-OSX
+# Website:          https://sick.codes
 # 
 # This Dockerfile is a pre-installed naked installation of Docker-OSX!
 # 
@@ -72,7 +73,7 @@ RUN if [[ "${RANKMIRRORS}" ]]; then \
 RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noconfirm \
     && if [[ "${SCROT}" ]]; then \
         pacman -Syu scrot base-devel --noconfirm \
-        && git clone https://github.com/stolk/imcat.git \
+        && git clone --recurse-submodules --depth 1 https://github.com/stolk/imcat.git \
         && cd imcat \
         && make \
         && sudo cp imcat /usr/bin/imcat \
@@ -86,6 +87,19 @@ RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noc
     ; fi \
     ; yes | pacman -Scc
 
+# TEMP-FIX for pacman issue
+RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for pacman issue
+
+# TEMP-FIX for file 5.40 libguestfs issue
+RUN yes | sudo pacman -U https://archive.archlinux.org/packages/f/file/file-5.39-1-x86_64.pkg.tar.zst \
+    && patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for file 5.40 libguestfs issue
+
 USER arch
 
 WORKDIR /home/arch/OSX-KVM
@@ -102,30 +116,65 @@ RUN mkdir -p ~/.ssh \
 
 ARG COMPLETE=true
 
-# Feel free to take a copy of this image and then host it internally
-ARG IMAGE_URL='https://images2.sick.codes/mac_hdd_ng_auto.img'
-
 # use the COMPLETE arg, for a complete image, ready to boot.
 # otherwise use your own image: -v "$PWD/disk.img":/image
 ARG WGET_OPTIONS=
 # ARG WGET_OPTIONS='--no-verbose'
 
+# Feel free to take a copy of this image and then host it internally
+ARG IMAGE_URL='https://images.sick.codes/mac_hdd_ng_auto.img'
+# ARG IMAGE_URL='https://images.sick.codes/mac_hdd_ng_auto_big_sur.img'
+
 RUN if [[ "${COMPLETE}" ]]; then \
-        echo "Downloading 20GB+ image... This step might take a while... Press Ctrl+C if you want to abort." \
+        echo "Downloading 20GB image... This step might take a while... Press Ctrl+C if you want to abort." \
         ; rm -f /home/arch/OSX-KVM/mac_hdd_ng.img \
         && wget ${WGET_OPTIONS} -O /home/arch/OSX-KVM/mac_hdd_ng.img "${IMAGE_URL}" \
     ; fi
 
-ENV BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2
+#### SPECIAL RUNTIME ARGUMENTS BELOW
+
+ENV ADDITIONAL_PORTS=
+
+ENV BOOTDISK=
 
 ENV DISPLAY=:99
 
+ENV HEADLESS=false
+
 ENV ENV=/env
 
+# Boolean for generating a bootdisk with new random serials.
+ENV GENERATE_UNIQUE=false
+
+# Boolean for generating a bootdisk with specific serials.
+ENV GENERATE_SPECIFIC=false
+
 ENV IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img
+ENV IMAGE_FORMAT=qcow2
+
+ENV KVM='accel=kvm:tcg'
+
+# ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist"
+
+# ENV NETWORKING=e1000-82545em
+ENV NETWORKING=vmxnet3
 
 ENV NOPICKER=true
 
+# dynamic RAM options for runtime
+ENV RAM=3
+# ENV RAM=max
+# ENV RAM=half
+
+# The x and y coordinates for resolution.
+# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true.
+ENV WIDTH=1920
+ENV HEIGHT=1080
+
+# libguestfs verbose
+ENV LIBGUESTFS_DEBUG=1
+ENV LIBGUESTFS_TRACE=1
+
 ENV TERMS_OF_USE=i_agree
 
 ENV BOILERPLATE="By using this Dockerfile, you hereby agree that you are a security reseacher or developer and agree to use this Dockerfile to make the world a safer place. Examples include: making your apps safer, finding your mobile phone, compiling security products, etc. You understand that Docker-OSX is an Open Source project, which is released to the public under the GNU Pulic License version 3 and above. You acknowledge that the Open Source project is absolutely unaffiliated with any third party, in any form whatsoever. Any trademarks or intelectual property which happen to be mentioned anywhere in or around the project are owned by their respective owners. By using this Dockerfile, you agree to agree to the EULA of each piece of upstream or downstream software. The following code is released for the sole purpose of security research, under the GNU Public License version 3. If you are concerned about the licensing, please note that this project is not AGPL. A copy of the license is available online: https://github.com/sickcodes/Docker-OSX/blob/master/LICENSE. In order to use the following Dockerfile you must read and understand the terms. Once you have read the terms, use the -e TERMS_OF_USE=i_agree or -e TERMS_OF_USE=i_disagree"
@@ -133,44 +182,41 @@ ENV BOILERPLATE="By using this Dockerfile, you hereby agree that you are a secur
 CMD echo "${BOILERPLATE}" \
     ; [[ "${TERMS_OF_USE}" = i_agree ]] || exit 1 \
     ; echo "Disk is being copied between layers... Please wait a minute..." \
-    ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \
+    ; sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \
+    ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \
     ; [[ "${NOPICKER}" == true ]] && { \
         sed -i '/^.*InstallMedia.*/d' Launch.sh \
-        && export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 \
+        && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \
     ; } \
+    || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
     ; [[ "${GENERATE_UNIQUE}" == true ]] && { \
-        ./Docker-OSX/custom/generate-unique-machine-values.sh \
+        ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
             --count 1 \
             --tsv ./serial.tsv \
             --bootdisks \
+            --width "${WIDTH:-1920}" \
+            --height "${HEIGHT:-1080}" \
             --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
-        --output-env "${ENV:=/env}" || exit 1 \
+            --output-env "${ENV:=/env}" \
-    ; } \
+    || exit 1 ; } \
     ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \
-            source "${ENV:=/env}" \
+            source "${ENV:=/env}" 2>/dev/null \
-            || ./Docker-OSX/custom/generate-specific-bootdisk.sh \
+            ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
             --model "${DEVICE_MODEL}" \
             --serial "${SERIAL}" \
             --board-serial "${BOARD_SERIAL}" \
             --uuid "${UUID}" \
             --mac-address "${MAC_ADDRESS}" \
-            --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" || exit 1 \
+            --width "${WIDTH:-1920}" \
-    ; } \
+            --height "${HEIGHT:-1080}" \
-    ; case "$(file --brief /bootdisk)" in \
+            --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}"  \
-        QEMU\ QCOW2\ Image* ) export BOOTDISK=/bootdisk \
+    || exit 1 ; } \
-            ;; \
+    ; { [[ "${DISPLAY}" = ':99' ]] || [[ "${HEADLESS}" == true ]] ; } && { \
-        directory* ) export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 \
-            ;; \
-    esac \
-    ; [[ "${DISPLAY}" = ':99' ]] && { \
         nohup Xvfb :99 -screen 0 1920x1080x16 \
-        & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 0.1 ; done \
+        & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 1 ; done \
     ; } \
-    ; echo "Checking whether /image is a directory or a QEMU disk." \
-    ; case "$(file --brief /image)" in \
-        QEMU*) export IMAGE_PATH=/image;; \
-        directory*) export IMAGE_PATH=/home/arch/OSX-KVM/mac_hdd_ng.img;; \
-    esac \
     ; stat "${IMAGE_PATH}" \
     ; echo "Large image is being copied between layers, please wait a minute..." \
     ; ./enable-ssh.sh \
@@ -178,7 +224,7 @@ CMD echo "${BOILERPLATE}" \
         /usr/bin/ssh-keygen -t rsa -f ~/.ssh/id_docker_osx -q -N "" \
         && chmod 600 ~/.ssh/id_docker_osx \
     ; } \
-    ; envsubst < ./Launch.sh | bash \
+    ; /bin/bash -c ./Launch.sh \
     & echo "Booting Docker-OSX in the background. Please wait..." \
     ; until [[ "$(sshpass -palpine ssh-copy-id -f -i ~/.ssh/id_docker_osx.pub -p 10022 user@127.0.0.1)" ]]; do \
         echo "Disk is being copied between layers. Repeating until able to copy SSH key into OSX..." \

Dockerfile.naked

@@ -3,13 +3,14 @@
 #    / __ \____  _____/ /_____  _____/ __ \/ ___/ |/ /
 #   / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \|   / 
 #  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |  
-# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_|  NAKED/SUPPLY_YOUR_OWN
+# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_|  :NAKED
 # 
-# Title:            Mac on Docker (Docker-OSX) [AUTOINSTALL]
+# Title:            Docker-OSX (Mac on Docker)
 # Author:           Sick.Codes https://twitter.com/sickcodes
-# Version:          4.0
+# Version:          4.3
 # License:          GPLv3+
 # Repository:       https://github.com/sickcodes/Docker-OSX
+# Website:          https://sick.codes
 # 
 # This image won't run unless you supply a disk image using:
 #       -v ${PWD}/mac_hdd_ng.img:/image
@@ -61,7 +62,7 @@ ARG SCROT
 RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noconfirm \
     && if [[ "${SCROT}" ]]; then \
         pacman -Syu scrot base-devel --noconfirm \
-        && git clone https://github.com/stolk/imcat.git \
+        && git clone --recurse-submodules --depth 1 https://github.com/stolk/imcat.git \
         && cd imcat \
         && make \
         && sudo cp imcat /usr/bin/imcat \
@@ -75,6 +76,19 @@ RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noc
     ; fi \
     ; yes | pacman -Scc
 
+# TEMP-FIX for pacman issue
+RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for pacman issue
+
+# TEMP-FIX for file 5.40 libguestfs issue
+RUN yes | sudo pacman -U https://archive.archlinux.org/packages/f/file/file-5.39-1-x86_64.pkg.tar.zst \
+    && patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for file 5.40 libguestfs issue
+
 USER arch
 
 WORKDIR /home/arch/OSX-KVM
@@ -89,47 +103,83 @@ RUN mkdir -p ~/.ssh \
     && tee -a ~/.ssh/config <<< '    StrictHostKeyChecking no' \
     && tee -a ~/.ssh/config <<< '    UserKnownHostsFile=/dev/null'
 
-ENV BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2
+#### SPECIAL RUNTIME ARGUMENTS BELOW
+
+ENV ADDITIONAL_PORTS=
+
+ENV BOOTDISK=
 
 ENV DISPLAY=:99
 
+ENV HEADLESS=false
+
 ENV ENV=/env
 
+# Boolean for generating a bootdisk with new random serials.
+ENV GENERATE_UNIQUE=false
+
+# Boolean for generating a bootdisk with specific serials.
+ENV GENERATE_SPECIFIC=false
+
 ENV IMAGE_PATH=/image
+ENV IMAGE_FORMAT=qcow2
+
+ENV KVM='accel=kvm:tcg'
+
+# ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist"
+
+# ENV NETWORKING=e1000-82545em
+ENV NETWORKING=vmxnet3
 
 ENV NOPICKER=true
 
-CMD sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \
+# dynamic RAM options for runtime
-    ; [[ "${DISPLAY}" = ':99' ]] && { \
+ENV RAM=3
+# ENV RAM=max
+# ENV RAM=half
+
+# The x and y coordinates for resolution.
+# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true.
+ENV WIDTH=1920
+ENV HEIGHT=1080
+
+# libguestfs verbose
+ENV LIBGUESTFS_DEBUG=1
+ENV LIBGUESTFS_TRACE=1
+
+CMD sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" 2>/dev/null || true \
+    ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \
+    ; { [[ "${DISPLAY}" = ':99' ]] || [[ "${HEADLESS}" == true ]] ; } && { \
         nohup Xvfb :99 -screen 0 1920x1080x16 \
         & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 1 ; done \
     ; } \
     ; [[ "${NOPICKER}" == true ]] && { \
         sed -i '/^.*InstallMedia.*/d' Launch.sh \
-        && export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2 \
+        && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \
     ; } \
+    || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
     ; [[ "${GENERATE_UNIQUE}" == true ]] && { \
-        ./Docker-OSX/custom/generate-unique-machine-values.sh \
+        ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
             --count 1 \
             --tsv ./serial.tsv \
             --bootdisks \
-        --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+            --width "${WIDTH:-1920}" \
-        --output-env "${ENV:=/env}" || exit 1 \
+            --height "${HEIGHT:-1080}" \
-    ; } \
+            --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+            --output-env "${ENV:=/env}" \
+    || exit 1 ; } \
     ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \
-            source "${ENV:=/env}" \
+            source "${ENV:=/env}" 2>/dev/null \
-            || ./Docker-OSX/custom/generate-specific-bootdisk.sh \
+            ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
             --model "${DEVICE_MODEL}" \
             --serial "${SERIAL}" \
             --board-serial "${BOARD_SERIAL}" \
             --uuid "${UUID}" \
             --mac-address "${MAC_ADDRESS}" \
-            --output-bootdisk "${BOOTDISK:-/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" || exit 1 \
+            --width "${WIDTH:-1920}" \
-    ; } \
+            --height "${HEIGHT:-1080}" \
-    ; case "$(file --brief /bootdisk)" in \
+            --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
-        QEMU\ QCOW2\ Image* ) export BOOTDISK=/bootdisk \
+    || exit 1 ; } \
-            ;; \
+    ; ./enable-ssh.sh && /bin/bash -c ./Launch.sh
-        directory* ) export BOOTDISK=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2 \
-            ;; \
-    esac \
-    ; ./enable-ssh.sh && envsubst < ./Launch.sh | bash

custom/README.md

@@ -0,0 +1,7 @@
+# OSX Serial Generator
+
+This folder has been moved to its own repository :)
+
+This is a temporary copy for hardlinks.
+
+See [https://github.com/sickcodes/osx-serial-generator](https://github.com/sickcodes/osx-serial-generator)

custom/config-nopicker-custom.plist

@@ -1,4 +1,5 @@
-<!-- This file is modified from https://github.com/kholia/OSX-KVM/tree/master/OpenCore-Catalina -->
+<!-- This file is modified by @sickcodes from https://github.com/kholia/OSX-KVM/tree/master/OpenCore-Catalina -->
+<!-- The modifications are placeholders for: {{DEVICE_MODEL}}, {{SERIAL}}, {{BOARD_SERIAL}}, {{UUID}}, {{ROM}}, {{WIDTH}}, {{HEIGHT}} -->
 <!-- All credit for this file https://github.com/kholia/OSX-KVM/blob/master/CREDITS.md -->
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
@@ -704,9 +705,7 @@
 			<key>MLB</key>
 			<string>{{BOARD_SERIAL}}</string>
 			<key>ROM</key>
-			<data>
+			<data>{{ROM}}</data>
-			{{ROM}}
-			</data>
 			<key>SpoofVendor</key>
 			<true/>
 			<key>SystemProductName</key>
@@ -816,7 +815,7 @@
 			<key>ReplaceTabWithSpace</key>
 			<false/>
 			<key>Resolution</key>
-			<string>1920x1080@32</string>
+			<string>{{WIDTH}}x{{HEIGHT}}@32</string>
 			<key>SanitiseClearScreen</key>
 			<false/>
 			<key>TextRenderer</key>

custom/generate-specific-bootdisk.sh

@@ -1,43 +1,58 @@
 #!/bin/bash
-#     ____             __             ____  ______  __
+#   ___  _____  __  ___          _      _    ___                       _           
-#    / __ \____  _____/ /_____  _____/ __ \/ ___/ |/ /
+#  / _ \/ __\ \/ / / __| ___ _ _(_)__ _| |  / __|___ _ _  ___ _ _ __ _| |_ ___ _ _ 
-#   / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \|   /
+# | (_) \__ \>  <  \__ \/ -_) '_| / _` | | | (_ / -_) ' \/ -_) '_/ _` |  _/ _ \ '_|
-#  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |
+#  \___/|___/_/\_\ |___/\___|_| |_\__,_|_|  \___\___|_||_\___|_| \__,_|\__\___/_|  
-# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_| GEN BOOT DISK
 #
-# Repo:             https://github.com/sickcodes/Docker-OSX/
+# Repo:             https://github.com/sickcodes/osx-serial-generator/
-# Title:            Mac on Docker (Docker-OSX)
+# Title:            OSX Serial Generator
 # Author:           Sick.Codes https://sick.codes/
 # Version:          3.1
 # License:          GPLv3+
 
-help_text="Usage: generate-specific-bootdisk.sh
+set -e
 
-General options:
+help_text="Usage: ./generate-specific-bootdisk.sh 
+
+Required options:
     --model <string>                Device model, e.g. 'iMacPro1,1'
-    --serial <filename>             Device Serial number.
+    --serial <string>               Device Serial number
-    --board-serial <filename>       Board Serial number.
+    --board-serial <string>         Main Logic Board Serial number (MLB)
-    --uuid <filename>               SmUUID.
+    --uuid <string>                 SMBIOS UUID (SmUUID)
-    --mac-address <string>          Used to set the ROM value; lowercased and without a colon.
+    --mac-address <string>          Used for both the MAC address and to set ROM
-    --output-bootdisk <filename>    Optionally change the bootdisk output filename.
+                                    ROM is lowercased sans any colons
+Optional options:
+    --width <integer>               Resolution x axis length in px, default 1920
+    --height <integer>              Resolution y axis length in px, default 1080
+    --input-plist-url <url>         Specify an alternative master plist, via URL
+    --master-plist-url <url>        Same as above.
     --custom-plist <filename>       Optionally change the input plist.
-
+    --master-plist <filename>       Same as above.
+    --output-bootdisk <filename>    Optionally change the bootdisk filename
+    --output-plist <filename>       Optionally change the output plist filename
     --help, -h, help                Display this help and exit
 
+Placeholders:   {{DEVICE_MODEL}}, {{SERIAL}}, {{BOARD_SERIAL}}, {{UUID}},
+                {{ROM}}, {{WIDTH}}, {{HEIGHT}}
+
 Example:
-    ./generate-specific-bootdisk.sh \
+    ./generate-specific-bootdisk.sh \\
-        --model iMacPro1,1 \
+        --model iMacPro1,1 \\
-        --serial C02TW0WAHX87 \
+        --serial C02TW0WAHX87 \\
-        --board-serial C027251024NJG36UE \
+        --board-serial C027251024NJG36UE \\
-        --uuid 5CCB366D-9118-4C61-A00A-E5BAF3BED451 \
+        --uuid 5CCB366D-9118-4C61-A00A-E5BAF3BED451 \\
-        --mac-address A8:5C:2C:9A:46:2F \
+        --mac-address A8:5C:2C:9A:46:2F \\
-        --output-bootdisk OpenCore-nopicker.qcow2
+        --output-bootdisk ./OpenCore-nopicker.qcow2 \\
+        --width 1920 \\
+        --height 1080
 
 Author:  Sick.Codes https://sick.codes/
-Project: https://github.com/sickcodes/Docker-OSX/
+Project: https://github.com/sickcodes/osx-serial-generator/
+License: GPLv3+
 "
 
-PLIST_MASTER=config-nopicker-custom.plist
+OPENCORE_IMAGE_MAKER_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/opencore-image-ng.sh'
+MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-nopicker-custom.plist'
 
 # gather arguments
 while (( "$#" )); do
@@ -51,6 +66,7 @@ while (( "$#" )); do
                 export DEVICE_MODEL="${1#*=}"
                 shift
             ;;
+
     --model* | -m* ) 
                 export DEVICE_MODEL="${2}"
                 shift
@@ -61,6 +77,7 @@ while (( "$#" )); do
                 export SERIAL="${1#*=}"
                 shift
             ;;
+
     --serial* )
                 export SERIAL="${2}"
                 shift
@@ -71,6 +88,7 @@ while (( "$#" )); do
                 export BOARD_SERIAL="${1#*=}"
                 shift
             ;;
+
     --board-serial* )
                 export BOARD_SERIAL="${2}"
                 shift
@@ -81,6 +99,7 @@ while (( "$#" )); do
                 export UUID="${1#*=}"
                 shift
             ;;
+
     --uuid* )
                 export UUID="${2}"
                 shift
@@ -91,34 +110,81 @@ while (( "$#" )); do
                 export MAC_ADDRESS="${1#*=}"
                 shift
             ;;
+
     --mac-address* )
                 export MAC_ADDRESS="${2}"
                 shift
                 shift
             ;;
 
+    --width=* )
+                export WIDTH="${1#*=}"
+                shift
+            ;;
+
+    --width* )
+                export WIDTH="${2}"
+                shift
+                shift
+            ;;
+
+    --height=* )
+                export HEIGHT="${1#*=}"
+                shift
+            ;;
+
+    --height* )
+                export HEIGHT="${2}"
+                shift
+                shift
+            ;;
+
     --output-bootdisk=* )
                 export OUTPUT_QCOW="${1#*=}"
                 shift
             ;;
+
     --output-bootdisk* )
                 export OUTPUT_QCOW="${2}"
                 shift
                 shift
             ;;
 
-    --custom-plist=* )
+    --output-plist=* )
-                export INPUT_PLIST="${1#*=}"
+                export OUTPUT_PLIST="${1#*=}"
                 shift
             ;;
-    --custom-plist* )
+
-                export INPUT_PLIST="${2}"
+    --output-plist* )
+                export OUTPUT_PLIST="${2}"
+                shift
+                shift
+            ;;
+
+    --master-plist-url=* | --input-plist-url=* | --custom-plist-url=* )
+                export MASTER_PLIST_URL="${1#*=}"
+                shift
+            ;;
+
+    --master-plist-url* | --input-plist-url* | --custom-plist-url* )
+                export MASTER_PLIST_URL="${2}"
+                shift
+                shift
+            ;;
+
+    --master-plist=* | --input-plist=* | --custom-plist=* )
+                export MASTER_PLIST="${1#*=}"
+                shift
+            ;;
+
+    --master-plist* | --input-plist* | --custom-plist* )
+                export MASTER_PLIST="${2}"
                 shift
                 shift
             ;;
 
     *)
-                echo "Invalid option. Running with default values..."
+                echo "Invalid option ${1}. Running with default values..."
                 shift
             ;;
     esac
@@ -126,36 +192,69 @@ done
 
 
 download_qcow_efi_folder () {
-    git clone --depth 1 https://github.com/kholia/OSX-KVM.git
+
-    cp -ra ./OSX-KVM/OpenCore-Catalina/EFI .
+    export EFI_FOLDER=./OpenCore-Catalina/EFI
-    mkdir -p ./EFI/OC/Resources
+    export RESOURCES_FOLDER=./resources/OcBinaryData/Resources
-    # clone some Apple drivers
+
-    git clone --depth 1 https://github.com/acidanthera/OcBinaryData.git
+    # check if we are inside OSX-KVM already
-    # copy said drivers into EFI/OC/Resources
+    # if not, download OSX-KVM locally
-    cp -a ./OcBinaryData/Resources/* ./EFI/OC/Resources
+    [ -d ./OpenCore-Catalina/EFI/ ] || {
+        [ -d ./OSX-KVM/ ] || git clone --recurse-submodules --depth 1 https://github.com/kholia/OSX-KVM.git
+        export EFI_FOLDER="./OSX-KVM/${EFI_FOLDER}"
+    }
+    
+    [ -d ./resources/OcBinaryData/Resources/ ] || {
+        export RESOURCES_FOLDER="./OSX-KVM/${RESOURCES_FOLDER}"
+    }
+
     # EFI Shell commands
     touch startup.nsh && echo 'fs0:\EFI\BOOT\BOOTx64.efi' > startup.nsh
+
+    cp -a "${EFI_FOLDER}" .
+
+    mkdir -p ./EFI/OC/Resources
+
+    # copy Apple drivers into EFI/OC/Resources
+    cp -a "${RESOURCES_FOLDER}"/* ./EFI/OC/Resources
 }
 
 generate_bootdisk () {
-    [[ -e ./config-nopicker-custom.plist ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/config-nopicker-custom.plist
+
-    [[ -e ./opencore-image-ng.sh ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/opencore-image-ng.sh && chmod +x opencore-image-ng.sh
+    # need a config.plist
+    if [ "${MASTER_PLIST}" ]; then
+        [ -e "${MASTER_PLIST}" ] || echo "Could not find: ${MASTER_PLIST}"
+    elif [ "${MASTER_PLIST}" ] && [ "${MASTER_PLIST_URL}" ]; then
+        echo 'You specified both a custom plist FILE & custom plist URL.'
+        echo 'Use only one of those options.'
+    elif [ "${MASTER_PLIST_URL}" ]; then
+        wget -O "${MASTER_PLIST:=./config-custom.plist}" "${MASTER_PLIST_URL}"
+    else
+        # default is config-nopicker-custom.plist from OSX-KVM with placeholders used in Docker-OSX
+        wget -O "${MASTER_PLIST:=./config-nopicker-custom.plist}" "${MASTER_PLIST_URL}"
+    fi
+
+    [ -e ./opencore-image-ng.sh ] \
+        || { wget "${OPENCORE_IMAGE_MAKER_URL}" \
+            && chmod +x opencore-image-ng.sh ; }
+
     # plist required for bootdisks, so create anyway.
-    if [[ "${DEVICE_MODEL}" ]] \
+    if [ "${DEVICE_MODEL}" ] \
-            && [[ "${SERIAL}" ]] \
+            && [ "${SERIAL}" ] \
-            && [[ "${BOARD_SERIAL}" ]] \
+            && [ "${BOARD_SERIAL}" ] \
-            && [[ "${UUID}" ]] \
+            && [ "${UUID}" ] \
-            && [[ "${MAC_ADDRESS}" ]]; then
+            && [ "${MAC_ADDRESS}" ]; then
         ROM="${MAC_ADDRESS//\:/}"
         ROM="${ROM,,}"
-        sed -e s/{{DEVICE_MODEL}}/"${DEVICE_MODEL}"/g \
+        sed -e s/\{\{DEVICE_MODEL\}\}/"${DEVICE_MODEL}"/g \
-            -e s/{{SERIAL}}/"${SERIAL}"/g \
+            -e s/\{\{SERIAL\}\}/"${SERIAL}"/g \
-            -e s/{{BOARD_SERIAL}}/"${BOARD_SERIAL}"/g \
+            -e s/\{\{BOARD_SERIAL\}\}/"${BOARD_SERIAL}"/g \
-            -e s/{{UUID}}/"${UUID}"/g \
+            -e s/\{\{UUID\}\}/"${UUID}"/g \
-            -e s/{{ROM}}/"${ROM}"/g \
+            -e s/\{\{ROM\}\}/"${ROM}"/g \
-            "${PLIST_MASTER}" > ./tmp.config.plist || exit 1
+            -e s/\{\{WIDTH\}\}/"${WIDTH:-1920}"/g \
+            -e s/\{\{HEIGHT\}\}/"${HEIGHT:-1080}"/g \
+            "${MASTER_PLIST}" > ./tmp.config.plist || exit 1
     else
-        cat <<EOF
+        cat <<EOF && exit 1
 Error: one of the following values is missing:
 
 --model "${DEVICE_MODEL:-MISSING}"
@@ -164,12 +263,14 @@ Error: one of the following values is missing:
 --uuid "${UUID:-MISSING}"
 --mac-address "${MAC_ADDRESS:-MISSING}"
 
+--width "${WIDTH:-1920}"
+--height "${HEIGHT:-1080}"
+
 EOF
-        exit 1
     fi
 
     ./opencore-image-ng.sh \
-        --cfg "${INPUT_PLIST:-./tmp.config.plist}" \
+        --cfg "./tmp.config.plist" \
         --img "${OUTPUT_QCOW:-./${SERIAL}.OpenCore-nopicker.qcow2}" || exit 1
         rm ./tmp.config.plist
 

custom/generate-unique-machine-values.sh

@@ -1,58 +1,63 @@
 #!/bin/bash
-#     ____             __             ____  ______  __
+#   ___  _____  __  ___          _      _    ___                       _           
-#    / __ \____  _____/ /_____  _____/ __ \/ ___/ |/ /
+#  / _ \/ __\ \/ / / __| ___ _ _(_)__ _| |  / __|___ _ _  ___ _ _ __ _| |_ ___ _ _ 
-#   / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \|   /
+# | (_) \__ \>  <  \__ \/ -_) '_| / _` | | | (_ / -_) ' \/ -_) '_/ _` |  _/ _ \ '_|
-#  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |
+#  \___/|___/_/\_\ |___/\___|_| |_\__,_|_|  \___\___|_||_\___|_| \__,_|\__\___/_|  
-# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_| SERIALIZER
 #
-# Repo:             https://github.com/sickcodes/Docker-OSX/
+# Repo:             https://github.com/sickcodes/osx-serial-generator/
-# Title:            Mac on Docker (Docker-OSX)
+# Title:            OSX Serial Generator
 # Author:           Sick.Codes https://sick.codes/
 # Version:          3.1
 # License:          GPLv3+
 
-help_text="Usage: generate-unique-machine-values.sh
+set -e
+
+help_text="Usage: ./generate-unique-machine-values.sh
 
 General options:
     --count, -n, -c <count>         Number of serials to generate
     --model, -m <model>             Device model, e.g. 'iMacPro1,1'
-    --csv <filename>                Optionally change the CSV output filename.
+    --csv <filename>                Optionally change the CSV output filename
-    --tsv <filename>                Optionally change the TSV output filename.
+    --tsv <filename>                Optionally change the TSV output filename
-    --output-bootdisk <filename>    Optionally change the bootdisk qcow output filename. Useless when count > 1.
+    --output-dir <directory>        Optionally change the script output location
-    --output-env <filename>         Optionally change the bootdisk env filename. Useless when count > 1.
+    --width <string>                Resolution x axis length in px, default 1920
-    --output-dir <directory>        Optionally change the script output location.
+    --height <string>               Resolution y axis length in px, default 1080
-
+    --input-plist-url <url>         Specify an alternative master plist, via URL
+    --master-plist-url <url>        Same as above.
+    --custom-plist <filename>       Optionally change the input plist.
+    --master-plist <filename>       Same as above.
+    --output-bootdisk <filename>    Optionally change the bootdisk filename
+    --create-envs, --envs           Create all corresponding sourcable envs
+    --create-plists, --plists       Create all corresponding config.plists
+    --create-bootdisks, --bootdisks Create all corresponding bootdisks [SLOW]
     --help, -h, help                Display this help and exit
-    --plists                        Create corresponding config.plists for each serial set.
+
-    --bootdisks                     [SLOW] Create corresponding boot disk images for each serial set.
+Additional options only if you are creating ONE serial set:
+    --output-bootdisk <filename>    Optionally change the bootdisk filename
+    --output-env <filename>         Optionally change the serials env filename
+
+Custom plist placeholders:
+    {{DEVICE_MODEL}}, {{SERIAL}}, {{BOARD_SERIAL}},
+    {{UUID}}, {{ROM}}, {{WIDTH}}, {{HEIGHT}}
 
 Example:
-    ./generate-unique-machine-values.sh --count 1 --model='iMacPro1,1' --plists --bootdisks
+    ./generate-unique-machine-values.sh --count 1 --plists --bootdisks --envs
 
-        The above example will generate a
+Defaults:
-            - serial
+    - One serial, for 'iMacPro1,1', in the current working directory
-            - board serial
+    - CSV and TSV output
-            - uuid
+    - plists in ./plists/ & bootdisks in ./bootdisks/ & envs in ./envs
-            - MAC address
+    - if you set --bootdisk name, --bootdisks is assumed
-            - ROM value based on lowercase MAC address
+    - if you set --custom-plist, --plists is assumed
-            - Boot disk qcow image.
+    - if you set --output-env, --envs is assumed
-            - config.plist
-
-Notes:
-    - Default is 1 serial for 'iMacPro1,1' in the current working directory.
-    - Default output is CSV, whereas setting the TSV option will output as tab-separated.
-    - CSV is double quoted.
-    - If you do not set a CSV filename, the output will be sent to the output-dir.
-    - If you do not set an output-dir, the current directory will be the output directory.
-    - Sourcable environment variable shell files will be written to a folder, 'envs'.
-    - config.plist files will be written to a folder, 'plists'.
 
 Author:  Sick.Codes https://sick.codes/
-Project: https://github.com/sickcodes/Docker-OSX/
+Project: https://github.com/sickcodes/osx-serial-generator/
+License: GPLv3+
 "
 
-MACINFOPKG_VERSION=2.1.2
+OPENCORE_IMAGE_MAKER_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/opencore-image-ng.sh'
-PLIST_MASTER=config-nopicker-custom.plist
+MASTER_PLIST_URL='https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-nopicker-custom.plist'
 
 # gather arguments
 while (( "$#" )); do
@@ -66,6 +71,7 @@ while (( "$#" )); do
                 export SERIAL_SET_COUNT="${1#*=}"
                 shift
             ;;
+
     --count* | -c* | -n* )
                 export SERIAL_SET_COUNT="${2}"
                 shift
@@ -76,6 +82,7 @@ while (( "$#" )); do
                 export CSV_OUTPUT_FILENAME="${1#*=}"
                 shift
             ;;
+
     --csv* )
                 export CSV_OUTPUT_FILENAME="${2}"
                 shift
@@ -86,6 +93,7 @@ while (( "$#" )); do
                 export TSV_OUTPUT_FILENAME="${1#*=}"
                 shift
             ;;
+
     --tsv* )
                 export TSV_OUTPUT_FILENAME="${2}"
                 shift
@@ -96,6 +104,7 @@ while (( "$#" )); do
                 export OUTPUT_DIRECTORY="${1#*=}"
                 shift
             ;;
+
     --output-dir* )
                 export OUTPUT_DIRECTORY="${2}"
                 shift
@@ -103,11 +112,12 @@ while (( "$#" )); do
             ;;
 
     --output-bootdisk=* )
-                export OUTPUT_QCOW="${1#*=}"
+                export OUTPUT_BOOTDISK="${1#*=}"
                 shift
             ;;
+
     --output-bootdisk* )
-                export OUTPUT_QCOW="${2}"
+                export OUTPUT_BOOTDISK="${2}"
                 shift
                 shift
             ;;
@@ -116,6 +126,7 @@ while (( "$#" )); do
                 export OUTPUT_ENV="${1#*=}"
                 shift
             ;;
+
     --output-env* )
                 export OUTPUT_ENV="${2}"
                 shift
@@ -126,18 +137,69 @@ while (( "$#" )); do
                 export DEVICE_MODEL="${1#*=}"
                 shift
             ;;
+
     --model* | -m* ) 
                 export DEVICE_MODEL="${2}"
                 shift
                 shift
             ;;
 
-    --plists )
+    --width=* )
+                export WIDTH="${1#*=}"
+                shift
+            ;;
+
+    --width* )
+                export WIDTH="${2}"
+                shift
+                shift
+            ;;
+
+    --height=* )
+                export HEIGHT="${1#*=}"
+                shift
+            ;;
+
+    --height* )
+                export HEIGHT="${2}"
+                shift
+                shift
+            ;;
+
+    --master-plist-url=* | --input-plist-url=* | --custom-plist-url=* )
+                export MASTER_PLIST_URL="${1#*=}"
+                shift
+            ;;
+
+    --master-plist-url* | --input-plist-url* | --custom-plist-url* )
+                export MASTER_PLIST_URL="${2}"
+                shift
+                shift
+            ;;
+
+    --master-plist=* | --input-plist=* | --custom-plist=* )
+                export MASTER_PLIST="${1#*=}"
+                shift
+            ;;
+
+    --master-plist* | --input-plist* | --custom-plist* )
+                export MASTER_PLIST="${2}"
+                shift
+                shift
+            ;;
+
+    --create-plists | --plists )
                 export CREATE_PLISTS=1
                 shift
             ;;
-    --bootdisks ) 
+
-                export CREATE_QCOWS=1
+    --create-bootdisks | --bootdisks )
+                export CREATE_BOOTDISKS=1
+                shift
+            ;;
+
+    --create-envs | --envs )
+                export CREATE_ENVS=1
                 shift
             ;;
 
@@ -150,79 +212,97 @@ done
 
 
 build_mac_serial () {
-    export MACINFOPKG_VERSION="${MACINFOPKG_VERSION:=2.1.2}"
+    [ -d ./OpenCorePkg ] ||  git clone --depth 1 https://github.com/acidanthera/OpenCorePkg.git
-    wget -O "${TARBALL:=./MacInfoPkg.tar.gz}" \
+    make -C ./OpenCorePkg/Utilities/macserial/
-        "https://github.com/acidanthera/MacInfoPkg/archive/${MACINFOPKG_VERSION}.tar.gz"
+    mv ./OpenCorePkg/Utilities/macserial/macserial .
-    tar -xzvf "${TARBALL}"
-    cd "./MacInfoPkg-${MACINFOPKG_VERSION}/macserial" \
-        && ./build.tool \
-        && cd -
-    mv "./MacInfoPkg-${MACINFOPKG_VERSION}/macserial/bin/macserial" .
-    rm -f "${TARBALL}"
-    rm -rf "./MacInfoPkg-${MACINFOPKG_VERSION}/"
     chmod +x ./macserial
     stat ./macserial
 }
 
 download_vendor_mac_addresses () {
     # download the MAC Address vendor list
-    [[ -e "${MAC_ADDRESSES_FILE:=vendor_macs.tsv}" ]] || wget -O "${MAC_ADDRESSES_FILE}" https://gitlab.com/wireshark/wireshark/-/raw/master/manuf
+    [ -e "${MAC_ADDRESSES_FILE:=vendor_macs.tsv}" ] || wget -O "${MAC_ADDRESSES_FILE}" https://gitlab.com/wireshark/wireshark/-/raw/master/manuf
 }
 
 download_qcow_efi_folder () {
-    git clone --depth 1 https://github.com/kholia/OSX-KVM.git
+
-    cp -ra ./OSX-KVM/OpenCore-Catalina/EFI .
+    export EFI_FOLDER=./OpenCore-Catalina/EFI
-    mkdir -p ./EFI/OC/Resources
+    export RESOURCES_FOLDER=./resources/OcBinaryData/Resources
-    # clone some Apple drivers
+
-    git clone --depth 1 https://github.com/acidanthera/OcBinaryData.git
+    # check if we are inside OSX-KVM already
-    # copy said drivers into EFI/OC/Resources
+    # if not, download OSX-KVM locally
-    cp -a ./OcBinaryData/Resources/* ./EFI/OC/Resources
+    [ -d ./OpenCore-Catalina/EFI/ ] || {
+        [ -d ./OSX-KVM/ ] || git clone --recurse-submodules --depth 1 https://github.com/kholia/OSX-KVM.git
+        export EFI_FOLDER="./OSX-KVM/${EFI_FOLDER}"
+    }
+    
+    [ -d ./resources/OcBinaryData/Resources/ ] || {
+        export RESOURCES_FOLDER="./OSX-KVM/${RESOURCES_FOLDER}"
+    }
+
     # EFI Shell commands
     touch startup.nsh && echo 'fs0:\EFI\BOOT\BOOTx64.efi' > startup.nsh
+
+    cp -a "${EFI_FOLDER}" .
+
+    mkdir -p ./EFI/OC/Resources
+
+    # copy Apple drivers into EFI/OC/Resources
+    cp -a "${RESOURCES_FOLDER}"/* ./EFI/OC/Resources
 }
 
 
 generate_serial_sets () {
-    [[ -e ./config-nopicker-custom.plist ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/config-nopicker-custom.plist
-    [[ -e ./opencore-image-ng.sh ]] || wget https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/custom/opencore-image-ng.sh && chmod +x opencore-image-ng.sh
-    mkdir -p "${OUTPUT_DIRECTORY}/envs"
-    export DATE_NOW="$(date +%F-%T)"
-    export DEVICE_MODEL="${DEVICE_MODEL:=iMacPro1,1}"
-    export VENDOR_REGEX="${VENDOR_REGEX:=Apple, Inc.}"
 
-    if [[ "${CSV_OUTPUT_FILENAME}" ]] || [[ "${TSV_OUTPUT_FILENAME}" ]]; then
+
-        [[ ${CSV_OUTPUT_FILENAME} ]] && export CSV_SERIAL_SETS_FILE="${CSV_OUTPUT_FILENAME}"
+    
-        [[ ${TSV_OUTPUT_FILENAME} ]] && export TSV_SERIAL_SETS_FILE="${TSV_OUTPUT_FILENAME}"
+    if [ "${CSV_OUTPUT_FILENAME}" ]; then
+        [ "${CSV_OUTPUT_FILENAME}" ] && export CSV_SERIAL_SETS_FILE="${CSV_OUTPUT_FILENAME}"
     else
-        export SERIAL_SETS_FILE="${OUTPUT_DIRECTORY}/serial_sets-${DATE_NOW}.csv"
+        export CSV_SERIAL_SETS_FILE="${OUTPUT_DIRECTORY}/serial_sets-${DATE_NOW}.csv"
+    fi
+
+    if [ "${TSV_OUTPUT_FILENAME}" ]; then
+        [ "${TSV_OUTPUT_FILENAME}" ] && export TSV_SERIAL_SETS_FILE="${TSV_OUTPUT_FILENAME}"
+    else
+        export TSV_SERIAL_SETS_FILE="${OUTPUT_DIRECTORY}/serial_sets-${DATE_NOW}.tsv"
     fi
 
-    touch "${SERIAL_SETS_FILE}"
-    echo "Writing serial sets to ${SERIAL_SETS_FILE}"
     
     ./macserial \
-        --num "${SERIAL_SET_COUNT:=1}" \
+        --num "${SERIAL_SET_COUNT}" \
         --model "${DEVICE_MODEL}" \
         | while IFS='\ \|\ ' read -r SERIAL BOARD_SERIAL; do
             # make a uuid...
             UUID="$(uuidgen)"
-            UUID="${UUID^^}"
+            # bash 3-5 compatible
+            # UUID="${UUID^^}"
+            UUID="$(tr '[:lower:]' '[:upper:]' <<< "${UUID}")"
 
             # get a random vendor specific MAC address.
             RANDOM_MAC_PREFIX="$(grep -e "${VENDOR_REGEX}" < "${MAC_ADDRESSES_FILE:=vendor_macs.tsv}" | sort --random-sort | head -n1)"
             RANDOM_MAC_PREFIX="$(cut -d$'\t' -f1 <<< "${RANDOM_MAC_PREFIX}")"
-            MAC_ADDRESS="$(printf "${RANDOM_MAC_PREFIX}:%02X:%02X:%02X" $[RANDOM%256] $[RANDOM%256] $[RANDOM%256])"
+            MAC_ADDRESS="$(printf "${RANDOM_MAC_PREFIX}:%02X:%02X:%02X" "$((RANDOM%256))" "$((RANDOM%256))" "$((RANDOM%256))")"
+
+            [ -z "${WIDTH}" ] && WIDTH=1920
+            [ -z "${HEIGHT}" ] && HEIGHT=1080
 
             # append to csv file
-            if [[ "${CSV_SERIAL_SETS_FILE}" ]]; then
+            tee -a "${CSV_SERIAL_SETS_FILE}" <<EOF
-                echo "\"${DEVICE_MODEL}\",\"${SERIAL}\",\"${BOARD_SERIAL}\",\"${UUID}\",\"${MAC_ADDRESS}\"" >> "${CSV_SERIAL_SETS_FILE}"
+"${DEVICE_MODEL}","${SERIAL}","${BOARD_SERIAL}","${UUID}","${MAC_ADDRESS}","${WIDTH}","${HEIGHT}"
-            fi
+EOF
+            echo "Wrote CSV to: ${CSV_SERIAL_SETS_FILE}"
 
             # append to tsv file
-            if [[ "${TSV_SERIAL_SETS_FILE}" ]]; then
+            T=$'\t'
-                printf "${DEVICE_MODEL}\t${SERIAL}\t${BOARD_SERIAL}\t${UUID}\t${MAC_ADDRESS}\n" >> "${TSV_SERIAL_SETS_FILE}"
+            tee -a "${TSV_SERIAL_SETS_FILE}" <<EOF
-            fi 
+${DEVICE_MODEL}${T}${SERIAL}${T}${BOARD_SERIAL}${T}${UUID}${T}${MAC_ADDRESS}${T}${WIDTH}${T}${HEIGHT}
+EOF
+            echo "Wrote TSV to: ${TSV_SERIAL_SETS_FILE}"
 
+            # if any of these are on, we need the env file.
+            if [ "${CREATE_ENVS}" ] || [ "${CREATE_PLISTS}" ] || [ "${CREATE_BOOTDISKS}" ] || [ "${OUTPUT_BOOTDISK}" ] || [ "${OUTPUT_ENV}" ]; then
+                mkdir -p "${OUTPUT_DIRECTORY}/envs"
                 OUTPUT_ENV_FILE="${OUTPUT_ENV:-"${OUTPUT_DIRECTORY}/envs/${SERIAL}.env.sh"}"
                 touch "${OUTPUT_ENV_FILE}"
                 cat <<EOF > "${OUTPUT_ENV_FILE}"
@@ -231,43 +311,69 @@ export SERIAL="${SERIAL}"
 export BOARD_SERIAL="${BOARD_SERIAL}"
 export UUID="${UUID}"
 export MAC_ADDRESS="${MAC_ADDRESS}"
+export WIDTH="${WIDTH}"
+export HEIGHT="${HEIGHT}"
 EOF
 
+            fi
+
             # plist required for bootdisks, so create anyway.
-            if [[ "${CREATE_PLISTS}" ]] || [[ "${CREATE_QCOWS}" ]]; then
+            if [ "${CREATE_PLISTS}" ] || [ "${CREATE_BOOTDISKS}" ]; then
+
+                # need a config.plist
+                if [ "${MASTER_PLIST}" ]; then
+                    [ -e "${MASTER_PLIST}" ] || echo "Could not find: ${MASTER_PLIST}"
+                elif [ "${MASTER_PLIST}" ] && [ "${MASTER_PLIST_URL}" ]; then
+                    echo 'You specified both a custom plist FILE & custom plist URL.'
+                    echo 'Use only one of those options.'
+                elif [ "${MASTER_PLIST_URL}" ]; then
+                    wget -O "${MASTER_PLIST:=./config-custom.plist}" "${MASTER_PLIST_URL}"
+                else
+                    # default is config-nopicker-custom.plist from OSX-KVM with placeholders used in Docker-OSX
+                    wget -O "${MASTER_PLIST:=./config-nopicker-custom.plist}" "${MASTER_PLIST_URL}"
+                fi
+
                 mkdir -p "${OUTPUT_DIRECTORY}/plists"
                 source "${OUTPUT_ENV_FILE}"
                 ROM_VALUE="${MAC_ADDRESS//\:/}"
                 ROM_VALUE="${ROM_VALUE,,}"
-                sed -e s/{{DEVICE_MODEL}}/"${DEVICE_MODEL}"/g \
+                sed -e s/\{\{DEVICE_MODEL\}\}/"${DEVICE_MODEL}"/g \
-                    -e s/{{SERIAL}}/"${SERIAL}"/g \
+                    -e s/\{\{SERIAL\}\}/"${SERIAL}"/g \
-                    -e s/{{BOARD_SERIAL}}/"${BOARD_SERIAL}"/g \
+                    -e s/\{\{BOARD_SERIAL\}\}/"${BOARD_SERIAL}"/g \
-                    -e s/{{UUID}}/"${UUID}"/g \
+                    -e s/\{\{UUID\}\}/"${UUID}"/g \
-                    -e s/{{ROM}}/"${ROM}"/g \
+                    -e s/\{\{ROM\}\}/"${ROM}"/g \
-                    "${PLIST_MASTER}" > "${OUTPUT_DIRECTORY}/plists/${SERIAL}.config.plist" || exit 1
+                    -e s/\{\{WIDTH\}\}/"${WIDTH}"/g \
+                    -e s/\{\{HEIGHT\}\}/"${HEIGHT}"/g \
+                    "${MASTER_PLIST}" > "${OUTPUT_DIRECTORY}/plists/${SERIAL}.config.plist" || exit 1
             fi
 
-            if [[ "${CREATE_QCOWS}" ]]; then
+            # make bootdisk qcow2 format if --bootdisks, but also if you set the bootdisk filename
-                mkdir -p "${OUTPUT_DIRECTORY}/qcows"
+            if [ "${CREATE_BOOTDISKS}" ] || [ "${OUTPUT_BOOTDISK}" ]; then
+                [ -e ./opencore-image-ng.sh ] \
+                    || { wget "${OPENCORE_IMAGE_MAKER_URL}" \
+                        && chmod +x opencore-image-ng.sh ; }
+                mkdir -p "${OUTPUT_DIRECTORY}/bootdisks"
                 ./opencore-image-ng.sh \
                     --cfg "${OUTPUT_DIRECTORY}/plists/${SERIAL}.config.plist" \
-                    --img "${OUTPUT_QCOW:-${OUTPUT_DIRECTORY}/qcows/${SERIAL}.OpenCore-nopicker.qcow2}" || exit 1
+                    --img "${OUTPUT_BOOTDISK:-${OUTPUT_DIRECTORY}/bootdisks/${SERIAL}.OpenCore-nopicker.qcow2}" || exit 1
             fi
 
         done
 
-        [[ -e "${CSV_SERIAL_SETS_FILE}" ]] && \
+        [ -e "${CSV_SERIAL_SETS_FILE}" ] && \
-            cat <(echo "DEVICE_MODEL,SERIAL,BOARD_SERIAL,UUID,MAC_ADDRESS") "${CSV_SERIAL_SETS_FILE}"
+            cat <(echo "DEVICE_MODEL,SERIAL,BOARD_SERIAL,UUID,MAC_ADDRESS,WIDTH,HEIGHT") "${CSV_SERIAL_SETS_FILE}"
 
 
-        [[ -e "${TSV_SERIAL_SETS_FILE}" ]] && \
+        [ -e "${TSV_SERIAL_SETS_FILE}" ] && \
-            cat <(printf "DEVICE_MODEL\tSERIAL\tBOARD_SERIAL\tUUID\tMAC_ADDRESS\n") "${TSV_SERIAL_SETS_FILE}"
+            cat <(printf "DEVICE_MODEL\tSERIAL\tBOARD_SERIAL\tUUID\tMAC_ADDRESS\tWIDTH\tHEIGHT\n") "${TSV_SERIAL_SETS_FILE}"
 
 }
 
 main () {
     # setting default variables if there are no options
+    export DATE_NOW="$(date +%F-%T)"
     export DEVICE_MODEL="${DEVICE_MODEL:=iMacPro1,1}"
+    export VENDOR_REGEX="${VENDOR_REGEX:=Apple, Inc.}"
     export SERIAL_SET_COUNT="${SERIAL_SET_COUNT:=1}"
     export OUTPUT_DIRECTORY="${OUTPUT_DIRECTORY:=.}"
     cat <<EOF
@@ -275,10 +381,12 @@ DEVICE_MODEL:       ${DEVICE_MODEL}
 SERIAL_SET_COUNT:   ${SERIAL_SET_COUNT}
 OUTPUT_DIRECTORY:   ${OUTPUT_DIRECTORY}
 EOF
-    [[ -d "${OUTPUT_DIRECTORY}" ]] || mkdir -p "${OUTPUT_DIRECTORY}"
+    [ -d "${OUTPUT_DIRECTORY}" ] || mkdir -p "${OUTPUT_DIRECTORY}"
-    [[ -e ./macserial ]] || build_mac_serial
+    [ -e ./macserial ] || build_mac_serial
     download_vendor_mac_addresses
+    if [ "${CREATE_BOOTDISKS}" ] || [ "${OUTPUT_BOOTDISK}" ]; then
         download_qcow_efi_folder
+    fi
     generate_serial_sets
     echo "${SERIAL_SETS_FILE}"    
 }

custom/opencore-image-ng.sh

@@ -89,7 +89,7 @@ function fish_fini() {
 	fish umount-all
 }
 
-# disabled by sick.codes to allow unattended image overwrites
+# disabled by @sickcodes to allow unattended image overwrites
 ######################################################################
 # sanity checks
 

fetch-macOS.py

@@ -0,0 +1,447 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+#
+# https://github.com/munki/macadmin-scripts/blob/master/installinstallmacos.py
+#
+# Copyright 2017 Greg Neagle.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Thanks to Tim Sutton for ideas, suggestions, and sample code.
+#
+# Updated in May of 2019 by Dhiru Kholia.
+
+'''installinstallmacos.py
+A tool to download the parts for an Install macOS app from Apple's
+softwareupdate servers and install a functioning Install macOS app onto an
+empty disk image'''
+
+# https://github.com/foxlet/macOS-Simple-KVM/blob/master/tools/FetchMacOS/fetch-macos.py
+# is pretty similar.
+
+
+# Bad hack
+import warnings
+
+warnings.filterwarnings("ignore", category=DeprecationWarning)
+
+import os
+import gzip
+import argparse
+import plistlib
+import subprocess
+
+from xml.dom import minidom
+from xml.parsers.expat import ExpatError
+
+
+import sys
+
+if sys.version_info[0] < 3:
+    import urlparse as urlstuff
+else:
+    import urllib.parse as urlstuff
+# Quick fix for python 3.9 and above
+if sys.version_info[0] == 3 and sys.version_info[1] >= 9:
+    from types import MethodType
+
+    def readPlist(self,filepath):
+        with open(filepath, 'rb') as f:
+            p = plistlib._PlistParser(dict)
+            rootObject = p.parse(f)
+        return rootObject
+    # adding the method readPlist() to plistlib
+    plistlib.readPlist = MethodType(readPlist, plistlib)
+
+# https://github.com/foxlet/macOS-Simple-KVM/blob/master/tools/FetchMacOS/fetch-macos.py (unused)
+# https://github.com/munki/macadmin-scripts
+catalogs = {
+    "CustomerSeed": "https://swscan.apple.com/content/catalogs/others/index-10.16customerseed-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
+    "DeveloperSeed": "https://swscan.apple.com/content/catalogs/others/index-10.16seed-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
+    "PublicSeed": "https://swscan.apple.com/content/catalogs/others/index-10.16beta-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
+    "PublicRelease": "https://swscan.apple.com/content/catalogs/others/index-10.16-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog",
+    "20": "https://swscan.apple.com/content/catalogs/others/index-11-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog"
+}
+
+
+def get_default_catalog():
+    '''Returns the default softwareupdate catalog for the current OS'''
+    return catalogs["20"]
+    # return catalogs["PublicRelease"]
+    # return catalogs["DeveloperSeed"]
+
+
+class ReplicationError(Exception):
+    '''A custom error when replication fails'''
+    pass
+
+
+def cmd_exists(cmd):
+    return subprocess.call("type " + cmd, shell=True,
+                           stdout=subprocess.PIPE, stderr=subprocess.PIPE) == 0
+
+
+def replicate_url(full_url,
+                  root_dir='/tmp',
+                  show_progress=False,
+                  ignore_cache=False,
+                  attempt_resume=False, installer=False, product_title=""):
+    '''Downloads a URL and stores it in the same relative path on our
+    filesystem. Returns a path to the replicated file.'''
+
+    # hack
+    print("[+] Fetching %s" % full_url)
+    if installer and "BaseSystem.dmg" not in full_url and "Big Sur" not in product_title:
+        return
+    if "Big Sur" in product_title and "InstallAssistant.pkg" not in full_url:
+        return
+    attempt_resume = True
+    # path = urllib.parse.urlsplit(full_url)[2]
+    path = urlstuff.urlsplit(full_url)[2]
+    relative_url = path.lstrip('/')
+    relative_url = os.path.normpath(relative_url)
+    # local_file_path = os.path.join(root_dir, relative_url)
+    local_file_path = relative_url
+    # print("Downloading %s..." % full_url)
+
+    if cmd_exists('wget'):
+        if not installer:
+            download_cmd = ['wget', "-c", "--quiet", "-x", "-nH", full_url]
+            # this doesn't work as there are multiple metadata files with the same name!
+            # download_cmd = ['wget', "-c", "--quiet", full_url]
+        else:
+            download_cmd = ['wget', "-c", full_url]
+    else:
+        if not installer:
+            download_cmd = ['curl', "--silent", "--show-error", "-o", local_file_path, "--create-dirs", full_url]
+        else:
+            local_file_path = os.path.basename(local_file_path)
+            download_cmd = ['curl', "-o", local_file_path, full_url]
+
+    try:
+        subprocess.check_call(download_cmd)
+    except subprocess.CalledProcessError as err:
+        raise ReplicationError(err)
+    return local_file_path
+
+
+def parse_server_metadata(filename):
+    '''Parses a softwareupdate server metadata file, looking for information
+    of interest.
+    Returns a dictionary containing title, version, and description.'''
+    title = ''
+    vers = ''
+    try:
+        md_plist = plistlib.readPlist(filename)
+    except (OSError, IOError, ExpatError) as err:
+        print('Error reading %s: %s' % (filename, err), file=sys.stderr)
+        return {}
+    vers = md_plist.get('CFBundleShortVersionString', '')
+    localization = md_plist.get('localization', {})
+    preferred_localization = (localization.get('English') or
+                              localization.get('en'))
+    if preferred_localization:
+        title = preferred_localization.get('title', '')
+
+    metadata = {}
+    metadata['title'] = title
+    metadata['version'] = vers
+
+    """
+    {'title': 'macOS Mojave', 'version': '10.14.5'}
+    {'title': 'macOS Mojave', 'version': '10.14.6'}
+    """
+    return metadata
+
+
+def get_server_metadata(catalog, product_key, workdir, ignore_cache=False):
+    '''Replicate ServerMetaData'''
+    try:
+        url = catalog['Products'][product_key]['ServerMetadataURL']
+        try:
+            smd_path = replicate_url(
+                url, root_dir=workdir, ignore_cache=ignore_cache)
+            return smd_path
+        except ReplicationError as err:
+            print('Could not replicate %s: %s' % (url, err), file=sys.stderr)
+            return None
+    except KeyError:
+        # print('Malformed catalog.', file=sys.stderr)
+        return None
+
+
+def parse_dist(filename):
+    '''Parses a softwareupdate dist file, returning a dict of info of
+    interest'''
+    dist_info = {}
+    try:
+        dom = minidom.parse(filename)
+    except ExpatError:
+        print('Invalid XML in %s' % filename, file=sys.stderr)
+        return dist_info
+    except IOError as err:
+        print('Error reading %s: %s' % (filename, err), file=sys.stderr)
+        return dist_info
+
+    titles = dom.getElementsByTagName('title')
+    if titles:
+        dist_info['title_from_dist'] = titles[0].firstChild.wholeText
+
+    auxinfos = dom.getElementsByTagName('auxinfo')
+    if not auxinfos:
+        return dist_info
+    auxinfo = auxinfos[0]
+    key = None
+    value = None
+    children = auxinfo.childNodes
+    # handle the possibility that keys from auxinfo may be nested
+    # within a 'dict' element
+    dict_nodes = [n for n in auxinfo.childNodes
+                  if n.nodeType == n.ELEMENT_NODE and
+                  n.tagName == 'dict']
+    if dict_nodes:
+        children = dict_nodes[0].childNodes
+    for node in children:
+        if node.nodeType == node.ELEMENT_NODE and node.tagName == 'key':
+            key = node.firstChild.wholeText
+        if node.nodeType == node.ELEMENT_NODE and node.tagName == 'string':
+            value = node.firstChild.wholeText
+        if key and value:
+            dist_info[key] = value
+            key = None
+            value = None
+    return dist_info
+
+
+def download_and_parse_sucatalog(sucatalog, workdir, ignore_cache=False):
+    '''Downloads and returns a parsed softwareupdate catalog'''
+    try:
+        localcatalogpath = replicate_url(
+            sucatalog, root_dir=workdir, ignore_cache=ignore_cache)
+    except ReplicationError as err:
+        print('Could not replicate %s: %s' % (sucatalog, err), file=sys.stderr)
+        exit(-1)
+    if os.path.splitext(localcatalogpath)[1] == '.gz':
+        with gzip.open(localcatalogpath) as the_file:
+            content = the_file.read()
+            try:
+                catalog = plistlib.readPlistFromString(content)
+                return catalog
+            except ExpatError as err:
+                print('Error reading %s: %s' % (localcatalogpath, err), file=sys.stderr)
+                exit(-1)
+    else:
+        try:
+            catalog = plistlib.readPlist(localcatalogpath)
+            return catalog
+        except (OSError, IOError, ExpatError) as err:
+            print('Error reading %s: %s' % (localcatalogpath, err), file=sys.stderr)
+            exit(-1)
+
+
+def find_mac_os_installers(catalog):
+    '''Return a list of product identifiers for what appear to be macOS
+    installers'''
+    mac_os_installer_products = []
+    if 'Products' in catalog:
+        for product_key in catalog['Products'].keys():
+            product = catalog['Products'][product_key]
+            try:
+                if product['ExtendedMetaInfo'][
+                        'InstallAssistantPackageIdentifiers']:
+                    mac_os_installer_products.append(product_key)
+            except KeyError:
+                continue
+
+    return mac_os_installer_products
+
+
+def os_installer_product_info(catalog, workdir, ignore_cache=False):
+    '''Returns a dict of info about products that look like macOS installers'''
+    product_info = {}
+    installer_products = find_mac_os_installers(catalog)
+    for product_key in installer_products:
+        product_info[product_key] = {}
+        filename = get_server_metadata(catalog, product_key, workdir)
+        if filename:
+            product_info[product_key] = parse_server_metadata(filename)
+        else:
+            # print('No server metadata for %s' % product_key)
+            product_info[product_key]['title'] = None
+            product_info[product_key]['version'] = None
+
+        product = catalog['Products'][product_key]
+        product_info[product_key]['PostDate'] = product['PostDate']
+        distributions = product['Distributions']
+        dist_url = distributions.get('English') or distributions.get('en')
+        try:
+            dist_path = replicate_url(
+                dist_url, root_dir=workdir, ignore_cache=ignore_cache)
+        except ReplicationError as err:
+            print('Could not replicate %s: %s' % (dist_url, err),
+                  file=sys.stderr)
+        else:
+            dist_info = parse_dist(dist_path)
+            product_info[product_key]['DistributionPath'] = dist_path
+            product_info[product_key].update(dist_info)
+            if not product_info[product_key]['title']:
+                product_info[product_key]['title'] = dist_info.get('title_from_dist')
+            if not product_info[product_key]['version']:
+                product_info[product_key]['version'] = dist_info.get('VERSION')
+
+    return product_info
+
+
+def replicate_product(catalog, product_id, workdir, ignore_cache=False, product_title=""):
+    '''Downloads all the packages for a product'''
+    product = catalog['Products'][product_id]
+    for package in product.get('Packages', []):
+        # TO-DO: Check 'Size' attribute and make sure
+        # we have enough space on the target
+        # filesystem before attempting to download
+        if 'URL' in package:
+            try:
+                replicate_url(
+                    package['URL'], root_dir=workdir,
+                    show_progress=True, ignore_cache=ignore_cache,
+                    attempt_resume=(not ignore_cache), installer=True, product_title=product_title)
+            except ReplicationError as err:
+                print('Could not replicate %s: %s' % (package['URL'], err), file=sys.stderr)
+                exit(-1)
+        if 'MetadataURL' in package:
+            try:
+                replicate_url(package['MetadataURL'], root_dir=workdir,
+                              ignore_cache=ignore_cache, installer=True)
+            except ReplicationError as err:
+                print('Could not replicate %s: %s' % (package['MetadataURL'], err), file=sys.stderr)
+                exit(-1)
+
+
+def find_installer_app(mountpoint):
+    '''Returns the path to the Install macOS app on the mountpoint'''
+    applications_dir = os.path.join(mountpoint, 'Applications')
+    for item in os.listdir(applications_dir):
+        if item.endswith('.app'):
+            return os.path.join(applications_dir, item)
+    return None
+
+
+def determine_version(version, product_info):
+    if version:
+        if version == 'latest':
+            from distutils.version import StrictVersion
+            latest_version = StrictVersion('0.0.0')
+            for index, product_id in enumerate(product_info):
+                d = product_info[product_id]['version']
+                if d > latest_version:
+                    latest_version = d
+
+            if latest_version == StrictVersion("0.0.0"):
+                print("Could not find latest version {}")
+                exit(1)
+
+            version = str(latest_version)
+
+        for index, product_id in enumerate(product_info):
+            v = product_info[product_id]['version']
+            if v == version:
+                return product_id, product_info[product_id]['title']
+
+        print("Could not find version {}. Versions available are:".format(version))
+        for _, pid in enumerate(product_info):
+            print("- {}".format(product_info[pid]['version']))
+
+        exit(1)
+
+    # display a menu of choices (some seed catalogs have multiple installers)
+    print('%2s %12s %10s %11s  %s' % ('#', 'ProductID', 'Version',
+                                           'Post Date', 'Title'))
+    for index, product_id in enumerate(product_info):
+        print('%2s %12s %10s %11s  %s' % (
+            index + 1,
+            product_id,
+            product_info[product_id]['version'],
+            product_info[product_id]['PostDate'].strftime('%Y-%m-%d'),
+            product_info[product_id]['title']
+        ))
+
+    answer = input(
+        '\nChoose a product to download (1-%s): ' % len(product_info))
+    try:
+        index = int(answer) - 1
+        if index < 0:
+            raise ValueError
+        product_id = list(product_info.keys())[index]
+        return product_id, product_info[product_id]['title']
+    except (ValueError, IndexError):
+        pass
+
+    print('Invalid input provided.')
+    exit(0)
+
+
+def main():
+    '''Do the main thing here'''
+    """
+    if os.getuid() != 0:
+        sys.exit('This command requires root (to install packages), so please '
+                 'run again with sudo or as root.')
+    """
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--workdir', metavar='path_to_working_dir',
+                        default='.',
+                        help='Path to working directory on a volume with over '
+                             '10G of available space. Defaults to current working '
+                             'directory.')
+    parser.add_argument('--version', metavar='version',
+                        default=None,
+                        help='The version to download in the format of '
+                             '"$major.$minor.$patch", e.g. "10.15.4". Can '
+                             'be "latest" to download the latest version.')
+    parser.add_argument('--compress', action='store_true',
+                        help='Output a read-only compressed disk image with '
+                             'the Install macOS app at the root. This is now the '
+                             'default. Use --raw to get a read-write sparse image '
+                             'with the app in the Applications directory.')
+    parser.add_argument('--raw', action='store_true',
+                        help='Output a read-write sparse image '
+                             'with the app in the Applications directory. Requires '
+                             'less available disk space and is faster.')
+    parser.add_argument('--ignore-cache', action='store_true',
+                        help='Ignore any previously cached files.')
+    args = parser.parse_args()
+
+    su_catalog_url = get_default_catalog()
+    if not su_catalog_url:
+        print('Could not find a default catalog url for this OS version.', file=sys.stderr)
+        exit(-1)
+
+    # download sucatalog and look for products that are for macOS installers
+    catalog = download_and_parse_sucatalog(
+        su_catalog_url, args.workdir, ignore_cache=args.ignore_cache)
+    product_info = os_installer_product_info(
+        catalog, args.workdir, ignore_cache=args.ignore_cache)
+
+    if not product_info:
+        print('No macOS installer products found in the sucatalog.', file=sys.stderr)
+        exit(-1)
+
+    product_id, product_title = determine_version(args.version, product_info)
+    print(product_id, product_title)
+
+    # download all the packages for the selected product
+    replicate_product(catalog, product_id, args.workdir, ignore_cache=args.ignore_cache, product_title=product_title)
+
+
+if __name__ == '__main__':
+    main()

osx-serial-generator

@@ -0,0 +1 @@
+Subproject commit 1d7425a7fa929423d965334cd78e9c75aeff2ad0

tests/test.sh

@@ -0,0 +1,301 @@
+#!/usr/bin/docker
+#     ____             __             ____  ______  __
+#    / __ \____  _____/ /_____  _____/ __ \/ ___/ |/ /
+#   / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \|   /
+#  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |
+# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_| TESTS
+#
+# Title:            Docker-OSX (Mac on Docker)
+# Author:           Sick.Codes https://twitter.com/sickcodes
+# Version:          4.2
+# License:          GPLv3+
+# Repository:       https://github.com/sickcodes/Docker-OSX
+# Website:          https://sick.codes
+#
+# Status:           Work in progress.
+# 
+
+help_text="Usage: ./test.sh --branch <string> --repo <string>
+
+General options:
+    --branch, -b <string>               Git branch, default is master
+    --repo, -r <url>                    Alternative link to build
+    --mirror-country, -m <SS>           Two letter country code for Arch mirrors
+    --docker-username, -u <string>      Docker hub username
+    --docker-password, -p <string>      Docker hub password
+    --vnc-password, -v <string>         Choose a VNC passwd.
+
+Flags
+    --no-cache, -n                      Enable --no-cache (default already)
+    --no-no-cache, -nn                  Disable --no-cache docker builds
+    --help, -h, help                    Display this help and exit
+"
+
+# set -xeuf -o pipefail
+
+
+# gather arguments
+while (( "$#" )); do
+    case "${1}"  in
+
+    --help | -h | h | help ) 
+                echo "${help_text}" && exit 0
+            ;;
+
+    --branch=* | -b=* )
+                export BRANCH="${1#*=}"
+                shift
+            ;;
+    --branch* | -b* )
+                export BRANCH="${2}"
+                shift
+                shift
+            ;;
+    --repo=* | -r=* )
+                export REPO="${1#*=}"
+                shift
+            ;;
+    --repo* | -r* )
+                export REPO="${2}"
+                shift
+                shift
+            ;;
+    --mirror-country=* | -m=* )
+                export MIRROR_COUNTRY="${1#*=}"
+                shift
+            ;;
+    --mirror-country* | -m* )
+                export MIRROR_COUNTRY="${2}"
+                shift
+                shift
+            ;;
+    --vnc-password=* | -v=* | --vnc-passwd=* )
+                export VNC_PASSWORD="${1#*=}"
+                shift
+            ;;
+    --vnc-password* | -v* | --vnc-passwd* )
+                export VNC_PASSWORD="${2}"
+                shift
+                shift
+            ;;
+    --docker-username=* | -u=* )
+                export DOCKER_USERNAME="${1#*=}"
+                shift
+            ;;
+    --docker-username* | -u* )
+                export DOCKER_USERNAME="${2}"
+                shift
+                shift
+            ;;
+    --docker-password=* | -p=* )
+                export DOCKER_PASSWORD="${1#*=}"
+                shift
+            ;;
+    --docker-password* | -p* )
+                export DOCKER_PASSWORD="${2}"
+                shift
+                shift
+            ;;
+    --no-cache | -n )
+                export NO_CACHE='--no-cache'
+                shift
+            ;;
+    --no-no-cache | -nn )
+                export NO_CACHE=
+                shift
+            ;;
+    *)
+                echo "Invalid option: ${1}"
+                exit 1
+            ;;
+
+    esac
+done
+
+BRANCH="${BRANCH:=master}"
+REPO="${REPO:=https://github.com/sickcodes/Docker-OSX.git}"
+VNC_PASSWORD="${VNC_PASSWORD:=testing}"
+MIRROR_COUNTRY="${MIRROR_COUNTRY:=US}"
+NO_CACHE="${NO_CACHE:=--no-cache}"
+
+
+TEST_BUILDS=(
+'docker-osx:latest'
+'docker-osx:naked'
+'docker-osx:big-sur'
+'docker-osx:auto'
+#'docker-osx:auto-big-sur'
+)
+
+install_docker () {
+    apt remove docker docker-engine docker.io containerd runc -y \
+    ; apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common -y \
+    && curl -fsSL https://download.docker.com/linux/ubuntu/gpg |  apt-key add - \
+    && apt-key fingerprint 0EBFCD88 \
+    && add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" \
+    && apt update -y \
+    && apt install docker-ce docker-ce-cli containerd.io -y \
+    && usermod -aG docker "${USER}" \
+    && su hook docker run --rm hello-world
+}
+
+install_vnc () {
+    apt update -y \
+        && apt install xorg openbox tigervnc-standalone-server tigervnc-common tigervnc-xorg-extension tigervnc-viewer -y \
+        && mkdir -p ${HOME}/.vnc \
+        && touch ~/.vnc/config \
+        && tee -a ~/.vnc/config <<< 'geometry=1920x1080' \
+        && tee -a ~/.vnc/config <<< 'localhost' \
+        && tee -a ~/.vnc/config <<< 'alwaysshared' \
+        && touch ./vnc.sh \
+        && printf '\n%s\n' \
+            'sudo rm -f /tmp/.X99-lock' \
+            'export DISPLAY=:99' \
+            '/usr/bin/Xvnc -geometry 1920x1080 -rfbauth ~/.vnc/passwd :99 &' > ./vnc.sh \
+        && tee vncpasswd_file <<< "${VNC_PASSWORD:=testing}" && echo "${VNC_PASSWORD:="$(tr -dc '[:graph:]' </dev/urandom | head -c8)"}" \
+        && vncpasswd -f < vncpasswd_file > ${HOME}/.vnc/passwd \
+        && chmod 600 ~/.vnc/passwd \
+        && apt install qemu qemu-kvm libvirt-clients libvirt-daemon-system bridge-utils virt-manager -y \
+        && sudo systemctl enable libvirtd.service \
+        && sudo systemctl enable virtlogd.service \
+        && echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs \
+        && sudo modprobe kvm \
+        && echo 'export DISPLAY=:99' >> ~/.bashrc \
+        && printf '\n\n\n\n%s\n%s\n\n\n\n' '===========VNC_PASSWORD========== ' "$(<vncpasswd_file)"
+    # ufw allow 5999
+}
+
+install_scrotcat () {
+    apt update -y
+    apt install git curl wget vim xvfb scrot build-essential sshpass -y
+    git clone https://github.com/stolk/imcat.git
+    make -C ./imcat
+    sudo cp ./imcat/imcat /usr/bin/imcat
+    touch /usr/bin/scrotcat
+    tee -a /usr/bin/scrotcat <<< '/usr/bin/imcat <(scrot -o /dev/stdout)'
+    chmod +x /usr/bin/scrotcat
+}
+
+export_display_99 () {
+    touch ~/.bashrc
+    tee -a ~/.bashrc <<< 'export DISPLAY=:99'
+    export DISPLAY=:99
+}
+
+start_xvfb () {
+    nohup Xvfb :99 -screen 0 1920x1080x16 &
+}
+
+start_vnc () {
+    nohup bash vnc.sh &
+}
+
+enable_kvm () {
+    echo 1 | tee /sys/module/kvm/parameters/ignore_msrs
+}
+
+
+clone_repo () {
+    git clone --branch="${1}" "${2}" Docker-OSX
+}
+
+
+docker-osx:latest () {
+    docker build ${NO_CACHE} \
+        --build-arg BRANCH="${BRANCH}" \
+        --build-arg RANKMIRRORS=true \
+        --build-arg MIRROR_COUNTRY="${MIRROR_COUNTRY}" \
+        -f ./Dockerfile \
+        -t docker-osx:latest .
+    docker tag docker-osx:latest sickcodes/docker-osx:latest
+}
+
+
+docker-osx:naked () {
+    docker build ${NO_CACHE} \
+        --build-arg RANKMIRRORS=true \
+        --build-arg MIRROR_COUNTRY="${MIRROR_COUNTRY}" \
+        -f ./Dockerfile.naked \
+        -t docker-osx:naked .
+    docker tag docker-osx:naked sickcodes/docker-osx:naked
+}
+
+
+docker-osx:big-sur () {
+    docker build ${NO_CACHE} \
+        --build-arg VERSION=11 \
+        --build-arg RANKMIRRORS=true \
+        --build-arg MIRROR_COUNTRY="${MIRROR_COUNTRY}" \
+        -f ./Dockerfile \
+        -t docker-osx:big-sur .
+    docker tag docker-osx:big-sur sickcodes/docker-osx:big-sur
+}
+
+docker-osx:auto () {
+    docker build ${NO_CACHE} \
+        --build-arg RANKMIRRORS=true \
+        --build-arg MIRROR_COUNTRY="${MIRROR_COUNTRY}" \
+        -f ./Dockerfile.auto \
+        -t docker-osx:auto .
+    docker tag docker-osx:auto sickcodes/docker-osx:auto
+}
+
+docker-osx:auto-big-sur () {
+    docker build ${NO_CACHE} \
+        --build-arg RANKMIRRORS=true \
+        --build-arg MIRROR_COUNTRY="${MIRROR_COUNTRY}" \
+        --build-arg IMAGE_URL='https://images.sick.codes/mac_hdd_ng_auto_big_sur.img' \
+        -f ./Dockerfile.auto \
+        -t docker-osx:auto-big-sur .
+    docker tag docker-osx:auto-big-sur sickcodes/docker-osx:auto-big-sur
+}
+
+reset_docker_hard () {
+    systemctl disable --now docker
+    systemctl disable --now docker.socket
+    systemctl stop docker
+    systemctl stop docker.socket
+    rm -rf /var/lib/docker
+    systemctl enable --now docker
+}
+
+tee -a ~/.bashrc <<EOF ; true &&
+export DEBIAN_FRONTEND=noninteractive
+export TZ=UTC
+EOF
+export DEBIAN_FRONTEND=noninteractive \
+; export TZ=UTC \
+; ln -snf "/usr/share/zoneinfo/${TZ}" /etc/localtime \
+; tee -a /etc/timezone <<< "${TZ}" \
+; apt update -y \
+; apt-get install keyboard-configuration -y \
+; docker -v | grep '\ 20\.\|\ 19\.' || install_docker \
+; yes | apt install -y --no-install-recommends tzdata -y \
+; install_scrotcat \
+; yes | install_vnc \
+; export_display_99 \
+; echo start_xvfb \
+; start_vnc \
+; enable_kvm \
+; echo reset_docker_hard \
+; echo killall Xvfb \
+; clone_repo "${BRANCH}" "${REPO}" \
+; cd Docker-OSX \
+; for TEST_BUILD in "${TEST_BUILDS[@]}"; do
+    "${TEST_BUILD}"
+done \
+&& touch COMPLETED
+
+if [[ "${DOCKER_USERNAME}" ]] && [[ "${DOCKER_PASSWORD}" ]]; then
+    docker login --username "${DOCKER_USERNAME}" --password "${DOCKER_PASSWORD}" \
+        && docker push sickcodes/docker-osx:latest \
+        && docker push sickcodes/docker-osx:big-sur \
+        && docker push sickcodes/docker-osx:naked \
+        && docker push sickcodes/docker-osx:auto \
+        && docker push sickcodes/docker-osx:auto-big-sur \
+        && touch PUSHED
+fi
+
+# connect remotely to your server to use VNC
+# ssh -N root@1.1.1.1 -L  5999:127.0.0.1:5999
+

vnc-version/Dockerfile

@@ -7,7 +7,7 @@
 # 
 # Title:            Mac on Docker (Docker-OSX) [VNC EDITION]
 # Author:           Sick.Codes https://sick.codes/        
-# Version:          3.0
+# Version:          3.1
 # License:          GPLv3+
 # 
 # All credits for OSX-KVM and the rest at Kholia's repo: https://github.com/kholia/osx-kvm
@@ -113,7 +113,7 @@ RUN cat vnc.sh Launch.sh > Launch_custom.sh
 
 RUN chmod +x Launch_custom.sh
 
-RUN tee vncpasswd_file <<< "${VNC_PASSWORD:=$(openssl rand -hex 4)}"
+RUN tee vncpasswd_file <<< "${VNC_PASSWORD:="$(tr -dc '[:graph:]' </dev/urandom | head -c8)"}"
 RUN vncpasswd -f < vncpasswd_file > ${HOME}/.vnc/passwd
 
 RUN chmod 600 ~/.vnc/passwd

vnc-version/Dockerfile.nakedvnc

@@ -0,0 +1,208 @@
+#!/usr/bin/docker
+#     ____             __             ____  ______  __
+#    / __ \____  _____/ /_____  _____/ __ \/ ___/ |/ /
+#   / / / / __ \/ ___/ //_/ _ \/ ___/ / / /\__ \|   / 
+#  / /_/ / /_/ / /__/ ,< /  __/ /  / /_/ /___/ /   |  
+# /_____/\____/\___/_/|_|\___/_/   \____//____/_/|_|  :NAKED
+# 
+# Title:            Docker-OSX (Mac on Docker)
+# Author:           Sick.Codes https://twitter.com/sickcodes
+# Version:          4.3
+# License:          GPLv3+
+# Repository:       https://github.com/sickcodes/Docker-OSX
+# Website:          https://sick.codes
+# 
+# This image won't run unless you supply a disk image using:
+#       -v ${PWD}/mac_hdd_ng.img:/image
+# 
+# Take screenshots in the Arch container and display in terminal: scrotcat
+#
+# Build:
+# 
+#       docker build -t docker-osx:naked -f Dockerfile.naked .
+# 
+# Run headless:
+# 
+#       docker run -it --device /dev/kvm -p 50922:10022 -v ${PWD}/mac_hdd_ng.img:/image docker-osx:naked
+# 
+# Run with display:
+# 
+#       docker run -it --device /dev/kvm -p 50922:10022 -v ${PWD}/mac_hdd_ng.img:/image -e "DISPLAY=${DISPLAY:-:0.0}" -v /tmp/.X11-unix:/tmp/.X11-unix docker-osx:naked
+# 
+
+FROM sickcodes/docker-osx:latest
+
+MAINTAINER 'https://twitter.com/sickcodes' <https://sick.codes>
+
+USER root
+
+WORKDIR /root
+
+RUN rm -f /home/arch/OSX-KVM/mac_hdd_ng.img
+
+# OPTIONAL: Arch Linux server mirrors for super fast builds
+# set RANKMIRRORS to any value other that nothing, e.g. -e RANKMIRRORS=true
+ARG RANKMIRRORS
+ARG MIRROR_COUNTRY=US
+ARG MIRROR_COUNT=10
+RUN if [[ "${RANKMIRRORS}" ]]; then { pacman -Sy wget --noconfirm || pacman -Syu wget --noconfirm ; } \
+    ; wget -O ./rankmirrors "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/rankmirrors" \
+    ; wget -O- "https://www.archlinux.org/mirrorlist/?country=${MIRROR_COUNTRY:-US}&protocol=https&use_mirror_status=on" \
+    | sed -e 's/^#Server/Server/' -e '/^#/d' \
+    | head -n "$((${MIRROR_COUNT:-10}+1))" \
+    | bash ./rankmirrors --verbose --max-time 5 - > /etc/pacman.d/mirrorlist \
+    && tee -a /etc/pacman.d/mirrorlist <<< 'Server = http://mirrors.evowise.com/archlinux/$repo/os/$arch' \
+    && tee -a /etc/pacman.d/mirrorlist <<< 'Server = http://mirror.rackspace.com/archlinux/$repo/os/$arch' \
+    && tee -a /etc/pacman.d/mirrorlist <<< 'Server = https://mirror.rackspace.com/archlinux/$repo/os/$arch' \
+    && cat /etc/pacman.d/mirrorlist ; fi
+
+# TEMP-FIX for pacman issue
+RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for pacman issue
+
+# For taking screenshots of the Xfvb screen, useful during development.
+ARG SCROT
+
+RUN pacman -Syu xorg-server-xvfb wget xterm xorg-xhost xorg-xrandr sshpass --noconfirm \
+    && if [[ "${SCROT}" ]]; then \
+        pacman -Syu scrot base-devel --noconfirm \
+        && git clone --recurse-submodules --depth 1 https://github.com/stolk/imcat.git \
+        && cd imcat \
+        && make \
+        && sudo cp imcat /usr/bin/imcat \
+        && touch /usr/bin/scrotcat \
+        && tee -a /usr/bin/scrotcat <<< '/usr/bin/imcat <(scrot -o /dev/stdout)' \
+        && chmod +x /usr/bin/scrotcat \
+    ; else \
+        touch /usr/bin/scrotcat \
+        && echo echo >> /usr/bin/scrotcat \
+        && chmod +x /usr/bin/scrotcat \
+    ; fi \
+    ; yes | pacman -Scc
+
+# TEMP-FIX for pacman issue
+RUN patched_glibc=glibc-linux4-2.33-4-x86_64.pkg.tar.zst \
+    && curl -LO "https://raw.githubusercontent.com/sickcodes/Docker-OSX/master/${patched_glibc}" \
+    && bsdtar -C / -xvf "${patched_glibc}" || echo "Everything is fine."
+# TEMP-FIX for pacman issue
+
+USER arch
+
+WORKDIR /home/arch/OSX-KVM
+
+RUN mkdir -p ~/.ssh \
+    && touch ~/.ssh/authorized_keys \
+    && touch ~/.ssh/config \
+    && chmod 700 ~/.ssh \
+    && chmod 600 ~/.ssh/config \
+    && chmod 600 ~/.ssh/authorized_keys \
+    && tee -a ~/.ssh/config <<< 'Host *' \
+    && tee -a ~/.ssh/config <<< '    StrictHostKeyChecking no' \
+    && tee -a ~/.ssh/config <<< '    UserKnownHostsFile=/dev/null'
+
+#### SPECIAL RUNTIME ARGUMENTS BELOW
+
+ENV ADDITIONAL_PORTS=
+
+ENV BOOTDISK=
+
+ENV DISPLAY=:99
+
+ENV HEADLESS=false
+
+ENV ENV=/env
+
+# Boolean for generating a bootdisk with new random serials.
+ENV GENERATE_UNIQUE=false
+
+# Boolean for generating a bootdisk with specific serials.
+ENV GENERATE_SPECIFIC=false
+
+ENV IMAGE_PATH=/image
+ENV IMAGE_FORMAT=qcow2
+
+ENV KVM='accel=kvm:tcg'
+
+# ENV MASTER_PLIST_URL="https://raw.githubusercontent.com/sickcodes/osx-serial-generator/master/config-custom.plist"
+
+# ENV NETWORKING=e1000-82545em
+ENV NETWORKING=vmxnet3
+
+ENV NOPICKER=true
+
+# dynamic RAM options for runtime
+ENV RAM=8
+# ENV RAM=max
+# ENV RAM=half
+
+# The x and y coordinates for resolution.
+# Must be used with either -e GENERATE_UNIQUE=true or -e GENERATE_SPECIFIC=true.
+ENV WIDTH=1920
+ENV HEIGHT=1080
+
+CMD sudo touch /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \
+    ; sudo chown -R $(id -u):$(id -g) /dev/kvm /dev/snd "${IMAGE_PATH}" "${BOOTDISK}" "${ENV}" || true \
+    ; { [[ "${DISPLAY}" = ':99' ]] || [[ "${HEADLESS}" == true ]] ; } && { \
+        nohup Xvfb :99 -screen 0 1920x1080x16 \
+        & until [[ "$(xrandr --query 2>/dev/null)" ]]; do sleep 1 ; done \
+    ; } \
+    ; [[ "${NOPICKER}" == true ]] && { \
+        sed -i '/^.*InstallMedia.*/d' Launch.sh \
+        && export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore-nopicker.qcow2}" \
+    ; } \
+    || export BOOTDISK="${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+    ; [[ "${GENERATE_UNIQUE}" == true ]] && { \
+        ./Docker-OSX/osx-serial-generator/generate-unique-machine-values.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
+            --count 1 \
+            --tsv ./serial.tsv \
+            --bootdisks \
+            --width "${WIDTH:-1920}" \
+            --height "${HEIGHT:-1080}" \
+            --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+            --output-env "${ENV:=/env}" \
+    ; } \
+    ; [[ "${GENERATE_SPECIFIC}" == true ]] && { \
+            source "${ENV:=/env}" 2>/dev/null \
+            ; ./Docker-OSX/osx-serial-generator/generate-specific-bootdisk.sh \
+            --master-plist-url="${MASTER_PLIST_URL}" \
+            --model "${DEVICE_MODEL}" \
+            --serial "${SERIAL}" \
+            --board-serial "${BOARD_SERIAL}" \
+            --uuid "${UUID}" \
+            --mac-address "${MAC_ADDRESS}" \
+            --width "${WIDTH:-1920}" \
+            --height "${HEIGHT:-1080}" \
+            --output-bootdisk "${BOOTDISK:=/home/arch/OSX-KVM/OpenCore-Catalina/OpenCore.qcow2}" \
+    ; } \
+    # ; ./enable-ssh.sh && /bin/bash -c ./Launch.sh
+
+WORKDIR /home/arch/OSX-KVM
+
+RUN sudo pacman -Syyuu --noconfirm \
+    && sudo pacman -S tigervnc xterm xorg-xhost xdotool ufw --noconfirm \
+    && mkdir -p ${HOME}/.vnc \
+    && touch ~/.vnc/config \
+    && tee -a ~/.vnc/config <<< 'geometry=1920x1080' \
+    && tee -a ~/.vnc/config <<< 'localhost' \
+    && tee -a ~/.vnc/config <<< 'alwaysshared'
+
+RUN printf '\n%s\n' \
+'sudo rm -f /tmp/.X99-lock' \
+'export DISPLAY=:99' \
+'/usr/bin/Xvnc -geometry 1920x1080 -rfbauth "${HOME}/.vnc/passwd" :99 &' > vnc.sh
+
+RUN cat vnc.sh Launch.sh > Launch_custom.sh
+
+RUN chmod +x Launch_custom.sh
+
+RUN tee vncpasswd_file <<< "${VNC_PASSWORD:="$(tr -dc '[:graph:]' </dev/urandom | head -c8)"}"
+RUN vncpasswd -f < vncpasswd_file > ${HOME}/.vnc/passwd
+
+RUN chmod 600 ~/.vnc/passwd
+RUN printf '\n\n\n\n%s\n%s\n\n\n\n' '===========VNC_PASSWORD========== ' "$(<vncpasswd_file)"
+
+CMD ./enable-ssh.sh && envsubst < ./Launch_custom.sh | bash
+