diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c640255 --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +config/vms_ready/ +config/vms_supported/ +#*.chunklist +*.conf +*.dmg +*.fd +*.img +*.iso +*.lock +*.log +*.msi +*.part +*.permall +*.pid +*.ports +*.qcow2 +#*.sh +*.sock +*.xml +*.zs-old diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e4b350d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Wimpy's World + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d689124 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +Welcome to + +### [yadEmu](https://github.com/oSoWoSo/yadEmu) +### Still Testing version! +![yadEmu](yadEmu.png) + + +quickly create and run VMs + +Using excellent [quickemu](https://github.com/quickemu-project/quickemu) as base + +I added: + +### quickgui + using yad + + It will simple generate .desktop files for every supported VM in quickemu. + So you can copy it anywhere... + + And I mean every supported distro. + + you can download new distro with few clicks of a mouse + + You need to run quickgui just for update. + +See it in action on youtube... + +[![quickgui](https://img.youtube.com/vi/JtjIseqZMkQ/0.jpg)](https://www.youtube.com/watch?v=JtjIseqZMkQ) + + or command line?... + + +### quicktui + using fzf + +[![quicktui](https://img.youtube.com/vi/gJ5hqYEskOw/0.jpg)](https://www.youtube.com/watch?v=gJ5hqYEskOw) + +### Testing version! + +# Without these amazing projects it wouldn't be posible: + +[QEMU](https://www.qemu.org/) + +[bash](https://www.gnu.org/software/bash/) + +[quickemu](https://github.com/quickemu-project/quickemu) + +GUI depends on +[yad](https://github.com/v1cont/yad) + +TUI depends on +[fzf](https://github.com/junegunn/fzf) diff --git a/addnewtoquickgui.sh b/addnewtoquickgui.sh new file mode 100755 index 0000000..86b246b --- /dev/null +++ b/addnewtoquickgui.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +yad --form --field="Name" "" --field="Releases" "" --field="Editions" "" --field="URL" "" --field="ISO" "" + +# little script for adding distros to quickemu +# This version use desktop files and notebook + +#TODO ADD_PRETTY_NAME_${DISTRO} + ${DISTRO}) PRETTY_NAME="VX Linux";; + +#TODO ADD_NAME_${DISTRO} + ${DISTRO} \ + +#TODO ADD_releases_${DISTRO} function +function releases_${DISTRO}() { + echo 6.1 5.0 4.2 4.1 4.0 +} +#TODO ADD_editions_${DISTRO} function +function editions_${DISTRO}() { + echo +} +#TODO ADD_get_${DISTRO} function +function get_${DISTRO}() { + local HASH="" + local ISO="" + local URL="https://github.com/dessington/${DISTRO}/releases/download/${RELEASE}" + + if [ "$RELEASE" == "4.0" ]; then + ISO="vx-linux-4.0-qt.iso" + else + ISO="vx-linux-${RELEASE}.iso" + fi + echo "${URL}/${ISO} ${HASH}" +} + +function get_voidpup() { + local HASH="" + local URL="" + local TMPURL="" + + TMPURL=$(wget -q -S -O- --max-redirect=0 "https://sourceforge.net/projects/vpup/files/latest/download" 2>&1 | grep -i Location | cut -d' ' -f4) + URL=${TMPURL%\?*} + echo "${URL} ${HASH}" +} diff --git a/config/about.desktop b/config/about.desktop index ac01378..3212777 100644 --- a/config/about.desktop +++ b/config/about.desktop @@ -1,6 +1,6 @@ [Desktop Entry] Type=Application -Name=About +Name=About yad Exec=yad --about -Icon=/home/zen/.config/quickemu/vms-icons/cereus.svg +Icon=/home/zen/.config/quickemu/vms_icons/cereus.svg Categories=System;Virtualization;Settings; diff --git a/config/add_distro.desktop b/config/add_distro.desktop old mode 100644 new mode 100755 index ac01378..fa6bf0c --- a/config/add_distro.desktop +++ b/config/add_distro.desktop @@ -1,6 +1,6 @@ [Desktop Entry] Type=Application -Name=About -Exec=yad --about -Icon=/home/zen/.config/quickemu/vms-icons/cereus.svg +Name=Add new distro +Exec=sakura -h -e /home/zen/.config/quickemu/add_distro.sh +Icon=/home/zen/.config/quickemu/vms_icons/cereus.svg Categories=System;Virtualization;Settings; diff --git a/config/add_distro.sh b/config/add_distro.sh new file mode 100755 index 0000000..7ef26bd --- /dev/null +++ b/config/add_distro.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +yad --form --field="Pretty name" "" --field="Name" "" --field="Releases" "" --field="Editions" "" --field="URL" "" --field="ISO" "" + diff --git a/config/check.sh b/config/check.sh new file mode 100755 index 0000000..c5a2d41 --- /dev/null +++ b/config/check.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# DEBUG mod +#bash -x quickyad 2>&1 | tee output.log + +# YAD gui script for excellent quickemu +#TODO Download Icons +#TODO Add homepages to right click + +echo "Running..." +# dependencies checks +if ! command -v yad >/dev/null 2>&1; then + echo "You are missing yad..." >&2 + exit 1 +fi +if ! command -v quickemu >/dev/null 2>&1; then + echo "You are missing quickemu..." >&2 + exit 1 +fi diff --git a/config/regenerate.desktop b/config/regenerate.desktop deleted file mode 100644 index 737bcbb..0000000 --- a/config/regenerate.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=Renew supported VMs -Exec=renew.sh -Icon=/home/zen/.config/quickemu/vms-icons/tux.svg -Categories=System;Virtualization;Settings; diff --git a/config/regenerate.sh b/config/regenerate.sh deleted file mode 100644 index e69de29..0000000 diff --git a/config/reload_ready.desktop b/config/reload_ready.desktop new file mode 100644 index 0000000..2f22060 --- /dev/null +++ b/config/reload_ready.desktop @@ -0,0 +1,6 @@ +[Desktop Entry] +Type=Application +Name=Renew ready VMs +Exec=reload_ready.sh +Icon=/home/zen/.config/quickemu/vms_icons/tux.svg +Categories=System;Virtualization;Settings; diff --git a/config/reload_ready.sh b/config/reload_ready.sh new file mode 100755 index 0000000..f319644 --- /dev/null +++ b/config/reload_ready.sh @@ -0,0 +1,40 @@ +#!/bin/bash + +echo "Updating VMs..." +QUICKEMU_VMS_DIR="$HOME/.local/share/quickemu" +CONFIG_DIR="$HOME/.config/quickemu" +ICON_DIR="$CONFIG_DIR/vms_icons" +export "QUICKEMU_VMS_DIR" "CONFIG_DIR" "ICON_DIR" +# create default dirs if they are not present +mkdir -p "$CONFIG_DIR" "$CONFIG_DIR/vms_ready" "$CONFIG_DIR/vms_supported" +# remove desktop files (ready to run VMs) +rm "$CONFIG_DIR"/vms_ready/* +# Enter quickemu VMs dir +cd "$QUICKEMU_VMS_DIR" || exit +# check for VMs .conf files (ready to run VMs) +for vm_config_file in *.conf; do + vm_desktop_file=$(basename "$QUICKEMU_VMS_DIR/$vm_config_file" .conf) + # Use fuzzy matching to find the best matching icon file (ready to run VMs) + icon_name=$(basename "$QUICKEMU_VMS_DIR/$vm_config_file" .conf | cut -d'-' -f -2) + icon_file=$(find "$ICON_DIR" -type f -iname "${icon_name// /}.*") + # If no icon was found, try shorter name (ready to run VMs) + if [ -z "$icon_file" ]; then + icon_name=$(basename "$QUICKEMU_VMS_DIR/$vm_config_file" .conf | cut -d'-' -f1) + icon_file=$(find "$ICON_DIR" -type f -iname "${icon_name// /}.*") + fi + # If no icon was found, use a default icon (ready to run VMs) + if [ -z "$icon_file" ]; then + icon_file="$ICON_DIR/tux.svg" + fi + # content of desktop files (ready to run VMs) + desktop_file_content="[Desktop Entry] +Type=Application +Name=$vm_desktop_file +Exec=quickemu -vm \"$vm_config_file\" +Icon=$icon_file +Categories=System;Virtualization;" + # create desktop files (ready to run VMs) + echo "$desktop_file_content" > "$CONFIG_DIR"/vms_ready/"$vm_desktop_file".desktop +done +echo "Done" +exit 0 diff --git a/config/set_dir.desktop b/config/set_dir.desktop index 6b617ca..ea9d22e 100644 --- a/config/set_dir.desktop +++ b/config/set_dir.desktop @@ -2,5 +2,5 @@ Type=Application Name=Set working dir Exec=set_dir.sh -Icon=/home/zen/.config/quickemu/vms-icons/cereus.svg +Icon=/home/zen/.config/quickemu/vms_icons/cereus.svg Categories=System;Virtualization;Settings; diff --git a/config/set_dir.sh b/config/set_dir.sh old mode 100644 new mode 100755 index e69de29..a9bf588 --- a/config/set_dir.sh +++ b/config/set_dir.sh @@ -0,0 +1 @@ +#!/bin/bash diff --git a/config/vms_icons/README.md b/config/vms_icons/README.md deleted file mode 100644 index 1f8ac12..0000000 --- a/config/vms_icons/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# distro-svg - -Collection of distro icons in svg format, if your favorite distro is missing open a issue, PR are welcomed . \ -note that these are not mine, I just collected theme from various places . diff --git a/config/vms_icons/vxlinux.png b/config/vms_icons/vxlinux.png deleted file mode 100644 index e1b0444..0000000 Binary files a/config/vms_icons/vxlinux.png and /dev/null differ diff --git a/config/vms_icons/vxlinux.svg b/config/vms_icons/vxlinux.svg index d1ceadf..086ff76 100644 --- a/config/vms_icons/vxlinux.svg +++ b/config/vms_icons/vxlinux.svg @@ -2,789 +2,188 @@ + - + fit-margin-bottom="0" + inkscape:zoom="6.4921875" + inkscape:cx="57.684717" + inkscape:cy="64" + inkscape:window-width="1920" + inkscape:window-height="1057" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:current-layer="g8" /> + inkscape:label="Image" + id="g8"> + id="image10" /> diff --git a/config/vms_icons/xerolinux.png b/config/vms_icons/xerolinux.png deleted file mode 100644 index 35deb32..0000000 Binary files a/config/vms_icons/xerolinux.png and /dev/null differ diff --git a/config/vms_icons/xerolinux.svg b/config/vms_icons/xerolinux.svg new file mode 100644 index 0000000..7087e8e --- /dev/null +++ b/config/vms_icons/xerolinux.svg @@ -0,0 +1,112 @@ + + + + diff --git a/config/vms_ready/agarimos-20230305.desktop b/config/vms_ready/agarimos-20230305.desktop deleted file mode 100644 index 6b4cc0b..0000000 --- a/config/vms_ready/agarimos-20230305.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=agarimos-20230305 -Exec=quickemu -vm "agarimos-20230305.conf" -Icon=/home/zen/.config/quickemu/vms_icons/agarimos.png -Categories=System;Virtualization; diff --git a/config/vms_ready/agarimos.desktop b/config/vms_ready/agarimos.desktop deleted file mode 100644 index 2609add..0000000 --- a/config/vms_ready/agarimos.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=agarimos -Exec=quickemu -vm "agarimos.conf" -Icon=/home/zen/.config/quickemu/vms_icons/agarimos.png -Categories=System;Virtualization; diff --git a/config/vms_ready/alpine-3.15.desktop b/config/vms_ready/alpine-3.15.desktop deleted file mode 100644 index 8494f88..0000000 --- a/config/vms_ready/alpine-3.15.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=alpine-3.15 -Exec=quickemu -vm "alpine-3.15.conf" -Icon=/home/zen/.config/quickemu/vms_icons/alpine.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/alpine-latest.desktop b/config/vms_ready/alpine-latest.desktop deleted file mode 100644 index cbc01d1..0000000 --- a/config/vms_ready/alpine-latest.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=alpine-latest -Exec=quickemu -vm "alpine-latest.conf" -Icon=/home/zen/.config/quickemu/vms_icons/alpine.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/archcraft-latest.desktop b/config/vms_ready/archcraft-latest.desktop deleted file mode 100644 index d9a026c..0000000 --- a/config/vms_ready/archcraft-latest.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=archcraft-latest -Exec=quickemu -vm "archcraft-latest.conf" -Icon=/home/zen/.config/quickemu/vms_icons/archcraft.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/cereus.desktop b/config/vms_ready/cereus.desktop deleted file mode 100644 index 6ad95ef..0000000 --- a/config/vms_ready/cereus.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=cereus -Exec=quickemu -vm "cereus.conf" -Icon=/home/zen/.config/quickemu/vms_icons/cereus.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/fvoid.desktop b/config/vms_ready/fvoid.desktop deleted file mode 100644 index b25baad..0000000 --- a/config/vms_ready/fvoid.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=fvoid -Exec=quickemu -vm "fvoid.conf" -Icon=/home/zen/.config/quickemu/vms_icons/tux.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/gabeeos.desktop b/config/vms_ready/gabeeos.desktop deleted file mode 100644 index 7896b00..0000000 --- a/config/vms_ready/gabeeos.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=gabeeos -Exec=quickemu -vm "gabeeos.conf" -Icon=/home/zen/.config/quickemu/vms_icons/gabeeos.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/haiku-r1beta4-x86_64.desktop b/config/vms_ready/haiku-r1beta4-x86_64.desktop deleted file mode 100644 index b5b4725..0000000 --- a/config/vms_ready/haiku-r1beta4-x86_64.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=haiku-r1beta4-x86_64 -Exec=quickemu -vm "haiku-r1beta4-x86_64.conf" -Icon=/home/zen/.config/quickemu/vms_icons/haiku.png -Categories=System;Virtualization; diff --git a/config/vms_ready/netboot-latest.desktop b/config/vms_ready/netboot-latest.desktop new file mode 100644 index 0000000..7800b12 --- /dev/null +++ b/config/vms_ready/netboot-latest.desktop @@ -0,0 +1,6 @@ +[Desktop Entry] +Type=Application +Name=netboot-latest +Exec=quickemu -vm "netboot-latest.conf" +Icon=/home/zen/.config/quickemu/vms_icons/netboot.svg +Categories=System;Virtualization; diff --git a/config/vms_ready/slitaz-core-5in1.desktop b/config/vms_ready/slitaz-core-5in1.desktop deleted file mode 100644 index 45aa000..0000000 --- a/config/vms_ready/slitaz-core-5in1.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=slitaz-core-5in1 -Exec=quickemu -vm "slitaz-core-5in1.conf" -Icon=/home/zen/.config/quickemu/vms_icons/slitaz.png -Categories=System;Virtualization; diff --git a/config/vms_ready/slitaz-core.desktop b/config/vms_ready/slitaz-core.desktop deleted file mode 100644 index 4eb4656..0000000 --- a/config/vms_ready/slitaz-core.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=slitaz-core -Exec=quickemu -vm "slitaz-core.conf" -Icon=/home/zen/.config/quickemu/vms_icons/slitaz.png -Categories=System;Virtualization; diff --git a/config/vms_ready/slitaz-preferred.desktop b/config/vms_ready/slitaz-preferred.desktop deleted file mode 100644 index 1b3f22b..0000000 --- a/config/vms_ready/slitaz-preferred.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=slitaz-preferred -Exec=quickemu -vm "slitaz-preferred.conf" -Icon=/home/zen/.config/quickemu/vms_icons/slitaz.png -Categories=System;Virtualization; diff --git a/config/vms_ready/ubuntu-unity-daily-live.desktop b/config/vms_ready/ubuntu-unity-daily-live.desktop deleted file mode 100644 index c397c67..0000000 --- a/config/vms_ready/ubuntu-unity-daily-live.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=ubuntu-unity-daily-live -Exec=quickemu -vm "ubuntu-unity-daily-live.conf" -Icon=/home/zen/.config/quickemu/vms_icons/ubuntu-unity.png -Categories=System;Virtualization; diff --git a/config/vms_ready/ubuntustudio-dvd.desktop b/config/vms_ready/ubuntustudio-dvd.desktop deleted file mode 100644 index 5c004b7..0000000 --- a/config/vms_ready/ubuntustudio-dvd.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=ubuntustudio-dvd -Exec=quickemu -vm "ubuntustudio-dvd.conf" -Icon=/home/zen/.config/quickemu/vms_icons/ubuntustudio.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/void-current-glibc.desktop b/config/vms_ready/void-current-glibc.desktop deleted file mode 100644 index ac55af7..0000000 --- a/config/vms_ready/void-current-glibc.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=void-current-glibc -Exec=quickemu -vm "void-current-glibc.conf" -Icon=/home/zen/.config/quickemu/vms_icons/void.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/void-current-xfce-glibc.desktop b/config/vms_ready/void-current-xfce-glibc.desktop deleted file mode 100644 index 4987760..0000000 --- a/config/vms_ready/void-current-xfce-glibc.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=void-current-xfce-glibc -Exec=quickemu -vm "void-current-xfce-glibc.conf" -Icon=/home/zen/.config/quickemu/vms_icons/void.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/voidpup.desktop b/config/vms_ready/voidpup.desktop deleted file mode 100644 index 9f6ab80..0000000 --- a/config/vms_ready/voidpup.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=voidpup -Exec=quickemu -vm "voidpup.conf" -Icon=/home/zen/.config/quickemu/vms_icons/voidpup.png -Categories=System;Virtualization; diff --git a/config/vms_ready/vxlinux-6.1.desktop b/config/vms_ready/vxlinux-6.1.desktop deleted file mode 100644 index 7fbed43..0000000 --- a/config/vms_ready/vxlinux-6.1.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=vxlinux-6.1 -Exec=quickemu -vm "vxlinux-6.1.conf" -Icon=/home/zen/.config/quickemu/vms_icons/vxlinux.svg -Categories=System;Virtualization; diff --git a/config/vms_ready/xerolinux-kde.desktop b/config/vms_ready/xerolinux-kde.desktop deleted file mode 100644 index e803ee8..0000000 --- a/config/vms_ready/xerolinux-kde.desktop +++ /dev/null @@ -1,6 +0,0 @@ -[Desktop Entry] -Type=Application -Name=xerolinux-kde -Exec=quickemu -vm "xerolinux-kde.conf" -Icon=/home/zen/.config/quickemu/vms_icons/xerolinux.png -Categories=System;Virtualization; diff --git a/config/vms_supported/xerolinux.desktop b/config/vms_supported/xerolinux.desktop index d2938c3..e418e57 100644 --- a/config/vms_supported/xerolinux.desktop +++ b/config/vms_supported/xerolinux.desktop @@ -4,5 +4,5 @@ Name=xerolinux releases=kde replace='"!"' Exec=sh -c 'cd /home/zen/.local/share/quickemu && yad --form --separator=" " --field="Release:CB" "kde" | xargs -I{} sakura -e "quickget xerolinux {}"' -Icon=/home/zen/.config/quickemu/vms_icons/xerolinux.png +Icon=/home/zen/.config/quickemu/vms_icons/xerolinux.svg Categories=System;Virtualization; diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..71ea07e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,42 @@ +include pandoc-man.mk + +ifeq ($(PREFIX),) + PREFIX := /usr/local +endif + +datarootdir := $(PREFIX)/share +datadir := $(datarootdir) +mandir := $(datarootdir)/man +bindir := $(PREFIX)/bin + +all: quickget.1 quickemu.1 quickemu_conf.1 + +clean: + rm *.1 + +install_docs: all + install -d $(DESTDIR)$(mandir)/man1 + install -m 644 quickget.1 $(DESTDIR)$(mandir)/man1 + install -m 644 quickemu.1 $(DESTDIR)$(mandir)/man1 + install -m 644 quickemu_conf.1 $(DESTDIR)$(mandir)/man1 + +# install -m 644 quickgui.1 $(DESTDIR)$(mandir)/man1 + +install_bins: + install -d $(DESTDIR)$(bindir) + install -m 755 ../quickget $(DESTDIR)$(bindir) + install -m 755 ../quickemu $(DESTDIR)$(bindir) + install -m 755 ../macrecovery $(DESTDIR)$(bindir) + +install: install_bins install_docs + +uninstall:: + rm -f $(DESTDIR)$(mandir)/man1/quickget.1 + rm -f $(DESTDIR)$(mandir)/man1/quickemu.1 + rm -f $(DESTDIR)$(mandir)/man1/quickemu_conf.1 + rm -f $(DESTDIR)$(bindir)/quickget + rm -f $(DESTDIR)$(bindir)/quickemu + rm -f $(DESTDIR)$(bindir)/macrecovery + + +.PHONY: all diff --git a/docs/pandoc-man.mk b/docs/pandoc-man.mk new file mode 100644 index 0000000..90d6ecb --- /dev/null +++ b/docs/pandoc-man.mk @@ -0,0 +1,8 @@ +PANDOC ?= pandoc + +MANSECTION ?= 1 + +MANPAGE.md = $(PANDOC) --standalone $(PANDOCFLAGS) --to man + +%.$(MANSECTION): %.$(MANSECTION).md + $(MANPAGE.md) $< -o $@ \ No newline at end of file diff --git a/docs/quickemu.1 b/docs/quickemu.1 new file mode 100644 index 0000000..39cefe8 --- /dev/null +++ b/docs/quickemu.1 @@ -0,0 +1,932 @@ +.\" Automatically generated by Pandoc 2.19.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "QUICKEMU" "1" "February 4, 2023" "quickemu" "Quickemu User Manual" +.hy +.SH NAME +.PP +quickemu - A quick VM builder and manager +.SH SYNOPSIS +.PP +\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]\&... +.SH DESCRIPTION +.PP +\f[B]quickemu\f[R] will create and run highly optimised desktop virtual +machines for Linux, macOS and Windows +.SH OPTIONS +.TP +\f[B]\[en]vm\f[R] +vm configuration file +.PP +You can also pass optional parameters +.TP +\f[B]\[en]braille\f[R] +Enable braille support. +Requires SDL. +.TP +\f[B]\[en]delete\f[R] +Delete the disk image. +.TP +\f[B]\[en]display\f[R] +Select display backend. +`sdl' (default), `gtk', `none' or `spice' +.TP +\f[B]\[en]fullscreen\f[R] +Starts VM in full screen mode (Ctl+Alt+f to exit) +.TP +\f[B]\[en]ignore-msrs-always\f[R] +Configure KVM to always ignore unhandled machine-specific registers +.TP +\f[B]\[en]screen \f[R] +Use specified screen to determine the window size. +.TP +\f[B]\[en]shortcut\f[R] +Create a desktop shortcut +.TP +\f[B]\[en]snapshot apply \f[R] +Apply/restore a snapshot. +.TP +\f[B]\[en]snapshot create \f[R] +Create a snapshot. +.TP +\f[B]\[en]snapshot delete \f[R] +Delete a snapshot. +.TP +\f[B]\[en]snapshot info\f[R] +Show disk/snapshot info. +.TP +\f[B]\[en]status-quo\f[R] +Do not commit any changes to disk/snapshot. +.TP +\f[B]\[en]version\f[R] +Print version +.SH EXAMPLES +.TP +\f[B]quickemu \[en]vm ubuntu-mate-22.04.conf\f[R] +Launches the VM specified in the file \f[I]ubuntu-mate-22.04.conf\f[R] +.SS Introduction +.PP +Quickly create and run highly optimised desktop virtual machines for +Linux, macOS and Windows; with just two commands. +You decide what operating system you want to run and Quickemu will +figure out the best way to do it for you. +For example: +.IP +.nf +\f[C] +quickget ubuntu-mate 22.04 +quickemu --vm ubuntu-mate-22.04.conf +\f[R] +.fi +.PP +The original objective of the project was to enable quick testing of +Linux distributions where the virtual machine configurations can be +stored anywhere, such as external USB storage or your home directory, +and no elevated permissions are required to run the virtual machines. +\f[B]Quickemu now also includes comprehensive support for macOS and +Windows\f[R]. +.SS Features +.IP \[bu] 2 +\f[B]macOS\f[R] Monterey, Big Sur, Catalina, Mojave & High Sierra +.IP \[bu] 2 +\f[B]Windows\f[R] 8.1, 10 and 11 including TPM 2.0 +.IP \[bu] 2 +Ubuntu (https://ubuntu.com/desktop) and all the \f[B]official Ubuntu +flavours (https://ubuntu.com/download/flavours)\f[R] +.IP \[bu] 2 +\f[B]Over 360 operating system editions are supported!\f[R] +.IP \[bu] 2 +Full SPICE support including host/guest clipboard sharing +.IP \[bu] 2 +VirtIO-webdavd file sharing for Linux and Windows guests +.IP \[bu] 2 +VirtIO-9p file sharing for Linux and macOS guests +.IP \[bu] 2 +QEMU Guest Agent support (https://wiki.qemu.org/Features/GuestAgent); +provides access to a system-level agent via standard QMP commands +.IP \[bu] 2 +Samba file sharing for Linux, macOS and Windows guests (\f[I]if +\f[VI]smbd\f[I] is installed on the host\f[R]) +.IP \[bu] 2 +VirGL acceleration +.IP \[bu] 2 +USB device pass-through +.IP \[bu] 2 +Smartcard pass-through +.IP \[bu] 2 +Automatic SSH port forwarding to guests +.IP \[bu] 2 +Network port forwarding +.IP \[bu] 2 +Full duplex audio +.IP \[bu] 2 +Braille support +.IP \[bu] 2 +EFI (with or without SecureBoot) and Legacy BIOS boot +.IP \[bu] 2 +Graphical user interfaces available +.PP +Quickemu is a wrapper for the excellent QEMU (https://www.qemu.org/) +that attempts to automatically \f[I]\[lq]do the right thing\[rq]\f[R], +rather than expose exhaustive configuration options. +.PP +We have a Discord for this project: +[IMAGE: Discord (https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)] (https://discord.gg/sNmz3uw) +.PP +See this (old) video where I explain some of my motivations for creating +Quickemu. +.PP +[IMAGE: Replace VirtualBox with Bash & +QEMU (https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)] (https://www.youtube.com/watch?v=AOTYWEgw0hI) +.SS Requirements +.IP \[bu] 2 +QEMU (https://www.qemu.org/) (\f[I]6.0.0 or newer\f[R]) \f[B]with GTK, +SDL, SPICE & VirtFS support\f[R] +.IP \[bu] 2 +bash (https://www.gnu.org/software/bash/) (\f[I]4.0 or newer\f[R]) +.IP \[bu] 2 +Coreutils (https://www.gnu.org/software/coreutils/) +.IP \[bu] 2 +EDK II (https://github.com/tianocore/edk2) +.IP \[bu] 2 +grep (https://www.gnu.org/software/grep/) +.IP \[bu] 2 +jq (https://stedolan.github.io/jq/) +.IP \[bu] 2 +LSB (https://wiki.linuxfoundation.org/lsb/start) +.IP \[bu] 2 +procps (https://gitlab.com/procps-ng/procps) +.IP \[bu] 2 +python3 (https://www.python.org/) +.IP \[bu] 2 +macrecovery (https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery) +.IP \[bu] 2 +mkisofs (http://cdrtools.sourceforge.net/private/cdrecord.html) +.IP \[bu] 2 +usbutils (https://github.com/gregkh/usbutils) +.IP \[bu] 2 +util-linux (https://github.com/karelzak/util-linux) +.IP \[bu] 2 +sed (https://www.gnu.org/software/sed/) +.IP \[bu] 2 +socat (http://www.dest-unreach.org/socat/) +.IP \[bu] 2 +spicy (https://gitlab.freedesktop.org/spice/spice-gtk) +.IP \[bu] 2 +swtpm (https://github.com/stefanberger/swtpm) +.IP \[bu] 2 +Wget (https://www.gnu.org/software/wget/) +.IP \[bu] 2 +xdg-user-dirs (https://www.freedesktop.org/wiki/Software/xdg-user-dirs/) +.IP \[bu] 2 +xrandr (https://gitlab.freedesktop.org/xorg/app/xrandr) +.IP \[bu] 2 +zsync (http://zsync.moria.org.uk/) +.IP \[bu] 2 +unzip (http://www.info-zip.org/UnZip.html) +.SS Installing Requirements +.PP +For Ubuntu, Arch and nixos systems the +ppa (https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu), +AUR (https://aur.archlinux.org/packages/quickemu) or +nix (https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu) +packaging will take care of the dependencies. +For other host distributions or operating systems it will be necessary +to install the above requirements or their equivalents. +.PP +These examples may save a little typing +.PP +Debian: +.IP +.nf +\f[C] +sudo apt install qemu bash coreutils ovmf grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-client-gtk swtpm wget xdg-user-dirs zsync unzip +\f[R] +.fi +.PP +Fedora: +.IP +.nf +\f[C] +sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip +\f[R] +.fi +.PP +MacOS: +.PP +This is a work in progress (see issue +248 (https://github.com/quickemu-project/quickemu/issues/248) for other +steps and changes that may enable running on MacOS) +.IP +.nf +\f[C] +brew install qemu bash coreutils grep jq python\[at]3.10 cdrtools gnu-sed spice-gtk wget zsync +\f[R] +.fi +.SH Usage +.SS Graphical User Interfaces +.PP +While \f[V]quickemu\f[R] and \f[V]quickget\f[R] are designed for the +terminal, a graphical user interface is also available: +.IP \[bu] 2 +\f[B]Quickgui (https://github.com/quickgui/quickgui)\f[R] by Mark +Johnson (https://github.com/marxjohnson) and Yannick +Mauray (https://github.com/ymauray). +.PP +Many thanks to Luke Wesley-Holley (https://github.com/Lukewh) and +Philipp Kiemle (https://github.com/daPhipz) for creating the +\f[B]Quickemu icons (https://github.com/Lukewh/quickemu-icons)\f[R] +\[u1F3A8] +.SS Quickgui for Ubuntu +.IP +.nf +\f[C] +sudo add-apt-repository ppa:yannick-mauray/quickgui +sudo apt update +sudo apt install quickgui +\f[R] +.fi +.SS Ubuntu Guest +.PP +\f[V]quickget\f[R] will automatically download an Ubuntu release and +create the virtual machine configuration. +.IP +.nf +\f[C] +quickget ubuntu 22.04 +quickemu --vm ubuntu-22.04.conf +\f[R] +.fi +.IP \[bu] 2 +Complete the installation as normal. +.IP \[bu] 2 +Post-install: +.RS 2 +.IP \[bu] 2 +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection +.RS 2 +.IP \[bu] 2 +\f[V]sudo apt install spice-vdagent\f[R] +.RE +.IP \[bu] 2 +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. +.RS 2 +.IP \[bu] 2 +\f[V]sudo apt install spice-webdavd\f[R] +.RE +.RE +.SS Ubuntu devel (daily-live) images +.PP +\f[V]quickget\f[R] can also download/refresh devel images via +\f[V]zsync\f[R] for Ubuntu developers and testers. +.IP +.nf +\f[C] +quickget ubuntu devel +quickemu --vm ubuntu-devel.conf +\f[R] +.fi +.PP +You can run \f[V]quickget ubuntu devel\f[R] to refresh your daily +development image as often as you like, it will even automatically +switch to a new series. +.SS Ubuntu Flavours +.PP +All the official Ubuntu flavours are supported, just replace +\f[V]ubuntu\f[R] with your preferred flavour. +.IP \[bu] 2 +\f[V]kubuntu\f[R] (Kubuntu) +.IP \[bu] 2 +\f[V]lubuntu\f[R] (Lubuntu) +.IP \[bu] 2 +\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie) +.IP \[bu] 2 +\f[V]ubuntukylin\f[R] (Ubuntu Kylin) +.IP \[bu] 2 +\f[V]ubuntu-mate\f[R] (Ubuntu MATE) +.IP \[bu] 2 +\f[V]ubuntustudio\f[R] (Ubuntu Studio) +.IP \[bu] 2 +\f[V]ubuntu\f[R] (Ubuntu) +.IP \[bu] 2 +\f[V]ubuntu-unity\f[R] (Ubuntu Unity) +.IP \[bu] 2 +\f[V]xubuntu\f[R] (Xubuntu) +.SS Other Operating Systems +.PP +\f[V]quickget\f[R] also supports: +.IP \[bu] 2 +\f[V]alma\f[R] (Alma Linux) +.IP \[bu] 2 +\f[V]alpine\f[R] (Alpine Linux) +.IP \[bu] 2 +\f[V]android\f[R] (Android x86) +.IP \[bu] 2 +\f[V]archcraft\f[R] (Archcraft) +.IP \[bu] 2 +\f[V]archlinux\f[R] (Arch Linux) +.IP \[bu] 2 +\f[V]arcolinux\f[R] (Arco Linux) +.IP \[bu] 2 +\f[V]batocera\f[R] (Batocera) +.IP \[bu] 2 +\f[V]cachyos\f[R] (CachyOS) +.IP \[bu] 2 +\f[V]centos-stream\f[R] (CentOS Stream) +.IP \[bu] 2 +\f[V]debian\f[R] (Debian) +.IP \[bu] 2 +\f[V]deepin\f[R] (Deepin) +.IP \[bu] 2 +\f[V]devuan\f[R] (Devuan) +.IP \[bu] 2 +\f[V]dragonflybsd\f[R] (DragonFlyBSD) +.IP \[bu] 2 +\f[V]elementary\f[R] (elementary OS) +.IP \[bu] 2 +\f[V]endeavouros\f[R] (EndeavourOS) +.IP \[bu] 2 +\f[V]fedora\f[R] (Fedora) +.IP \[bu] 2 +\f[V]freebsd\f[R] (FreeBSD) +.IP \[bu] 2 +\f[V]freedos\f[R] (FreeDOS) +.IP \[bu] 2 +\f[V]garuda\f[R] (Garuda Linux) +.IP \[bu] 2 +\f[V]gentoo\f[R] (Gentoo) +.IP \[bu] 2 +\f[V]ghostbsd\f[R] (GhostBSD) +.IP \[bu] 2 +\f[V]haiku\f[R] (Haiku) +.IP \[bu] 2 +\f[V]kali\f[R] (Kali) +.IP \[bu] 2 +\f[V]kdeneon\f[R] (KDE Neon) +.IP \[bu] 2 +\f[V]kolibrios\f[R] (KolibriOS) +.IP \[bu] 2 +\f[V]linuxmint\f[R] (Linux Mint) +.IP \[bu] 2 +\f[V]lmde\f[R] (Linux Mint Debian Edition) +.IP \[bu] 2 +\f[V]mageia\f[R] (Mageia) +.IP \[bu] 2 +\f[V]manjaro\f[R] (Manjaro) +.IP \[bu] 2 +\f[V]mxlinux\f[R] (MX Linux) +.IP \[bu] 2 +\f[V]netboot\f[R] (netboot.xyz) +.IP \[bu] 2 +\f[V]netbsd\f[R] (NetBSD) +.IP \[bu] 2 +\f[V]nixos\f[R] (NixOS) +.IP \[bu] 2 +\f[V]openbsd\f[R] (OpenBSD) +.IP \[bu] 2 +\f[V]opensuse\f[R] (openSUSE) +.IP \[bu] 2 +\f[V]oraclelinux\f[R] (Oracle Linux) +.IP \[bu] 2 +\f[V]popos\f[R] (Pop!_OS) +.IP \[bu] 2 +\f[V]reactos\f[R] (ReactOS) +.IP \[bu] 2 +\f[V]rebornos\f[R] (RebornOS) +.IP \[bu] 2 +\f[V]rockylinux\f[R] (Rocky Linux) +.IP \[bu] 2 +\f[V]slackware\f[R] (Slackware) +.IP \[bu] 2 +\f[V]solus\f[R] (Solus) +.IP \[bu] 2 +\f[V]tails\f[R] (Tails) +.IP \[bu] 2 +\f[V]truenas-core\f[R] (TrueNAS Core) +.IP \[bu] 2 +\f[V]truenas-scale\f[R] (TrueNAS Scale) +.IP \[bu] 2 +\f[V]void\f[R] (Void Linux) +.IP \[bu] 2 +\f[V]zorin\f[R] (Zorin OS) +.PP +Or you can download a Linux image and manually create a VM +configuration. +.IP \[bu] 2 +Download a .iso image of a Linux distribution +.IP \[bu] 2 +Create a VM configuration file; for example +\f[V]debian-bullseye.conf\f[R] +.IP +.nf +\f[C] +guest_os=\[dq]linux\[dq] +disk_img=\[dq]debian-bullseye/disk.qcow2\[dq] +iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq] +\f[R] +.fi +.IP \[bu] 2 +Use \f[V]quickemu\f[R] to start the virtual machine: +.IP +.nf +\f[C] +quickemu --vm debian-bullseye.conf +\f[R] +.fi +.IP \[bu] 2 +Complete the installation as normal. +.IP \[bu] 2 +Post-install: +.RS 2 +.IP \[bu] 2 +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection. +.IP \[bu] 2 +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. +.RE +.SS macOS Guest +.PP +\f[V]quickget\f[R] automatically downloads a macOS recovery image and +creates a virtual machine configuration. +.IP +.nf +\f[C] +quickget macos catalina +quickemu --vm macos-catalina.conf +\f[R] +.fi +.PP +macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R], +\f[V]big-sur\f[R] and \f[V]monterey\f[R] are supported. +.IP \[bu] 2 +Use cursor keys and enter key to select the \f[B]macOS Base System\f[R] +.IP \[bu] 2 +From \f[B]macOS Utilities\f[R] +.RS 2 +.IP \[bu] 2 +Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R] +.RS 2 +.IP \[bu] 2 +Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and +click \f[B]Erase\f[R]. +.IP \[bu] 2 +Enter a \f[V]Name:\f[R] for the disk +.IP \[bu] 2 +If you are installing macOS Mojave or later (Catalina, Big Sur, and +Monterey), choose any of the APFS options as the filesystem. +MacOS Extended may not work. +.RE +.IP \[bu] 2 +Click \f[B]Erase\f[R]. +.IP \[bu] 2 +Click \f[B]Done\f[R]. +.IP \[bu] 2 +Close Disk Utility +.RE +.IP \[bu] 2 +From \f[B]macOS Utilities\f[R] +.RS 2 +.IP \[bu] 2 +Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R] +.RE +.IP \[bu] 2 +Complete the installation as you normally would. +.RS 2 +.IP \[bu] 2 +On the first reboot use cursor keys and enter key to select \f[B]macOS +Installer\f[R] +.IP \[bu] 2 +On the subsequent reboots use cursor keys and enter key to select the +disk you named +.RE +.IP \[bu] 2 +Once you have finished installing macOS you will be presented with an +the out-of-the-box first-start wizard to configure various options and +set up your username and password +.IP \[bu] 2 +OPTIONAL: After you have concluded the out-of-the-box wizard, you may +want to enable the TRIM feature that the computer industry created for +SSD disks. +This feature in our macOS installation will allow QuickEmu to compact +(shrink) your macOS disk image whenever you delete files inside the +Virtual Machine. +Without this step your macOS disk image will only ever get larger and +will not shrink even when you delete lots of data inside macOS. +.RS 2 +.IP \[bu] 2 +To enable TRIM, open the Terminal application and type the following +command followed by pressing enter to tell macos to use the TRIM command +on the hard disk when files are deleted: +.RE +.IP +.nf +\f[C] +sudo trimforce enable +\f[R] +.fi +.PP +You will be prompted to enter your account\[cq]s password to gain the +privilege needed. +Once you\[cq]ve entered your password and pressed enter the command will +request confirmation in the form of two questions that require you to +type y (for a \[lq]yes\[rq] response) followed by enter to confirm. +If you press enter without first typing y the system will consider that +a negative response as though you said \[lq]no\[rq]: +.IP +.nf +\f[C] +IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an \[dq]as is\[dq] basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. +Are you sure you with to proceed (y/N)? +\f[R] +.fi +.PP +And a second confirmation once you\[cq]ve confirmed the previous one: +.IP +.nf +\f[C] +Your system will immediately reboot when this is complete. +Is this OK (y/N)? +\f[R] +.fi +.PP +As the last message states, your system will automatically reboot as +soon as the command completes. +.PP +The default macOS configuration looks like this: +.IP +.nf +\f[C] +guest_os=\[dq]macos\[dq] +img=\[dq]macos-catalina/RecoveryImage.img\[dq] +disk_img=\[dq]macos-catalina/disk.qcow2\[dq] +macos_release=\[dq]catalina\[dq] +\f[R] +.fi +.IP \[bu] 2 +\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for +macOS. +.IP \[bu] 2 +\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to +optimise for a particular macOS release. +.RS 2 +.IP \[bu] 2 +For example VirtIO Network and Memory Ballooning are available in Big +Sur and newer, but not previous releases. +.IP \[bu] 2 +And VirtIO Block Media (disks) are supported/stable in Catalina and +newer. +.RE +.SS macOS compatibility +.PP +There are some considerations when running macOS via Quickemu. +.IP \[bu] 2 +Supported macOS releases: +.RS 2 +.IP \[bu] 2 +High Sierra +.IP \[bu] 2 +Mojave +.IP \[bu] 2 +Catalina \f[B](Recommended)\f[R] +.IP \[bu] 2 +Big Sur +.IP \[bu] 2 +Monterey +.RE +.IP \[bu] 2 +\f[V]quickemu\f[R] will automatically download the required +OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and +OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM). +.IP \[bu] 2 +Optimised by default, but no GPU acceleration is available. +.RS 2 +.IP \[bu] 2 +Host CPU vendor is detected and guest CPU is optimised accordingly. +.IP \[bu] 2 +VirtIO Block +Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used +for the system disk where supported. +.IP \[bu] 2 +VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for +the mouse. +.IP \[bu] 2 +VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS +Big Sur and newer but previous releases use \f[V]vmxnet3\f[R]. +.IP \[bu] 2 +VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and +newer but disabled for other support macOS releases. +.RE +.IP \[bu] 2 +USB host and SPICE pass-through is: +.RS 2 +.IP \[bu] 2 +UHCI (USB 2.0) on macOS Catalina and earlier. +.IP \[bu] 2 +XHCI (USB 3.0) on macOS Big Sur and newer. +.RE +.IP \[bu] 2 +Display resolution can only be changed via macOS System Preferences. +.IP \[bu] 2 +\f[B]Full Duplex audio requires VoodooHDA +OC (https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB +audio-device to the macOS guest VM\f[R]. +.IP \[bu] 2 +NOTE! +Gatekeeper (https://disable-gatekeeper.github.io/) and System Integrity +Protection +(SIP) (https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection) +need to be disabled to install VoodooHDA OC +.IP \[bu] 2 +File sharing between guest and host is available via +virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE +webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24). +.IP \[bu] 2 +Copy/paste via SPICE agent is \f[B]not available on macOS\f[R]. +.SS macOS App Store +.PP +If you see \f[I]\[lq]Your device or computer could not be +verified\[rq]\f[R] when you try to login to the App Store, make sure +that your wired ethernet device is \f[V]en0\f[R]. +Use \f[V]ifconfig\f[R] in a terminal to verify this. +.PP +If the wired ethernet device is not \f[V]en0\f[R], then then go to +\f[I]System Preferences\f[R] -> \f[I]Network\f[R], delete all the +network devices and apply the changes. +Next, open a terminal and run the following: +.IP +.nf +\f[C] +sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist +\f[R] +.fi +.PP +Now reboot, and the App Store should work. +.SS Windows 10 & 11 Guests +.PP +\f[V]quickget\f[R] can not download +Windows10 (https://www.microsoft.com/software-download/windows10) and +Windows 11 (https://www.microsoft.com/software-download/windows11) +automatically, but does automatically create an optimised virtual +machine configuration that you can just add an Windows .iso image to. +This configuration also includes the VirtIO drivers for +Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). +\f[V]quickget\f[R] can automatically download Windows 8.1, Windows +10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and +Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11) +along with the VirtIO drivers for +Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/) +and creates a virtual machine configuration. +.IP +.nf +\f[C] +quickget windows 11 +quickemu --vm windows-11.conf +\f[R] +.fi +.IP \[bu] 2 +Complete the installation as you normally would. +.IP \[bu] 2 +All relevant drivers and services should be installed automatically. +.IP \[bu] 2 +A local adminstrator user account is automatically created, with these +credentials: +.RS 2 +.IP \[bu] 2 +Username: \f[V]Quickemu\f[R] +.IP \[bu] 2 +Password: \f[V]quickemu\f[R] +.RE +.PP +The default Windows 11 configuration looks like this: +.IP +.nf +\f[C] +guest_os=\[dq]windows\[dq] +disk_img=\[dq]windows-11/disk.qcow2\[dq] +iso=\[dq]windows-11/windows-11.iso\[dq] +fixed_iso=\[dq]windows-11/virtio-win.iso\[dq] +tpm=\[dq]on\[dq] +secureboot=\[dq]on\[dq] +\f[R] +.fi +.IP \[bu] 2 +\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to +optimise for Windows. +.IP \[bu] 2 +\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO +drivers. +.IP \[bu] 2 +\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a +software emulated TPM device using \f[V]swtpm\f[R]. +.SH All the options +.PP +Here are the usage instructions: +.IP +.nf +\f[C] +Usage + quickemu --vm ubuntu.conf + +You can also pass optional parameters + --braille : Enable braille support. Requires SDL. + --delete-disk : Delete the disk image and EFI variables + --delete-vm : Delete the entire VM and it\[aq]s configuration + --display : Select display backend. \[aq]sdl\[aq] (default), \[aq]gtk\[aq], \[aq]none\[aq], \[aq]spice\[aq] or \[aq]spice-app\[aq] + --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) + --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers + --screen : Use specified screen to determine the window size. + --shortcut : Create a desktop shortcut + --snapshot apply : Apply/restore a snapshot. + --snapshot create : Create a snapshot. + --snapshot delete : Delete a snapshot. + --snapshot info : Show disk/snapshot info. + --status-quo : Do not commit any changes to disk/snapshot. + --viewer : Choose an alternative viewer. \[at]Options: \[aq]spicy\[aq] (default), \[aq]remote-viewer\[aq], \[aq]none\[aq] + --ssh-port : Set ssh-port manually + --spice-port : Set spice-port manually + --public-dir : expose share directory. \[at]Options: \[aq]\[aq] (default: xdg-user-dir PUBLICSHARE), \[aq]\[aq], \[aq]none\[aq] + --monitor : Set monitor connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq] + --monitor-telnet-host : Set telnet host for monitor. (default: \[aq]localhost\[aq]) + --monitor-telnet-port : Set telnet port for monitor. (default: \[aq]4440\[aq]) + --monitor-cmd : Send command to monitor if available. (Example: system_powerdown) + --serial : Set serial connection type. \[at]Options: \[aq]socket\[aq] (default), \[aq]telnet\[aq], \[aq]none\[aq] + --serial-telnet-host : Set telnet host for serial. (default: \[aq]localhost\[aq]) + --serial-telnet-port : Set telnet port for serial. (default: \[aq]6660\[aq]) + --keyboard : Set keyboard. \[at]Options: \[aq]usb\[aq] (default), \[aq]ps2\[aq], \[aq]virtio\[aq] + --keyboard_layout : Set keyboard layout. + --mouse : Set mouse. \[at]Options: \[aq]tablet\[aq] (default), \[aq]ps2\[aq], \[aq]usb\[aq], \[aq]virtio\[aq] + --usb-controller : Set usb-controller. \[at]Options: \[aq]ehci\[aq] (default), \[aq]xhci\[aq], \[aq]none\[aq] + --extra_args : Pass additional arguments to qemu + --version : Print version +\f[R] +.fi +.SS Desktop shortcuts +.PP +Desktop shortcuts can be created for a VM, the shortcuts are saved in +\f[V]\[ti]/.local/share/applications\f[R]. +Here is an example of how to create a shortcut. +.IP +.nf +\f[C] +quickemu --vm ubuntu-22.04-desktop.conf --shortcut +\f[R] +.fi +.SS Screen and window size (Linux guests only) +.PP +\f[V]qemu\f[R] will always default to the primary monitor to display the +VM\[cq]s window. +.PP +Without the \f[V]--screen\f[R] option, \f[V]quickemu\f[R] will look for +the size of the smallest monitor, and use a size that fits on said +monitor. +.PP +The \f[V]--screen\f[R] option forces \f[V]quickemu\f[R] to use the size +of the given monitor to compute the size of the window. +\f[B]It won\[cq]t use that monitor to display the VM\[cq]s window if +it\[cq]s not the primary monitor\f[R]. +This is useful if the primary monitor if not the smallest one, and if +the VM\[cq]s window doesn\[cq]t need to be moved around. +.PP +The \f[V]--screen\f[R] option is also useful with the +\f[V]--fullscreen\f[R] option, again because \f[V]qemu\f[R] will always +use the primary monitor. +In order for the fullscreen mode to work properly, the resolution of the +VM\[cq]s window must match the resolution of the screen. +.PP +To know which screen to use, type: +.IP +.nf +\f[C] +xrandr --listmonitors | grep -v Monitors +\f[R] +.fi +.PP +The command will output something like this: +.IP +.nf +\f[C] + 0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0 + 1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0 +\f[R] +.fi +.PP +The first number is what needs to be passed to the \f[V]--screen\f[R] +option. +.PP +For example: +.IP +.nf +\f[C] +quickemu --vm vm.conf --screen 0 +\f[R] +.fi +.PP +The above uses the 2560x1440 screen to compute the size of the window, +which Quickemu sizes to 2048x1152. +Without the \f[V]--screen\f[R] option, Quickemu would have used the +1920x1080 monitor which results in a window size of 1664x936. +.SH References +.PP +Useful reference that assisted the development of Quickemu. +.IP \[bu] 2 +General +.RS 2 +.IP \[bu] 2 +QEMU\[cq]s documentation! (https://qemu.readthedocs.io/en/latest/) +.IP \[bu] 2 + +.IP \[bu] 2 + +.RE +.IP \[bu] 2 +macOS +.RS 2 +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 +OpenCore Configurator (https://mackie100projects.altervista.org) +.RE +.IP \[bu] 2 +Windows +.RS 2 +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.RE +.IP \[bu] 2 +TPM +.RS 2 +.IP \[bu] 2 + +.IP \[bu] 2 + +.RE +.IP \[bu] 2 +9p & virtiofs +.RS 2 +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.IP \[bu] 2 + +.RE +.SH AUTHORS +.PP +Written by Martin Wimpress. +.SH BUGS +.PP +Submit bug reports online at: + +.SH SEE ALSO +.PP +Full sources at: +.PP +quickemu_conf(1), quickget(1), quickgui(1) +.SH AUTHORS +Martin Wimpress. diff --git a/docs/quickemu.1.md b/docs/quickemu.1.md new file mode 100644 index 0000000..54a8c1b --- /dev/null +++ b/docs/quickemu.1.md @@ -0,0 +1,673 @@ +--- +author: Martin Wimpress +date: February 4, 2023 +footer: quickemu +header: Quickemu User Manual +section: 1 +title: QUICKEMU +--- + +# NAME + +quickemu - A quick VM builder and manager + +# SYNOPSIS + +**quickemu** \[*OPTION*\]... + +# DESCRIPTION + +**quickemu** will create and run highly optimised desktop virtual +machines for Linux, macOS and Windows + +# OPTIONS + +**--vm** +: vm configuration file + +You can also pass optional parameters + +**--braille** +: Enable braille support. Requires SDL. + +**--delete** +: Delete the disk image. + +**--display** +: Select display backend. 'sdl' (default), 'gtk', 'none' or 'spice' + +**--fullscreen** +: Starts VM in full screen mode (Ctl+Alt+f to exit) + +**--ignore-msrs-always** +: Configure KVM to always ignore unhandled machine-specific registers + +**--screen \** +: Use specified screen to determine the window size. + +**--shortcut** +: Create a desktop shortcut + +**--snapshot apply \** +: Apply/restore a snapshot. + +**--snapshot create \** +: Create a snapshot. + +**--snapshot delete \** +: Delete a snapshot. + +**--snapshot info** +: Show disk/snapshot info. + +**--status-quo** +: Do not commit any changes to disk/snapshot. + +**--version** +: Print version + +# EXAMPLES + +**quickemu --vm ubuntu-mate-22.04.conf** +: Launches the VM specified in the file *ubuntu-mate-22.04.conf* + +## Introduction + +Quickly create and run highly optimised desktop virtual machines for +Linux, macOS and Windows; with just two commands. You decide what +operating system you want to run and Quickemu will figure out the best +way to do it for you. For example: + +``` bash +quickget ubuntu-mate 22.04 +quickemu --vm ubuntu-mate-22.04.conf +``` + +The original objective of the project was to enable quick testing of +Linux distributions where the virtual machine configurations can be +stored anywhere, such as external USB storage or your home directory, +and no elevated permissions are required to run the virtual machines. +**Quickemu now also includes comprehensive support for macOS and +Windows**. + +## Features + +- **macOS** Monterey, Big Sur, Catalina, Mojave & High Sierra +- **Windows** 8.1, 10 and 11 including TPM 2.0 +- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu + flavours](https://ubuntu.com/download/flavours)** +- **Over 360 operating system editions are supported!** +- Full SPICE support including host/guest clipboard sharing +- VirtIO-webdavd file sharing for Linux and Windows guests +- VirtIO-9p file sharing for Linux and macOS guests +- [QEMU Guest Agent + support](https://wiki.qemu.org/Features/GuestAgent); provides access + to a system-level agent via standard QMP commands +- Samba file sharing for Linux, macOS and Windows guests (*if `smbd` + is installed on the host*) +- VirGL acceleration +- USB device pass-through +- Smartcard pass-through +- Automatic SSH port forwarding to guests +- Network port forwarding +- Full duplex audio +- Braille support +- EFI (with or without SecureBoot) and Legacy BIOS boot +- Graphical user interfaces available + +Quickemu is a wrapper for the excellent [QEMU](https://www.qemu.org/) +that attempts to automatically *"do the right thing"*, rather than +expose exhaustive configuration options. + +We have a Discord for this project: +[![Discord](https://img.shields.io/discord/712850672223125565?color=0C306A&label=WimpysWorld%20Discord&logo=Discord&logoColor=ffffff&style=flat-square)](https://discord.gg/sNmz3uw) + +See this (old) video where I explain some of my motivations for creating +Quickemu. + +[![Replace VirtualBox with Bash & +QEMU](https://img.youtube.com/vi/AOTYWEgw0hI/0.jpg)](https://www.youtube.com/watch?v=AOTYWEgw0hI) + +## Requirements + +- [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL, + SPICE & VirtFS support** +- [bash](https://www.gnu.org/software/bash/) (*4.0 or newer*) +- [Coreutils](https://www.gnu.org/software/coreutils/) +- [EDK II](https://github.com/tianocore/edk2) +- [grep](https://www.gnu.org/software/grep/) +- [jq](https://stedolan.github.io/jq/) +- [LSB](https://wiki.linuxfoundation.org/lsb/start) +- [procps](https://gitlab.com/procps-ng/procps) +- [python3](https://www.python.org/) +- [macrecovery](https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery) +- [mkisofs](http://cdrtools.sourceforge.net/private/cdrecord.html) +- [usbutils](https://github.com/gregkh/usbutils) +- [util-linux](https://github.com/karelzak/util-linux) +- [sed](https://www.gnu.org/software/sed/) +- [socat](http://www.dest-unreach.org/socat/) +- [spicy](https://gitlab.freedesktop.org/spice/spice-gtk) +- [swtpm](https://github.com/stefanberger/swtpm) +- [Wget](https://www.gnu.org/software/wget/) +- [xdg-user-dirs](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/) +- [xrandr](https://gitlab.freedesktop.org/xorg/app/xrandr) +- [zsync](http://zsync.moria.org.uk/) +- [unzip](http://www.info-zip.org/UnZip.html) + +### Installing Requirements + +For Ubuntu, Arch and nixos systems the +[ppa](https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu), +[AUR](https://aur.archlinux.org/packages/quickemu) or +[nix](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu) +packaging will take care of the dependencies. For other host +distributions or operating systems it will be necessary to install the +above requirements or their equivalents. + +These examples may save a little typing + +Debian: + + sudo apt install qemu bash coreutils ovmf grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-client-gtk swtpm wget xdg-user-dirs zsync unzip + +Fedora: + + sudo dnf install qemu bash coreutils edk2-tools grep jq lsb procps python3 genisoimage usbutils util-linux sed spice-gtk-tools swtpm wget xdg-user-dirs xrandr unzip + +MacOS: + +This is a work in progress (see [issue +248](https://github.com/quickemu-project/quickemu/issues/248) for other +steps and changes that may enable running on MacOS) + + brew install qemu bash coreutils grep jq python@3.10 cdrtools gnu-sed spice-gtk wget zsync + +# Usage + +## Graphical User Interfaces + +While `quickemu` and `quickget` are designed for the terminal, a +graphical user interface is also available: + +- **[Quickgui](https://github.com/quickgui/quickgui)** by [Mark + Johnson](https://github.com/marxjohnson) and [Yannick + Mauray](https://github.com/ymauray). + +Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and +[Philipp Kiemle](https://github.com/daPhipz) for creating the +**[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨 + +### Quickgui for Ubuntu + +``` bash +sudo add-apt-repository ppa:yannick-mauray/quickgui +sudo apt update +sudo apt install quickgui +``` + +## Ubuntu Guest + +`quickget` will automatically download an Ubuntu release and create the +virtual machine configuration. + +``` bash +quickget ubuntu 22.04 +quickemu --vm ubuntu-22.04.conf +``` + +- Complete the installation as normal. +- Post-install: + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection + - `sudo apt install spice-vdagent` + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. + - `sudo apt install spice-webdavd` + +### Ubuntu devel (daily-live) images + +`quickget` can also download/refresh devel images via `zsync` for Ubuntu +developers and testers. + +``` bash +quickget ubuntu devel +quickemu --vm ubuntu-devel.conf +``` + +You can run `quickget ubuntu devel` to refresh your daily development +image as often as you like, it will even automatically switch to a new +series. + +### Ubuntu Flavours + +All the official Ubuntu flavours are supported, just replace `ubuntu` +with your preferred flavour. + +- `kubuntu` (Kubuntu) +- `lubuntu` (Lubuntu) +- `ubuntu-budgie` (Ubuntu Budgie) +- `ubuntukylin` (Ubuntu Kylin) +- `ubuntu-mate` (Ubuntu MATE) +- `ubuntustudio` (Ubuntu Studio) +- `ubuntu` (Ubuntu) +- `ubuntu-unity` (Ubuntu Unity) +- `xubuntu` (Xubuntu) + +## Other Operating Systems + +`quickget` also supports: + +- `alma` (Alma Linux) +- `alpine` (Alpine Linux) +- `android` (Android x86) +- `archcraft` (Archcraft) +- `archlinux` (Arch Linux) +- `arcolinux` (Arco Linux) +- `batocera` (Batocera) +- `cachyos` (CachyOS) +- `centos-stream` (CentOS Stream) +- `debian` (Debian) +- `deepin` (Deepin) +- `devuan` (Devuan) +- `dragonflybsd` (DragonFlyBSD) +- `elementary` (elementary OS) +- `endeavouros` (EndeavourOS) +- `fedora` (Fedora) +- `freebsd` (FreeBSD) +- `freedos` (FreeDOS) +- `garuda` (Garuda Linux) +- `gentoo` (Gentoo) +- `ghostbsd` (GhostBSD) +- `haiku` (Haiku) +- `kali` (Kali) +- `kdeneon` (KDE Neon) +- `kolibrios` (KolibriOS) +- `linuxmint` (Linux Mint) +- `lmde` (Linux Mint Debian Edition) +- `mageia` (Mageia) +- `manjaro` (Manjaro) +- `mxlinux` (MX Linux) +- `netboot` (netboot.xyz) +- `netbsd` (NetBSD) +- `nixos` (NixOS) +- `openbsd` (OpenBSD) +- `opensuse` (openSUSE) +- `oraclelinux` (Oracle Linux) +- `popos` (Pop!\_OS) +- `reactos` (ReactOS) +- `rebornos` (RebornOS) +- `rockylinux` (Rocky Linux) +- `slackware` (Slackware) +- `solus` (Solus) +- `tails` (Tails) +- `truenas-core` (TrueNAS Core) +- `truenas-scale` (TrueNAS Scale) +- `void` (Void Linux) +- `zorin` (Zorin OS) + +Or you can download a Linux image and manually create a VM +configuration. + +- Download a .iso image of a Linux distribution +- Create a VM configuration file; for example `debian-bullseye.conf` + +``` bash +guest_os="linux" +disk_img="debian-bullseye/disk.qcow2" +iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" +``` + +- Use `quickemu` to start the virtual machine: + +``` bash +quickemu --vm debian-bullseye.conf +``` + +- Complete the installation as normal. +- Post-install: + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. + +## macOS Guest + +`quickget` automatically downloads a macOS recovery image and creates a +virtual machine configuration. + +``` bash +quickget macos catalina +quickemu --vm macos-catalina.conf +``` + +macOS `high-sierra`, `mojave`, `catalina`, `big-sur` and `monterey` are +supported. + +- Use cursor keys and enter key to select the **macOS Base System** +- From **macOS Utilities** + - Click **Disk Utility** and **Continue** + - Select `QEMU HARDDISK Media` (\~103.08GB) from the list and + click **Erase**. + - Enter a `Name:` for the disk + - If you are installing macOS Mojave or later (Catalina, Big + Sur, and Monterey), choose any of the APFS options as the + filesystem. MacOS Extended may not work. + - Click **Erase**. + - Click **Done**. + - Close Disk Utility +- From **macOS Utilities** + - Click **Reinstall macOS** and **Continue** +- Complete the installation as you normally would. + - On the first reboot use cursor keys and enter key to select + **macOS Installer** + - On the subsequent reboots use cursor keys and enter key to + select the disk you named +- Once you have finished installing macOS you will be presented with + an the out-of-the-box first-start wizard to configure various + options and set up your username and password +- OPTIONAL: After you have concluded the out-of-the-box wizard, you + may want to enable the TRIM feature that the computer industry + created for SSD disks. This feature in our macOS installation will + allow QuickEmu to compact (shrink) your macOS disk image whenever + you delete files inside the Virtual Machine. Without this step your + macOS disk image will only ever get larger and will not shrink even + when you delete lots of data inside macOS. + - To enable TRIM, open the Terminal application and type the + following command followed by pressing + ``{=html}enter``{=html} to tell macos to use the TRIM + command on the hard disk when files are deleted: + +``` bash +sudo trimforce enable +``` + +You will be prompted to enter your account's password to gain the +privilege needed. Once you've entered your password and pressed +``{=html}enter``{=html} the command will request confirmation +in the form of two questions that require you to type +``{=html}y``{=html} (for a "yes" response) followed by +``{=html}enter``{=html} to confirm. If you press +``{=html}enter``{=html} without first typing +``{=html}y``{=html} the system will consider that a negative +response as though you said "no": + +``` plain +IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. +Are you sure you with to proceed (y/N)? +``` + +And a second confirmation once you've confirmed the previous one: + +``` plain +Your system will immediately reboot when this is complete. +Is this OK (y/N)? +``` + +As the last message states, your system will automatically reboot as +soon as the command completes. + +The default macOS configuration looks like this: + +``` bash +guest_os="macos" +img="macos-catalina/RecoveryImage.img" +disk_img="macos-catalina/disk.qcow2" +macos_release="catalina" +``` + +- `guest_os="macos"` instructs Quickemu to optimise for macOS. +- `macos_release="catalina"` instructs Quickemu to optimise for a + particular macOS release. + - For example VirtIO Network and Memory Ballooning are available + in Big Sur and newer, but not previous releases. + - And VirtIO Block Media (disks) are supported/stable in Catalina + and newer. + +### macOS compatibility + +There are some considerations when running macOS via Quickemu. + +- Supported macOS releases: + - High Sierra + - Mojave + - Catalina **(Recommended)** + - Big Sur + - Monterey +- `quickemu` will automatically download the required + [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader + and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM). +- Optimised by default, but no GPU acceleration is available. + - Host CPU vendor is detected and guest CPU is optimised + accordingly. + - [VirtIO Block + Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is + used for the system disk where supported. + - [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used + for the mouse. + - VirtIO Network (`virtio-net`) is supported and enabled on macOS + Big Sur and newer but previous releases use `vmxnet3`. + - VirtIO Memory Ballooning is supported and enabled on macOS Big + Sur and newer but disabled for other support macOS releases. +- USB host and SPICE pass-through is: + - UHCI (USB 2.0) on macOS Catalina and earlier. + - XHCI (USB 3.0) on macOS Big Sur and newer. +- Display resolution can only be changed via macOS System Preferences. +- **Full Duplex audio requires [VoodooHDA + OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB + audio-device to the macOS guest VM**. +- NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and + [System Integrity Protection + (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection) + need to be disabled to install VoodooHDA OC +- File sharing between guest and host is available via + [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE + webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24). +- Copy/paste via SPICE agent is **not available on macOS**. + +### macOS App Store + +If you see *"Your device or computer could not be verified"* when you +try to login to the App Store, make sure that your wired ethernet device +is `en0`. Use `ifconfig` in a terminal to verify this. + +If the wired ethernet device is not `en0`, then then go to *System +Preferences* -\> *Network*, delete all the network devices and apply the +changes. Next, open a terminal and run the following: + +``` bash +sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist +``` + +Now reboot, and the App Store should work. + +## Windows 10 & 11 Guests + +`quickget` can not download +[Windows10](https://www.microsoft.com/software-download/windows10) and +[Windows 11](https://www.microsoft.com/software-download/windows11) +automatically, but does automatically create an optimised virtual +machine configuration that you can just add an Windows .iso image to. +This configuration also includes the [VirtIO drivers for +Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). +`quickget` can automatically download Windows 8.1, [Windows +10](https://www.microsoft.com/en-gb/software-download/windows10ISO) and +[Windows +11](https://www.microsoft.com/en-gb/software-download/windows11) along +with the [VirtIO drivers for +Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/) +and creates a virtual machine configuration. + +``` bash +quickget windows 11 +quickemu --vm windows-11.conf +``` + +- Complete the installation as you normally would. +- All relevant drivers and services should be installed automatically. +- A local adminstrator user account is automatically created, with + these credentials: + - Username: `Quickemu` + - Password: `quickemu` + +The default Windows 11 configuration looks like this: + +``` bash +guest_os="windows" +disk_img="windows-11/disk.qcow2" +iso="windows-11/windows-11.iso" +fixed_iso="windows-11/virtio-win.iso" +tpm="on" +secureboot="on" +``` + +- `guest_os="windows"` instructs `quickemu` to optimise for Windows. +- `fixed_iso=` specifies the ISO image that provides VirtIO drivers. +- `tpm="on"` instructs `quickemu` to create a software emulated TPM + device using `swtpm`. + +# All the options + +Here are the usage instructions: + + + Usage + quickemu --vm ubuntu.conf + + You can also pass optional parameters + --braille : Enable braille support. Requires SDL. + --delete-disk : Delete the disk image and EFI variables + --delete-vm : Delete the entire VM and it's configuration + --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app' + --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit) + --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers + --screen : Use specified screen to determine the window size. + --shortcut : Create a desktop shortcut + --snapshot apply : Apply/restore a snapshot. + --snapshot create : Create a snapshot. + --snapshot delete : Delete a snapshot. + --snapshot info : Show disk/snapshot info. + --status-quo : Do not commit any changes to disk/snapshot. + --viewer : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none' + --ssh-port : Set ssh-port manually + --spice-port : Set spice-port manually + --public-dir : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none' + --monitor : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none' + --monitor-telnet-host : Set telnet host for monitor. (default: 'localhost') + --monitor-telnet-port : Set telnet port for monitor. (default: '4440') + --monitor-cmd : Send command to monitor if available. (Example: system_powerdown) + --serial : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none' + --serial-telnet-host : Set telnet host for serial. (default: 'localhost') + --serial-telnet-port : Set telnet port for serial. (default: '6660') + --keyboard : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio' + --keyboard_layout : Set keyboard layout. + --mouse : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio' + --usb-controller : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none' + --extra_args : Pass additional arguments to qemu + --version : Print version + +## Desktop shortcuts + +Desktop shortcuts can be created for a VM, the shortcuts are saved in +`~/.local/share/applications`. Here is an example of how to create a +shortcut. + +``` bash +quickemu --vm ubuntu-22.04-desktop.conf --shortcut +``` + +## Screen and window size (Linux guests only) + +`qemu` will always default to the primary monitor to display the VM's +window. + +Without the `--screen` option, `quickemu` will look for the size of the +smallest monitor, and use a size that fits on said monitor. + +The `--screen` option forces `quickemu` to use the size of the given +monitor to compute the size of the window. **It won't use that monitor +to display the VM's window if it's not the primary monitor**. This is +useful if the primary monitor if not the smallest one, and if the VM's +window doesn't need to be moved around. + +The `--screen` option is also useful with the `--fullscreen` option, +again because `qemu` will always use the primary monitor. In order for +the fullscreen mode to work properly, the resolution of the VM's window +must match the resolution of the screen. + +To know which screen to use, type: + +``` bash +xrandr --listmonitors | grep -v Monitors +``` + +The command will output something like this: + +``` bash + 0: +*HDMI-0 2560/597x1440/336+1920+0 HDMI-0 + 1: +DVI-D-0 1920/527x1080/296+0+0 DVI-D-0 +``` + +The first number is what needs to be passed to the `--screen` option. + +For example: + +``` bash +quickemu --vm vm.conf --screen 0 +``` + +The above uses the 2560x1440 screen to compute the size of the window, +which Quickemu sizes to 2048x1152. Without the `--screen` option, +Quickemu would have used the 1920x1080 monitor which results in a window +size of 1664x936. + +# References + +Useful reference that assisted the development of Quickemu. + +- General + - [QEMU's documentation!](https://qemu.readthedocs.io/en/latest/) + - + - +- macOS + - + - + - + - + - + - + - + - + - + - [OpenCore + Configurator](https://mackie100projects.altervista.org) +- Windows + - + - + - + - + - + - +- TPM + - + - +- 9p & virtiofs + - + - + - + - + - + +# AUTHORS + +Written by Martin Wimpress. + +# BUGS + +Submit bug reports online at: + + +# SEE ALSO + +Full sources at: + +quickemu_conf(1), quickget(1), quickgui(1) diff --git a/docs/quickemu_conf.1 b/docs/quickemu_conf.1 new file mode 100644 index 0000000..a66ef36 --- /dev/null +++ b/docs/quickemu_conf.1 @@ -0,0 +1,327 @@ +.\" Automatically generated by Pandoc 2.19.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "QUICKEMU_CONF" "1" "February 4, 2023" "quickemu_conf" "Quickemu Configuration Manual" +.hy +.SH NAME +.PP +quickemu_conf - Options and parameters in the quickemu .conf +.SH DESCRIPTION +.PP +\f[B]quickemu\f[R] will create and run highly optimised desktop virtual +machines for Linux, macOS and Windows. +It uses sensible defaults, but many configuration options can be +overridden in the required configuration file, which will as a minimum +specify the path to the installation ISO and QEMU disk for the installed +VM +.SH OPTIONS +.PP +These are the options and defaults for the .conf file +.IP +.nf +\f[C] +# Lowercase variables are used in the VM config file only +boot=\[dq]efi\[dq] +cpu_cores=\[dq]\[dq] +disk_img=\[dq]\[dq] +disk_size=\[dq]\[dq] +display=\[dq]\[dq] +extra_args=\[dq]\[dq] +fixed_iso=\[dq]\[dq] +floppy=\[dq]\[dq] +guest_os=\[dq]linux\[dq] +img=\[dq]\[dq] +iso=\[dq]\[dq] +macaddr=\[dq]\[dq] +macos_release=\[dq]\[dq] +network=\[dq]\[dq] +port_forwards=() +preallocation=\[dq]off\[dq] +ram=\[dq]\[dq] +secureboot=\[dq]off\[dq] +tpm=\[dq]off\[dq] +usb_devices=() +viewer=\[dq]spicy\[dq] +ssh_port=\[dq]\[dq] +spice_port=\[dq]\[dq] +public_dir=\[dq]\[dq] +monitor=\[dq]socket\[dq] +monitor_telnet_port=\[dq]4440\[dq] +monitor_telnet_host=\[dq]localhost\[dq] +monitor_cmd=\[dq]\[dq] +serial=\[dq]socket\[dq] +serial_telnet_port=\[dq]6660\[dq] +serial_telnet_host=\[dq]localhost\[dq] +# options: ehci(USB2.0), xhci(USB3.0) +usb_controller=\[dq]ehci\[dq] +# options: ps2, usb, virtio +keyboard=\[dq]usb\[dq] +keyboard_layout=\[dq]en-us\[dq] +# options: ps2, usb, tablet, virtio +mouse=\[dq]tablet\[dq] +\f[R] +.fi +.SH EXAMPLES +.IP +.nf +\f[C] +guest_os=\[dq]linux\[dq] +disk_img=\[dq]debian-bullseye/disk.qcow2\[dq] +iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq] +\f[R] +.fi +.PP +The default macOS configuration looks like this: +.IP +.nf +\f[C] +guest_os=\[dq]macos\[dq] +img=\[dq]macos-catalina/RecoveryImage.img\[dq] +disk_img=\[dq]macos-catalina/disk.qcow2\[dq] +macos_release=\[dq]catalina\[dq] +\f[R] +.fi +.IP \[bu] 2 +\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for +macOS. +.IP \[bu] 2 +\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to +optimise for a particular macOS release. +.RS 2 +.IP \[bu] 2 +For example VirtIO Network and Memory Ballooning are available in Big +Sur and newer, but not previous releases. +.IP \[bu] 2 +And VirtIO Block Media (disks) are supported/stable in Catalina and +newer. +.RE +.PP +The default Windows 11 configuration looks like this: +.IP +.nf +\f[C] +guest_os=\[dq]windows\[dq] +disk_img=\[dq]windows-11/disk.qcow2\[dq] +iso=\[dq]windows-11/Win11_EnglishInternational_x64.iso\[dq] +fixed_iso=\[dq]windows-11/virtio-win.iso\[dq] +tpm=\[dq]on\[dq] +secureboot=\[dq]on\[dq] +\f[R] +.fi +.IP \[bu] 2 +\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to +optimise for Windows. +.IP \[bu] 2 +\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO +drivers. +.IP \[bu] 2 +\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a +software emulated TPM device using \f[V]swtpm\f[R]. +.SH BIOS and EFI +.PP +Since Quickemu 2.1.0 \f[V]efi\f[R] is the default boot option. +If you want to override this behaviour then add the following line to +you VM configuration to enable legacy BIOS. +.IP \[bu] 2 +\f[V]boot=\[dq]legacy\[dq]\f[R] - Enable Legacy BIOS boot +.SH Tuning CPU cores, RAM & disks +.PP +By default, Quickemu will calculate the number of CPUs cores and RAM to +allocate to a VM based on the specifications of your host computer. +You can override this default behaviour and tune the VM configuration to +your liking. +.PP +Add additional lines to your virtual machine configuration: +.IP \[bu] 2 +\f[V]cpu_cores=\[dq]4\[dq]\f[R] - Specify the number of CPU cores +allocated to the VM +.IP \[bu] 2 +\f[V]ram=\[dq]4G\[dq]\f[R] - Specify the amount of RAM to allocate to +the VM +.IP \[bu] 2 +\f[V]disk_size=\[dq]16G\[dq]\f[R] - Specify the size of the virtual disk +allocated to the VM +.SS Disk preallocation +.PP +Preallocation mode (allowed values: \f[V]off\f[R] (default), +\f[V]metadata\f[R], \f[V]falloc\f[R], \f[V]full\f[R]). +An image with preallocated metadata is initially larger but can improve +performance when the image needs to grow. +.PP +Specify what disk preallocation should be used, if any, when creating +the system disk image by adding a line like this to your VM +configuration. +.IP \[bu] 2 +\f[V]preallocation=\[dq]metadata\[dq]\f[R] +.SS CD-ROM disks +.PP +If you want to expose an ISO image from the host to guest add the +following line to the VM configuration: +.IP \[bu] 2 +\f[V]fixed_iso=\[dq]/path/to/image.iso\[dq]\f[R] +.SS Floppy disks +.PP +If you\[cq]re like Alan Pope (https://popey.com) you\[cq]ll probably +want to mount a floppy disk image in the guest. +To do so add the following line to the VM configuration: +.IP \[bu] 2 +\f[V]floppy=\[dq]/path/to/floppy.img\[dq]\f[R] +.SH File Sharing +.PP +All File Sharing options will only expose \f[V]\[ti]/Public\f[R] (or +localised variations) for the current user to the guest VMs. +.SS Samba \[u1F427] \[u1F34F] \[u1FA9F] +.PP +If \f[V]smbd\f[R] is available on the host, Quickemu will automatically +enable the built-in QEMU support for exposing a Samba share from the +host to the guest. +.PP +You can install the minimal Samba components on Ubuntu using: +.IP +.nf +\f[C] +sudo apt install --no-install-recommends samba +\f[R] +.fi +.PP +If everything is set up correctly, the \f[V]smbd\f[R] address will be +printed when the virtual machine is started. +For example: +.IP +.nf +\f[C] + - smbd: On guest: smb://10.0.2.4/qemu +\f[R] +.fi +.PP +If using a Windows guest, right-click on \[lq]This PC\[rq], click +\[lq]Add a network location\[rq], and paste this address, removing +\f[V]smb:\f[R] and replacing forward slashes with backslashes (in this +example \f[V]\[rs]\[rs]10.0.2.4\[rs]qemu\f[R]). +.SS SPICE WebDAV \[u1F427] \[u1FA9F] +.IP \[bu] 2 +TBD +.SS VirtIO-9P \[u1F427] \[u1F34F] +.IP \[bu] 2 +TBD +.SH Network port forwarding +.PP +Add an additional line to your virtual machine configuration. +For example: +.IP \[bu] 2 +\f[V]port_forwards=(\[dq]8123:8123\[dq] \[dq]8888:80\[dq])\f[R] +.PP +In the example above: +.IP \[bu] 2 +Port 8123 on the host is forwarded to port 8123 on the guest. +.IP \[bu] 2 +Port 8888 on the host is forwarded to port 80 on the guest. +.SH Disable networking +.PP +To completely disable all network interfaces in a guest VM add this +additional line to your virtual machine configuration: +.IP \[bu] 2 +\f[V]network=\[dq]none\[dq]\f[R] +.SH Restricted networking +.PP +You can isolate the guest from the host (and broader network) using the +restrict option, which will restrict networking to just the guest and +any virtual devices. +.PP +This can be used to prevent software running inside the guest from +phoning home while still providing a network inside the guest. +Add this additional line to your virtual machine configuration: +.IP \[bu] 2 +\f[V]network=\[dq]restrict\[dq]\f[R] +.SH Bridged networking +.PP +Connect your virtual machine to a preconfigured network bridge. +Add an additional line to your virtual machine configuration: +.IP \[bu] 2 +\f[V]network=\[dq]br0\[dq]\f[R] +.PP +If you want to have a persistent MAC address for your bridged network +interface in the guest VM you can add \f[V]macaddr\f[R] to the virtual +machine configuration. +QEMU requires that the MAC address is in the range: +\f[B]52:54:00:AB:00:00 - 52:54:00:AB:FF:FF\f[R] +.PP +So you can generate your own MAC addresses with: +.IP \[bu] 2 +\f[V]macaddr=\[dq]52:54:00:AB:51:AE\[dq]\f[R] +.SH USB redirection +.PP +Quickemu supports USB redirection via SPICE pass-through and host +pass-through. +.SS SPICE redirection (recommended) +.PP +Using SPICE for USB pass-through is easiest as it doesn\[cq]t require +any elevated permission, start Quickemu with \f[V]--display spice\f[R] +and then select \f[V]Input\f[R] -> +\f[V]Select USB Device for redirection\f[R] from the menu to choose +which device(s) you want to attach to the guest. +.SS Host redirection \f[B]NOT Recommended\f[R] +.PP +\f[B]USB host redirection is not recommended\f[R], it is provided purely +for backwards compatibility to older versions of Quickemu. +Using SPICE is preferred, see above. +.PP +Add an additional line to your virtual machine configuration. +For example: +.IP \[bu] 2 +\f[V]usb_devices=(\[dq]046d:082d\[dq] \[dq]046d:085e\[dq])\f[R] +.PP +In the example above: +.IP \[bu] 2 +The USB device with vendor_id 046d and product_id 082d will be exposed +to the guest. +.IP \[bu] 2 +The USB device with vendor_id 046d and product_id 085e will be exposed +to the guest. +.PP +If the USB devices are not writable, \f[V]quickemu\f[R] will display the +appropriate commands to modify the USB device(s) access permissions, +like this: +.IP +.nf +\f[C] + - USB: Host pass-through requested: + - Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes: + sudo chown -v root:user /dev/bus/usb/001/005 + ERROR! USB permission changes are required \[u1F446] +\f[R] +.fi +.SH TPM +.PP +Since Quickemu 2.2.0 a software emulated TPM device can be added to +guest virtual machines. +Just add \f[V]tpm=\[dq]on\[dq]\f[R] to your VM configuration. +\f[V]quickget\f[R] will automatically add this line to Windows 11 +virtual machines. +.SH AUTHORS +.PP +Written by Martin Wimpress. +.SH BUGS +.PP +Submit bug reports online at: + +.SH SEE ALSO +.PP +Full sources at: +.PP +quickget(1), quickemu(1), quickgui(1) +.SH AUTHORS +Martin Wimpress. diff --git a/docs/quickemu_conf.1.md b/docs/quickemu_conf.1.md new file mode 100644 index 0000000..eb0db42 --- /dev/null +++ b/docs/quickemu_conf.1.md @@ -0,0 +1,299 @@ +--- +author: Martin Wimpress +date: February 4, 2023 +footer: quickemu_conf +header: Quickemu Configuration Manual +section: 1 +title: QUICKEMU_CONF +--- + +# NAME + +quickemu_conf - Options and parameters in the quickemu \.conf + +# DESCRIPTION + +**quickemu** will create and run highly optimised desktop virtual +machines for Linux, macOS and Windows. It uses sensible defaults, but +many configuration options can be overridden in the required +configuration file, which will as a minimum specify the path to the +installation ISO and QEMU disk for the installed VM + +# OPTIONS + +These are the options and defaults for the \.conf file + +``` bash +# Lowercase variables are used in the VM config file only +boot="efi" +cpu_cores="" +disk_img="" +disk_size="" +display="" +extra_args="" +fixed_iso="" +floppy="" +guest_os="linux" +img="" +iso="" +macaddr="" +macos_release="" +network="" +port_forwards=() +preallocation="off" +ram="" +secureboot="off" +tpm="off" +usb_devices=() +viewer="spicy" +ssh_port="" +spice_port="" +public_dir="" +monitor="socket" +monitor_telnet_port="4440" +monitor_telnet_host="localhost" +monitor_cmd="" +serial="socket" +serial_telnet_port="6660" +serial_telnet_host="localhost" +# options: ehci(USB2.0), xhci(USB3.0) +usb_controller="ehci" +# options: ps2, usb, virtio +keyboard="usb" +keyboard_layout="en-us" +# options: ps2, usb, tablet, virtio +mouse="tablet" +``` + +# EXAMPLES + +``` bash +guest_os="linux" +disk_img="debian-bullseye/disk.qcow2" +iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" +``` + +The default macOS configuration looks like this: + +``` bash +guest_os="macos" +img="macos-catalina/RecoveryImage.img" +disk_img="macos-catalina/disk.qcow2" +macos_release="catalina" +``` + +- `guest_os="macos"` instructs Quickemu to optimise for macOS. +- `macos_release="catalina"` instructs Quickemu to optimise for a + particular macOS release. + - For example VirtIO Network and Memory Ballooning are available + in Big Sur and newer, but not previous releases. + - And VirtIO Block Media (disks) are supported/stable in Catalina + and newer. + +The default Windows 11 configuration looks like this: + +``` bash +guest_os="windows" +disk_img="windows-11/disk.qcow2" +iso="windows-11/Win11_EnglishInternational_x64.iso" +fixed_iso="windows-11/virtio-win.iso" +tpm="on" +secureboot="on" +``` + +- `guest_os="windows"` instructs `quickemu` to optimise for Windows. +- `fixed_iso=` specifies the ISO image that provides VirtIO drivers. +- `tpm="on"` instructs `quickemu` to create a software emulated TPM + device using `swtpm`. + +# BIOS and EFI + +Since Quickemu 2.1.0 `efi` is the default boot option. If you want to +override this behaviour then add the following line to you VM +configuration to enable legacy BIOS. + +- `boot="legacy"` - Enable Legacy BIOS boot + +# Tuning CPU cores, RAM & disks + +By default, Quickemu will calculate the number of CPUs cores and RAM to +allocate to a VM based on the specifications of your host computer. You +can override this default behaviour and tune the VM configuration to +your liking. + +Add additional lines to your virtual machine configuration: + +- `cpu_cores="4"` - Specify the number of CPU cores allocated to the + VM +- `ram="4G"` - Specify the amount of RAM to allocate to the VM +- `disk_size="16G"` - Specify the size of the virtual disk allocated + to the VM + +## Disk preallocation + +Preallocation mode (allowed values: `off` (default), `metadata`, +`falloc`, `full`). An image with preallocated metadata is initially +larger but can improve performance when the image needs to grow. + +Specify what disk preallocation should be used, if any, when creating +the system disk image by adding a line like this to your VM +configuration. + +- `preallocation="metadata"` + +## CD-ROM disks + +If you want to expose an ISO image from the host to guest add the +following line to the VM configuration: + +- `fixed_iso="/path/to/image.iso"` + +## Floppy disks + +If you're like [Alan Pope](https://popey.com) you'll probably want to +mount a floppy disk image in the guest. To do so add the following line +to the VM configuration: + +- `floppy="/path/to/floppy.img"` + +# File Sharing + +All File Sharing options will only expose `~/Public` (or localised +variations) for the current user to the guest VMs. + +## Samba 🐧 🍏 🪟 + +If `smbd` is available on the host, Quickemu will automatically enable +the built-in QEMU support for exposing a Samba share from the host to +the guest. + +You can install the minimal Samba components on Ubuntu using: + +``` bash +sudo apt install --no-install-recommends samba +``` + +If everything is set up correctly, the `smbd` address will be printed +when the virtual machine is started. For example: + + - smbd: On guest: smb://10.0.2.4/qemu + +If using a Windows guest, right-click on "This PC", click "Add a network +location", and paste this address, removing `smb:` and replacing forward +slashes with backslashes (in this example `\\10.0.2.4\qemu`). + +## SPICE WebDAV 🐧 🪟 + +- TBD + +## VirtIO-9P 🐧 🍏 + +- TBD + +# Network port forwarding + +Add an additional line to your virtual machine configuration. For +example: + +- `port_forwards=("8123:8123" "8888:80")` + +In the example above: + +- Port 8123 on the host is forwarded to port 8123 on the guest. +- Port 8888 on the host is forwarded to port 80 on the guest. + +# Disable networking + +To completely disable all network interfaces in a guest VM add this +additional line to your virtual machine configuration: + +- `network="none"` + +# Restricted networking + +You can isolate the guest from the host (and broader network) using the +restrict option, which will restrict networking to just the guest and +any virtual devices. + +This can be used to prevent software running inside the guest from +phoning home while still providing a network inside the guest. Add this +additional line to your virtual machine configuration: + +- `network="restrict"` + +# Bridged networking + +Connect your virtual machine to a preconfigured network bridge. Add an +additional line to your virtual machine configuration: + +- `network="br0"` + +If you want to have a persistent MAC address for your bridged network +interface in the guest VM you can add `macaddr` to the virtual machine +configuration. QEMU requires that the MAC address is in the range: +**52:54:00:AB:00:00 - 52:54:00:AB:FF:FF** + +So you can generate your own MAC addresses with: + +- `macaddr="52:54:00:AB:51:AE"` + +# USB redirection + +Quickemu supports USB redirection via SPICE pass-through and host +pass-through. + +## SPICE redirection (recommended) + +Using SPICE for USB pass-through is easiest as it doesn't require any +elevated permission, start Quickemu with `--display spice` and then +select `Input` -\> `Select USB Device for redirection` from the menu to +choose which device(s) you want to attach to the guest. + +## Host redirection **NOT Recommended** + +**USB host redirection is not recommended**, it is provided purely for +backwards compatibility to older versions of Quickemu. Using SPICE is +preferred, see above. + +Add an additional line to your virtual machine configuration. For +example: + +- `usb_devices=("046d:082d" "046d:085e")` + +In the example above: + +- The USB device with vendor_id 046d and product_id 082d will be + exposed to the guest. +- The USB device with vendor_id 046d and product_id 085e will be + exposed to the guest. + +If the USB devices are not writable, `quickemu` will display the +appropriate commands to modify the USB device(s) access permissions, +like this: + + - USB: Host pass-through requested: + - Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes: + sudo chown -v root:user /dev/bus/usb/001/005 + ERROR! USB permission changes are required 👆 + +# TPM + +Since Quickemu 2.2.0 a software emulated TPM device can be added to +guest virtual machines. Just add `tpm="on"` to your VM configuration. +`quickget` will automatically add this line to Windows 11 virtual +machines. + +# AUTHORS + +Written by Martin Wimpress. + +# BUGS + +Submit bug reports online at: + + +# SEE ALSO + +Full sources at: + +quickget(1), quickemu(1), quickgui(1) diff --git a/docs/quickget.1 b/docs/quickget.1 new file mode 100644 index 0000000..60484ee --- /dev/null +++ b/docs/quickget.1 @@ -0,0 +1,532 @@ +.\" Automatically generated by Pandoc 2.19.2 +.\" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "QUICKGET" "1" "February 4, 2023" "quickget" "Quickget User Manual" +.hy +.SH NAME +.PP +quickget - download and prepare materials for building a quickemu VM +.SH SYNOPSIS +.PP +\f[B]quickget\f[R] [\f[I]os\f[R]] [\f[I]release\f[R]] +[\f[I]edition\f[R]] | [\f[I]OPTION\f[R]]* +.SH DESCRIPTION +.PP +\f[B]quickget\f[R] will download the requisite materials and prepare a +configuration for \f[V]quickemu\f[R] to use to build and run +.SH OPTIONS +.TP +\f[B]version | -version | \[en]version\f[R] +show version (from Quickemu) +.TP +\f[B]list | list_csv | list_json\f[R] +provide a csv list of all supported guest OSes, versions and variants. +.TP +\f[B][OS] [Release] [Edition]\f[R] +specify the OS and release (and optional edition) if insufficient input +is provided a list of missing options will be reported and the script +will exit. +Editions may not apply and will be defaulted if not provided. +.SH NOTES +.SS Ubuntu Guest +.PP +\f[V]quickget\f[R] will automatically download an Ubuntu release and +create the virtual machine configuration. +.IP +.nf +\f[C] +quickget ubuntu 22.04 +quickemu --vm ubuntu-22.04.conf +\f[R] +.fi +.IP \[bu] 2 +Complete the installation as normal. +.IP \[bu] 2 +Post-install: +.RS 2 +.IP \[bu] 2 +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection +.RS 2 +.IP \[bu] 2 +\f[V]sudo apt install spice-vdagent\f[R] +.RE +.IP \[bu] 2 +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. +.RS 2 +.IP \[bu] 2 +\f[V]sudo apt install spice-webdavd\f[R] +.RE +.RE +.SS Ubuntu devel (daily-live) images +.PP +\f[V]quickget\f[R] can also download/refresh devel images via +\f[V]zsync\f[R] for Ubuntu developers and testers. +.IP +.nf +\f[C] +quickget ubuntu devel +quickemu --vm ubuntu-devel.conf +\f[R] +.fi +.PP +You can run \f[V]quickget ubuntu devel\f[R] to refresh your daily +development image as often as you like, it will even automatically +switch to a new series. +.SS Ubuntu Flavours +.PP +All the official Ubuntu flavours are supported, just replace +\f[V]ubuntu\f[R] with your preferred flavour. +.IP \[bu] 2 +\f[V]kubuntu\f[R] (Kubuntu) +.IP \[bu] 2 +\f[V]lubuntu\f[R] (Lubuntu) +.IP \[bu] 2 +\f[V]ubuntu-budgie\f[R] (Ubuntu Budgie) +.IP \[bu] 2 +\f[V]ubuntukylin\f[R] (Ubuntu Kylin) +.IP \[bu] 2 +\f[V]ubuntu-mate\f[R] (Ubuntu MATE) +.IP \[bu] 2 +\f[V]ubuntustudio\f[R] (Ubuntu Studio) +.IP \[bu] 2 +\f[V]ubuntu\f[R] (Ubuntu) +.IP \[bu] 2 +\f[V]ubuntu-unity\f[R] (Ubuntu Unity) +.IP \[bu] 2 +\f[V]xubuntu\f[R] (Xubuntu) +.SS Other Operating Systems +.PP +\f[V]quickget\f[R] also supports: +.IP \[bu] 2 +\f[V]alma\f[R] (Alma Linux) +.IP \[bu] 2 +\f[V]alpine\f[R] (Alpine Linux) +.IP \[bu] 2 +\f[V]android\f[R] (Android x86) +.IP \[bu] 2 +\f[V]archcraft\f[R] (Archcraft) +.IP \[bu] 2 +\f[V]archlinux\f[R] (Arch Linux) +.IP \[bu] 2 +\f[V]arcolinux\f[R] (Arco Linux) +.IP \[bu] 2 +\f[V]batocera\f[R] (Batocera) +.IP \[bu] 2 +\f[V]cachyos\f[R] (CachyOS) +.IP \[bu] 2 +\f[V]centos-stream\f[R] (CentOS Stream) +.IP \[bu] 2 +\f[V]debian\f[R] (Debian) +.IP \[bu] 2 +\f[V]deepin\f[R] (Deepin) +.IP \[bu] 2 +\f[V]devuan\f[R] (Devuan) +.IP \[bu] 2 +\f[V]dragonflybsd\f[R] (DragonFlyBSD) +.IP \[bu] 2 +\f[V]elementary\f[R] (elementary OS) +.IP \[bu] 2 +\f[V]endeavouros\f[R] (EndeavourOS) +.IP \[bu] 2 +\f[V]fedora\f[R] (Fedora) +.IP \[bu] 2 +\f[V]freebsd\f[R] (FreeBSD) +.IP \[bu] 2 +\f[V]freedos\f[R] (FreeDOS) +.IP \[bu] 2 +\f[V]garuda\f[R] (Garuda Linux) +.IP \[bu] 2 +\f[V]gentoo\f[R] (Gentoo) +.IP \[bu] 2 +\f[V]ghostbsd\f[R] (GhostBSD) +.IP \[bu] 2 +\f[V]haiku\f[R] (Haiku) +.IP \[bu] 2 +\f[V]kali\f[R] (Kali) +.IP \[bu] 2 +\f[V]kdeneon\f[R] (KDE Neon) +.IP \[bu] 2 +\f[V]kolibrios\f[R] (KolibriOS) +.IP \[bu] 2 +\f[V]linuxmint\f[R] (Linux Mint) +.IP \[bu] 2 +\f[V]lmde\f[R] (Linux Mint Debian Edition) +.IP \[bu] 2 +\f[V]mageia\f[R] (Mageia) +.IP \[bu] 2 +\f[V]manjaro\f[R] (Manjaro) +.IP \[bu] 2 +\f[V]mxlinux\f[R] (MX Linux) +.IP \[bu] 2 +\f[V]netboot\f[R] (netboot.xyz) +.IP \[bu] 2 +\f[V]netbsd\f[R] (NetBSD) +.IP \[bu] 2 +\f[V]nixos\f[R] (NixOS) +.IP \[bu] 2 +\f[V]openbsd\f[R] (OpenBSD) +.IP \[bu] 2 +\f[V]opensuse\f[R] (openSUSE) +.IP \[bu] 2 +\f[V]oraclelinux\f[R] (Oracle Linux) +.IP \[bu] 2 +\f[V]popos\f[R] (Pop!_OS) +.IP \[bu] 2 +\f[V]reactos\f[R] (ReactOS) +.IP \[bu] 2 +\f[V]rebornos\f[R] (RebornOS) +.IP \[bu] 2 +\f[V]rockylinux\f[R] (Rocky Linux) +.IP \[bu] 2 +\f[V]slackware\f[R] (Slackware) +.IP \[bu] 2 +\f[V]solus\f[R] (Solus) +.IP \[bu] 2 +\f[V]tails\f[R] (Tails) +.IP \[bu] 2 +\f[V]truenas-core\f[R] (TrueNAS Core) +.IP \[bu] 2 +\f[V]truenas-scale\f[R] (TrueNAS Scale) +.IP \[bu] 2 +\f[V]void\f[R] (Void Linux) +.IP \[bu] 2 +\f[V]zorin\f[R] (Zorin OS) +.PP +Or you can download a Linux image and manually create a VM +configuration. +.IP \[bu] 2 +Download a .iso image of a Linux distribution +.IP \[bu] 2 +Create a VM configuration file; for example +\f[V]debian-bullseye.conf\f[R] +.IP +.nf +\f[C] +guest_os=\[dq]linux\[dq] +disk_img=\[dq]debian-bullseye/disk.qcow2\[dq] +iso=\[dq]debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso\[dq] +\f[R] +.fi +.IP \[bu] 2 +Use \f[V]quickemu\f[R] to start the virtual machine: +.IP +.nf +\f[C] +quickemu --vm debian-bullseye.conf +\f[R] +.fi +.IP \[bu] 2 +Complete the installation as normal. +.IP \[bu] 2 +Post-install: +.RS 2 +.IP \[bu] 2 +Install the SPICE agent (\f[V]spice-vdagent\f[R]) in the guest to enable +copy/paste and USB redirection. +.IP \[bu] 2 +Install the SPICE WebDAV agent (\f[V]spice-webdavd\f[R]) in the guest to +enable file sharing. +.RE +.SS macOS Guest +.PP +\f[V]quickget\f[R] automatically downloads a macOS recovery image and +creates a virtual machine configuration. +.IP +.nf +\f[C] +quickget macos catalina +quickemu --vm macos-catalina.conf +\f[R] +.fi +.PP +macOS \f[V]high-sierra\f[R], \f[V]mojave\f[R], \f[V]catalina\f[R], +\f[V]big-sur\f[R] and \f[V]monterey\f[R] are supported. +.IP \[bu] 2 +Use cursor keys and enter key to select the \f[B]macOS Base System\f[R] +.IP \[bu] 2 +From \f[B]macOS Utilities\f[R] +.RS 2 +.IP \[bu] 2 +Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R] +.RS 2 +.IP \[bu] 2 +Select \f[V]QEMU HARDDISK Media\f[R] (\[ti]103.08GB) from the list and +click \f[B]Erase\f[R]. +.IP \[bu] 2 +Enter a \f[V]Name:\f[R] for the disk +.IP \[bu] 2 +If you are installing macOS Mojave or later (Catalina, Big Sur, and +Monterey), choose any of the APFS options as the filesystem. +MacOS Extended may not work. +.RE +.IP \[bu] 2 +Click \f[B]Erase\f[R]. +.IP \[bu] 2 +Click \f[B]Done\f[R]. +.IP \[bu] 2 +Close Disk Utility +.RE +.IP \[bu] 2 +From \f[B]macOS Utilities\f[R] +.RS 2 +.IP \[bu] 2 +Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R] +.RE +.IP \[bu] 2 +Complete the installation as you normally would. +.RS 2 +.IP \[bu] 2 +On the first reboot use cursor keys and enter key to select \f[B]macOS +Installer\f[R] +.IP \[bu] 2 +On the subsequent reboots use cursor keys and enter key to select the +disk you named +.RE +.IP \[bu] 2 +Once you have finished installing macOS you will be presented with an +the out-of-the-box first-start wizard to configure various options and +set up your username and password +.IP \[bu] 2 +OPTIONAL: After you have concluded the out-of-the-box wizard, you may +want to enable the TRIM feature that the computer industry created for +SSD disks. +This feature in our macOS installation will allow QuickEmu to compact +(shrink) your macOS disk image whenever you delete files inside the +Virtual Machine. +Without this step your macOS disk image will only ever get larger and +will not shrink even when you delete lots of data inside macOS. +.RS 2 +.IP \[bu] 2 +To enable TRIM, open the Terminal application and type the following +command followed by pressing enter to tell macos to use the TRIM command +on the hard disk when files are deleted: +.RE +.IP +.nf +\f[C] +sudo trimforce enable +\f[R] +.fi +.PP +You will be prompted to enter your account\[cq]s password to gain the +privilege needed. +Once you\[cq]ve entered your password and pressed enter the command will +request confirmation in the form of two questions that require you to +type y (for a \[lq]yes\[rq] response) followed by enter to confirm. +If you press enter without first typing y the system will consider that +a negative response as though you said \[lq]no\[rq]: +.IP +.nf +\f[C] +IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an \[dq]as is\[dq] basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. +Are you sure you with to proceed (y/N)? +\f[R] +.fi +.PP +And a second confirmation once you\[cq]ve confirmed the previous one: +.IP +.nf +\f[C] +Your system will immediately reboot when this is complete. +Is this OK (y/N)? +\f[R] +.fi +.PP +As the last message states, your system will automatically reboot as +soon as the command completes. +.PP +The default macOS configuration looks like this: +.IP +.nf +\f[C] +guest_os=\[dq]macos\[dq] +img=\[dq]macos-catalina/RecoveryImage.img\[dq] +disk_img=\[dq]macos-catalina/disk.qcow2\[dq] +macos_release=\[dq]catalina\[dq] +\f[R] +.fi +.IP \[bu] 2 +\f[V]guest_os=\[dq]macos\[dq]\f[R] instructs Quickemu to optimise for +macOS. +.IP \[bu] 2 +\f[V]macos_release=\[dq]catalina\[dq]\f[R] instructs Quickemu to +optimise for a particular macOS release. +.RS 2 +.IP \[bu] 2 +For example VirtIO Network and Memory Ballooning are available in Big +Sur and newer, but not previous releases. +.IP \[bu] 2 +And VirtIO Block Media (disks) are supported/stable in Catalina and +newer. +.RE +.SS macOS compatibility +.PP +There are some considerations when running macOS via Quickemu. +.IP \[bu] 2 +Supported macOS releases: +.RS 2 +.IP \[bu] 2 +High Sierra +.IP \[bu] 2 +Mojave +.IP \[bu] 2 +Catalina \f[B](Recommended)\f[R] +.IP \[bu] 2 +Big Sur +.IP \[bu] 2 +Monterey +.RE +.IP \[bu] 2 +\f[V]quickemu\f[R] will automatically download the required +OpenCore (https://github.com/acidanthera/OpenCorePkg) bootloader and +OVMF firmware from OSX-KVM (https://github.com/kholia/OSX-KVM). +.IP \[bu] 2 +Optimised by default, but no GPU acceleration is available. +.RS 2 +.IP \[bu] 2 +Host CPU vendor is detected and guest CPU is optimised accordingly. +.IP \[bu] 2 +VirtIO Block +Media (https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is used +for the system disk where supported. +.IP \[bu] 2 +VirtIO \f[V]usb-tablet\f[R] (http://philjordan.eu/osx-virt/) is used for +the mouse. +.IP \[bu] 2 +VirtIO Network (\f[V]virtio-net\f[R]) is supported and enabled on macOS +Big Sur and newer but previous releases use \f[V]vmxnet3\f[R]. +.IP \[bu] 2 +VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and +newer but disabled for other support macOS releases. +.RE +.IP \[bu] 2 +USB host and SPICE pass-through is: +.RS 2 +.IP \[bu] 2 +UHCI (USB 2.0) on macOS Catalina and earlier. +.IP \[bu] 2 +XHCI (USB 3.0) on macOS Big Sur and newer. +.RE +.IP \[bu] 2 +Display resolution can only be changed via macOS System Preferences. +.IP \[bu] 2 +\f[B]Full Duplex audio requires VoodooHDA +OC (https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB +audio-device to the macOS guest VM\f[R]. +.IP \[bu] 2 +NOTE! +Gatekeeper (https://disable-gatekeeper.github.io/) and System Integrity +Protection +(SIP) (https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection) +need to be disabled to install VoodooHDA OC +.IP \[bu] 2 +File sharing between guest and host is available via +virtio-9p (https://wiki.qemu.org/Documentation/9psetup) and SPICE +webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24). +.IP \[bu] 2 +Copy/paste via SPICE agent is \f[B]not available on macOS\f[R]. +.SS macOS App Store +.PP +If you see \f[I]\[lq]Your device or computer could not be +verified\[rq]\f[R] when you try to login to the App Store, make sure +that your wired ethernet device is \f[V]en0\f[R]. +Use \f[V]ifconfig\f[R] in a terminal to verify this. +.PP +If the wired ethernet device is not \f[V]en0\f[R], then then go to +\f[I]System Preferences\f[R] -> \f[I]Network\f[R], delete all the +network devices and apply the changes. +Next, open a terminal and run the following: +.IP +.nf +\f[C] +sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist +\f[R] +.fi +.PP +Now reboot, and the App Store should work. +.SS Windows 10 & 11 Guests +.PP +\f[V]quickget\f[R] can not download +Windows10 (https://www.microsoft.com/software-download/windows10) and +Windows 11 (https://www.microsoft.com/software-download/windows11) +automatically, but does automatically create an optimised virtual +machine configuration that you can just add an Windows .iso image to. +This configuration also includes the VirtIO drivers for +Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). +\f[V]quickget\f[R] can automatically download Windows 8.1, Windows +10 (https://www.microsoft.com/en-gb/software-download/windows10ISO) and +Windows 11 (https://www.microsoft.com/en-gb/software-download/windows11) +along with the VirtIO drivers for +Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/) +and creates a virtual machine configuration. +.IP +.nf +\f[C] +quickget windows 11 +quickemu --vm windows-11.conf +\f[R] +.fi +.IP \[bu] 2 +Complete the installation as you normally would. +.IP \[bu] 2 +All relevant drivers and services should be installed automatically. +.IP \[bu] 2 +A local adminstrator user account is automatically created, with these +credentials: +.RS 2 +.IP \[bu] 2 +Username: \f[V]Quickemu\f[R] +.IP \[bu] 2 +Password: \f[V]quickemu\f[R] +.RE +.PP +The default Windows 11 configuration looks like this: +.IP +.nf +\f[C] +guest_os=\[dq]windows\[dq] +disk_img=\[dq]windows-11/disk.qcow2\[dq] +iso=\[dq]windows-11/windows-11.iso\[dq] +fixed_iso=\[dq]windows-11/virtio-win.iso\[dq] +tpm=\[dq]on\[dq] +secureboot=\[dq]on\[dq] +\f[R] +.fi +.IP \[bu] 2 +\f[V]guest_os=\[dq]windows\[dq]\f[R] instructs \f[V]quickemu\f[R] to +optimise for Windows. +.IP \[bu] 2 +\f[V]fixed_iso=\f[R] specifies the ISO image that provides VirtIO +drivers. +.IP \[bu] 2 +\f[V]tpm=\[dq]on\[dq]\f[R] instructs \f[V]quickemu\f[R] to create a +software emulated TPM device using \f[V]swtpm\f[R]. +.SH AUTHORS +.PP +Written by Martin Wimpress. +.SH BUGS +.PP +Submit bug reports online at: + +.SH SEE ALSO +.PP +Full sources at: +.PP +quickemu(1), quickemu_conf(1), quickgui(1) +.SH AUTHORS +Martin Wimpress. diff --git a/docs/quickget.1.md b/docs/quickget.1.md new file mode 100644 index 0000000..c3e72e6 --- /dev/null +++ b/docs/quickget.1.md @@ -0,0 +1,373 @@ +--- +author: Martin Wimpress +date: February 4, 2023 +footer: quickget +header: Quickget User Manual +section: 1 +title: QUICKGET +--- + +# NAME + +quickget - download and prepare materials for building a quickemu VM + +# SYNOPSIS + +**quickget** \[*os*\] \[*release*\] \[*edition*\] \| \[*OPTION*\]\* + +# DESCRIPTION + +**quickget** will download the requisite materials and prepare a +configuration for `quickemu` to use to build and run + +# OPTIONS + +**version \| -version \| --version** +: show version (from Quickemu) + +**list \| list_csv \| list_json** +: provide a csv list of all supported guest OSes, versions and + variants. + +**\[OS\] \[Release\] \[Edition\]** +: specify the OS and release (and optional edition) if insufficient + input is provided a list of missing options will be reported and the + script will exit. Editions may not apply and will be defaulted if + not provided. + +# NOTES + +## Ubuntu Guest + +`quickget` will automatically download an Ubuntu release and create the +virtual machine configuration. + +``` bash +quickget ubuntu 22.04 +quickemu --vm ubuntu-22.04.conf +``` + +- Complete the installation as normal. +- Post-install: + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection + - `sudo apt install spice-vdagent` + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. + - `sudo apt install spice-webdavd` + +### Ubuntu devel (daily-live) images + +`quickget` can also download/refresh devel images via `zsync` for Ubuntu +developers and testers. + +``` bash +quickget ubuntu devel +quickemu --vm ubuntu-devel.conf +``` + +You can run `quickget ubuntu devel` to refresh your daily development +image as often as you like, it will even automatically switch to a new +series. + +### Ubuntu Flavours + +All the official Ubuntu flavours are supported, just replace `ubuntu` +with your preferred flavour. + +- `kubuntu` (Kubuntu) +- `lubuntu` (Lubuntu) +- `ubuntu-budgie` (Ubuntu Budgie) +- `ubuntukylin` (Ubuntu Kylin) +- `ubuntu-mate` (Ubuntu MATE) +- `ubuntustudio` (Ubuntu Studio) +- `ubuntu` (Ubuntu) +- `ubuntu-unity` (Ubuntu Unity) +- `xubuntu` (Xubuntu) + +## Other Operating Systems + +`quickget` also supports: + +- `alma` (Alma Linux) +- `alpine` (Alpine Linux) +- `android` (Android x86) +- `archcraft` (Archcraft) +- `archlinux` (Arch Linux) +- `arcolinux` (Arco Linux) +- `batocera` (Batocera) +- `cachyos` (CachyOS) +- `centos-stream` (CentOS Stream) +- `debian` (Debian) +- `deepin` (Deepin) +- `devuan` (Devuan) +- `dragonflybsd` (DragonFlyBSD) +- `elementary` (elementary OS) +- `endeavouros` (EndeavourOS) +- `fedora` (Fedora) +- `freebsd` (FreeBSD) +- `freedos` (FreeDOS) +- `garuda` (Garuda Linux) +- `gentoo` (Gentoo) +- `ghostbsd` (GhostBSD) +- `haiku` (Haiku) +- `kali` (Kali) +- `kdeneon` (KDE Neon) +- `kolibrios` (KolibriOS) +- `linuxmint` (Linux Mint) +- `lmde` (Linux Mint Debian Edition) +- `mageia` (Mageia) +- `manjaro` (Manjaro) +- `mxlinux` (MX Linux) +- `netboot` (netboot.xyz) +- `netbsd` (NetBSD) +- `nixos` (NixOS) +- `openbsd` (OpenBSD) +- `opensuse` (openSUSE) +- `oraclelinux` (Oracle Linux) +- `popos` (Pop!\_OS) +- `reactos` (ReactOS) +- `rebornos` (RebornOS) +- `rockylinux` (Rocky Linux) +- `slackware` (Slackware) +- `solus` (Solus) +- `tails` (Tails) +- `truenas-core` (TrueNAS Core) +- `truenas-scale` (TrueNAS Scale) +- `void` (Void Linux) +- `zorin` (Zorin OS) + +Or you can download a Linux image and manually create a VM +configuration. + +- Download a .iso image of a Linux distribution +- Create a VM configuration file; for example `debian-bullseye.conf` + +``` bash +guest_os="linux" +disk_img="debian-bullseye/disk.qcow2" +iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso" +``` + +- Use `quickemu` to start the virtual machine: + +``` bash +quickemu --vm debian-bullseye.conf +``` + +- Complete the installation as normal. +- Post-install: + - Install the SPICE agent (`spice-vdagent`) in the guest to enable + copy/paste and USB redirection. + - Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to + enable file sharing. + +## macOS Guest + +`quickget` automatically downloads a macOS recovery image and creates a +virtual machine configuration. + +``` bash +quickget macos catalina +quickemu --vm macos-catalina.conf +``` + +macOS `high-sierra`, `mojave`, `catalina`, `big-sur` and `monterey` are +supported. + +- Use cursor keys and enter key to select the **macOS Base System** +- From **macOS Utilities** + - Click **Disk Utility** and **Continue** + - Select `QEMU HARDDISK Media` (\~103.08GB) from the list and + click **Erase**. + - Enter a `Name:` for the disk + - If you are installing macOS Mojave or later (Catalina, Big + Sur, and Monterey), choose any of the APFS options as the + filesystem. MacOS Extended may not work. + - Click **Erase**. + - Click **Done**. + - Close Disk Utility +- From **macOS Utilities** + - Click **Reinstall macOS** and **Continue** +- Complete the installation as you normally would. + - On the first reboot use cursor keys and enter key to select + **macOS Installer** + - On the subsequent reboots use cursor keys and enter key to + select the disk you named +- Once you have finished installing macOS you will be presented with + an the out-of-the-box first-start wizard to configure various + options and set up your username and password +- OPTIONAL: After you have concluded the out-of-the-box wizard, you + may want to enable the TRIM feature that the computer industry + created for SSD disks. This feature in our macOS installation will + allow QuickEmu to compact (shrink) your macOS disk image whenever + you delete files inside the Virtual Machine. Without this step your + macOS disk image will only ever get larger and will not shrink even + when you delete lots of data inside macOS. + - To enable TRIM, open the Terminal application and type the + following command followed by pressing + ``{=html}enter``{=html} to tell macos to use the TRIM + command on the hard disk when files are deleted: + +``` bash +sudo trimforce enable +``` + +You will be prompted to enter your account's password to gain the +privilege needed. Once you've entered your password and pressed +``{=html}enter``{=html} the command will request confirmation +in the form of two questions that require you to type +``{=html}y``{=html} (for a "yes" response) followed by +``{=html}enter``{=html} to confirm. If you press +``{=html}enter``{=html} without first typing +``{=html}y``{=html} the system will consider that a negative +response as though you said "no": + +``` plain +IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. +Are you sure you with to proceed (y/N)? +``` + +And a second confirmation once you've confirmed the previous one: + +``` plain +Your system will immediately reboot when this is complete. +Is this OK (y/N)? +``` + +As the last message states, your system will automatically reboot as +soon as the command completes. + +The default macOS configuration looks like this: + +``` bash +guest_os="macos" +img="macos-catalina/RecoveryImage.img" +disk_img="macos-catalina/disk.qcow2" +macos_release="catalina" +``` + +- `guest_os="macos"` instructs Quickemu to optimise for macOS. +- `macos_release="catalina"` instructs Quickemu to optimise for a + particular macOS release. + - For example VirtIO Network and Memory Ballooning are available + in Big Sur and newer, but not previous releases. + - And VirtIO Block Media (disks) are supported/stable in Catalina + and newer. + +### macOS compatibility + +There are some considerations when running macOS via Quickemu. + +- Supported macOS releases: + - High Sierra + - Mojave + - Catalina **(Recommended)** + - Big Sur + - Monterey +- `quickemu` will automatically download the required + [OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader + and OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM). +- Optimised by default, but no GPU acceleration is available. + - Host CPU vendor is detected and guest CPU is optimised + accordingly. + - [VirtIO Block + Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is + used for the system disk where supported. + - [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used + for the mouse. + - VirtIO Network (`virtio-net`) is supported and enabled on macOS + Big Sur and newer but previous releases use `vmxnet3`. + - VirtIO Memory Ballooning is supported and enabled on macOS Big + Sur and newer but disabled for other support macOS releases. +- USB host and SPICE pass-through is: + - UHCI (USB 2.0) on macOS Catalina and earlier. + - XHCI (USB 3.0) on macOS Big Sur and newer. +- Display resolution can only be changed via macOS System Preferences. +- **Full Duplex audio requires [VoodooHDA + OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB + audio-device to the macOS guest VM**. +- NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and + [System Integrity Protection + (SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection) + need to be disabled to install VoodooHDA OC +- File sharing between guest and host is available via + [virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE + webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24). +- Copy/paste via SPICE agent is **not available on macOS**. + +### macOS App Store + +If you see *"Your device or computer could not be verified"* when you +try to login to the App Store, make sure that your wired ethernet device +is `en0`. Use `ifconfig` in a terminal to verify this. + +If the wired ethernet device is not `en0`, then then go to *System +Preferences* -\> *Network*, delete all the network devices and apply the +changes. Next, open a terminal and run the following: + +``` bash +sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist +``` + +Now reboot, and the App Store should work. + +## Windows 10 & 11 Guests + +`quickget` can not download +[Windows10](https://www.microsoft.com/software-download/windows10) and +[Windows 11](https://www.microsoft.com/software-download/windows11) +automatically, but does automatically create an optimised virtual +machine configuration that you can just add an Windows .iso image to. +This configuration also includes the [VirtIO drivers for +Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). +`quickget` can automatically download Windows 8.1, [Windows +10](https://www.microsoft.com/en-gb/software-download/windows10ISO) and +[Windows +11](https://www.microsoft.com/en-gb/software-download/windows11) along +with the [VirtIO drivers for +Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/) +and creates a virtual machine configuration. + +``` bash +quickget windows 11 +quickemu --vm windows-11.conf +``` + +- Complete the installation as you normally would. +- All relevant drivers and services should be installed automatically. +- A local adminstrator user account is automatically created, with + these credentials: + - Username: `Quickemu` + - Password: `quickemu` + +The default Windows 11 configuration looks like this: + +``` bash +guest_os="windows" +disk_img="windows-11/disk.qcow2" +iso="windows-11/windows-11.iso" +fixed_iso="windows-11/virtio-win.iso" +tpm="on" +secureboot="on" +``` + +- `guest_os="windows"` instructs `quickemu` to optimise for Windows. +- `fixed_iso=` specifies the ISO image that provides VirtIO drivers. +- `tpm="on"` instructs `quickemu` to create a software emulated TPM + device using `swtpm`. + +# AUTHORS + +Written by Martin Wimpress. + +# BUGS + +Submit bug reports online at: + + +# SEE ALSO + +Full sources at: + +quickemu(1), quickemu_conf(1), quickgui(1) diff --git a/quickemu b/quickemu new file mode 100755 index 0000000..79ee129 --- /dev/null +++ b/quickemu @@ -0,0 +1,1817 @@ +#!/usr/bin/env bash +export LC_ALL=C + +if ((BASH_VERSINFO[0] < 4)); then + echo "Sorry, you need bash 4.0 or newer to run this script." + exit 1 +fi + +function ignore_msrs_always() { + # Make sure the host has /etc/modprobe.d + if [ -d /etc/modprobe.d ]; then + # Skip if ignore_msrs is already enabled, assumes initramfs has been rebuilt + if grep -lq 'ignore_msrs=Y' /etc/modprobe.d/kvm-quickemu.conf >/dev/null 2>&1; then + echo "options kvm ignore_msrs=Y" | sudo tee /etc/modprobe.d/kvm-quickemu.conf + sudo update-initramfs -k all -u + fi + else + echo "ERROR! /etc/modprobe.d was not found, I don't know how to configure this system." + exit 1 + fi +} + +function ignore_msrs_alert() { + local ignore_msrs="" + if [ -e /sys/module/kvm/parameters/ignore_msrs ]; then + ignore_msrs=$(cat /sys/module/kvm/parameters/ignore_msrs) + if [ "${ignore_msrs}" == "N" ]; then + echo " - MSR: WARNING! Ignoring unhandled Model-Specific Registers is disabled." + echo + echo " echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs" + echo + echo " If you are unable to run macOS or Windows VMs then run the above 👆" + echo " This will enable ignoring of unhandled MSRs until you reboot the host." + echo " You can make this change permenant by running: 'quickemu --ignore-msrs-always'" + fi + fi +} + +function delete_shortcut() { + local SHORTCUT_DIR="${HOME}/.local/share/applications/" + if [ -e "${SHORTCUT_DIR}/${VMNAME}.desktop" ]; then + rm "${SHORTCUT_DIR}/${VMNAME}.desktop" + echo "Deleted ${VM} desktop shortcut" + fi +} + +function delete_disk() { + if [ -e "${disk_img}" ]; then + rm "${disk_img}" + # Remove any EFI vars, but not for macOS + rm "${VMDIR}"/OVMF_VARS*.fd >/dev/null 2>&1 + rm "${VMPATH}/${VMDIR}"/OVMF_VARS*.fd >/dev/null 2>&1 + rm "${VMDIR}/${VMNAME}-vars.fd" >/dev/null 2>&1 + rm "${VMPATH}/${VMDIR}/${VMNAME}-vars.fd" > /dev/null 2>&1 + echo "SUCCESS! Deleted ${disk_img}" + delete_shortcut + else + echo "NOTE! ${disk_img} not found. Doing nothing." + fi +} + +function delete_vm() { + if [ -d "${VMDIR}" ]; then + rm -rf "${VMDIR}" + rm "${VM}" + echo "SUCCESS! Deleted ${VM} and ${VMDIR}" + delete_shortcut + else + echo "NOTE! ${VMDIR} not found. Doing nothing." + fi +} + +function snapshot_apply() { + local TAG="${1}" + if [ -z "${TAG}" ]; then + echo "ERROR! No snapshot tag provided." + exit + fi + + if [ -e "${disk_img}" ]; then + if ${QEMU_IMG} snapshot -q -a "${TAG}" "${disk_img}"; then + echo "SUCCESS! Applied snapshot ${TAG} to ${disk_img}" + else + echo "ERROR! Failed to apply snapshot ${TAG} to ${disk_img}" + fi + else + echo "NOTE! ${disk_img} not found. Doing nothing." + fi +} + +function snapshot_create() { + local TAG="${1}" + if [ -z "${TAG}" ]; then + echo "ERROR! No snapshot tag provided." + exit + fi + + if [ -e "${disk_img}" ]; then + if ${QEMU_IMG} snapshot -q -c "${TAG}" "${disk_img}"; then + echo "SUCCESS! Created snapshot ${TAG} of ${disk_img}" + else + echo "ERROR! Failed to create snapshot ${TAG} of ${disk_img}" + fi + else + echo "NOTE! ${disk_img} not found. Doing nothing." + fi +} + +function snapshot_delete() { + local TAG="${1}" + if [ -z "${TAG}" ]; then + echo "ERROR! No snapshot tag provided." + exit + fi + + if [ -e "${disk_img}" ]; then + if ${QEMU_IMG} snapshot -q -d "${TAG}" "${disk_img}"; then + echo "SUCCESS! Deleted snapshot ${TAG} of ${disk_img}" + else + echo "ERROR! Failed to delete snapshot ${TAG} of ${disk_img}" + fi + else + echo "NOTE! ${disk_img} not found. Doing nothing." + fi +} + +function snapshot_info() { + if [ -e "${disk_img}" ]; then + ${QEMU_IMG} info "${disk_img}" + fi +} + +function get_port() { + local PORT_START=$1 + local PORT_RANGE=$((PORT_START+$2)) + local PORT + for ((PORT = PORT_START; PORT <= PORT_RANGE; PORT++)); do + # Make sure port scans do not block too long. + timeout 0.1s bash -c "echo >/dev/tcp/127.0.0.1/${PORT}" >/dev/null 2>&1 + if [ ${?} -eq 1 ]; then + echo "${PORT}" + break + fi + done +} + +function enable_usb_passthrough() { + local DEVICE="" + local USB_BUS="" + local USB_DEV="" + local USB_NAME="" + local VENDOR_ID="" + local PRODUCT_ID="" + local USB_NOT_READY=0 + + # Have any USB devices been requested for pass-through? + if (( ${#usb_devices[@]} )); then + echo " - USB: Host pass-through requested:" + for DEVICE in "${usb_devices[@]}"; do + VENDOR_ID=$(echo "${DEVICE}" | cut -d':' -f1) + PRODUCT_ID=$(echo "${DEVICE}" | cut -d':' -f2) + USB_BUS=$(lsusb -d "${VENDOR_ID}:${PRODUCT_ID}" | cut -d' ' -f2) + USB_DEV=$(lsusb -d "${VENDOR_ID}:${PRODUCT_ID}" | cut -d' ' -f4 | cut -d':' -f1) + USB_NAME=$(lsusb -d "${VENDOR_ID}:${PRODUCT_ID}" | cut -d' ' -f7-) + if [ -z "${USB_NAME}" ]; then + echo " ! USB device ${VENDOR_ID}:${PRODUCT_ID} not found. Check your configuration" + continue + elif [ -w "/dev/bus/usb/${USB_BUS}/${USB_DEV}" ]; then + echo " o ${USB_NAME} on bus ${USB_BUS} device ${USB_DEV} is accessible." + else + echo " x ${USB_NAME} on bus ${USB_BUS} device ${USB_DEV} needs permission changes:" + echo " sudo chown -v root:${USER} /dev/bus/usb/${USB_BUS}/${USB_DEV}" + USB_NOT_READY=1 + fi + USB_PASSTHROUGH="${USB_PASSTHROUGH} -device usb-host,bus=hostpass.0,vendorid=0x${VENDOR_ID},productid=0x${PRODUCT_ID}" + done + + if [ "${USB_NOT_READY}" -eq 1 ]; then + echo " ERROR! USB permission changes are required 👆" + exit 1 + fi + fi +} + +function check_cpu_flag() { + local HOST_CPU_FLAG="${1}" + if lscpu | grep -o "^Flags\b.*: .*\b${HOST_CPU_FLAG}\b" > /dev/null; then + return 0 + else + return 1 + fi +} + +function efi_vars() { + local VARS_IN="" + local VARS_OUT="" + VARS_IN="${1}" + VARS_OUT="${2}" + + if [ ! -e "${VARS_OUT}" ]; then + if [ -e "${VARS_IN}" ]; then + cp "${VARS_IN}" "${VARS_OUT}" + else + echo "ERROR! ${VARS_IN} was not found. Please install edk2." + exit 1 + fi + fi +} + +function vm_boot() { + local AUDIO_DEV="" + local BALLOON="-device virtio-balloon" + local BOOT_STATUS="" + local CPU="" + local DISK_USED="" + local DISPLAY_DEVICE="" + local DISPLAY_RENDER="" + local EFI_CODE="${EFI_CODE}" + local EFI_VARS="" + local GUEST_CPU_CORES="" + local GUEST_CPU_LOGICAL_CORES="" + local GUEST_CPU_THREADS="" + local HOST_CPU_CORES="" + local HOST_CPU_SMT="" + local HOST_CPU_SOCKETS="" + local HOST_CPU_VENDOR="" + local GUEST_TWEAKS="" + local KERNEL_NAME="Unknown" + local KERNEL_NODE="" + local KERNEL_VER="?" + local LSB_DESCRIPTION="Unknown OS" + local MACHINE_TYPE="${MACHINE_TYPE:-q35}" + local MAC_BOOTLOADER="" + local MAC_MISSING="" + local MAC_DISK_DEV="${MAC_DISK_DEV:-ide-hd,bus=ahci.2}" + local NET_DEVICE="${NET_DEVICE:-virtio-net}" + local OSK="" + local SMM="${SMM:-off}" + local USB_HOST_PASSTHROUGH_CONTROLLER="qemu-xhci" + local VGA="" + local VIDEO="" + + KERNEL_NAME=$(uname --kernel-name) + KERNEL_NODE="($(uname --nodename))" + KERNEL_VER=$(uname --kernel-release | cut -d'.' -f1-2) + + if command -v lsb_release &>/dev/null; then + LSB_DESCRIPTION=$(lsb_release --description --short) + elif [ -e /etc/os-release ]; then + LSB_DESCRIPTION=$(grep PRETTY_NAME /etc/os-release | cut -d'"' -f2) + fi + + echo "Quickemu ${VERSION} using ${QEMU} v${QEMU_VER_LONG}" + echo " - Host: ${LSB_DESCRIPTION} running ${KERNEL_NAME} ${KERNEL_VER} ${KERNEL_NODE}" + + HOST_CPU_CORES=$(nproc --all) + HOST_CPU_MODEL=$(lscpu | grep '^Model name:' | cut -d':' -f2 | sed 's/ //g') + HOST_CPU_SOCKETS=$(lscpu | grep -E 'Socket' | cut -d':' -f2 | sed 's/ //g') + HOST_CPU_VENDOR=$(lscpu | grep -E 'Vendor' | cut -d':' -f2 | sed 's/ //g') + + # A CPU with Intel VT-x / AMD SVM support is required + if [ "${HOST_CPU_VENDOR}" == "GenuineIntel" ]; then + if ! check_cpu_flag vmx; then + echo "ERROR! Intel VT-x support is required." + exit 1 + fi + elif [ "${HOST_CPU_VENDOR}" == "AuthenticAMD" ]; then + if ! check_cpu_flag svm; then + echo "ERROR! AMD SVM support is required." + exit 1 + fi + fi + + if [ -z "${cpu_cores}" ]; then + if [ "${HOST_CPU_CORES}" -ge 32 ]; then + GUEST_CPU_CORES="16" + elif [ "${HOST_CPU_CORES}" -ge 16 ]; then + GUEST_CPU_CORES="8" + elif [ "${HOST_CPU_CORES}" -ge 8 ]; then + GUEST_CPU_CORES="4" + elif [ "${HOST_CPU_CORES}" -ge 4 ]; then + GUEST_CPU_CORES="2" + else + GUEST_CPU_CORES="1" + fi + else + GUEST_CPU_CORES="${cpu_cores}" + fi + + # Account for Hyperthreading/SMT. + if [ -e /sys/devices/system/cpu/smt/control ] && [ "${GUEST_CPU_CORES}" -ge 2 ]; then + HOST_CPU_SMT=$(cat /sys/devices/system/cpu/smt/control) + case ${HOST_CPU_SMT} in + on) + GUEST_CPU_THREADS=2 + GUEST_CPU_LOGICAL_CORES=$(( GUEST_CPU_CORES / GUEST_CPU_THREADS )) + ;; + *) + GUEST_CPU_THREADS=1 + GUEST_CPU_LOGICAL_CORES=${GUEST_CPU_CORES} + ;; + esac + else + GUEST_CPU_THREADS=1 + GUEST_CPU_LOGICAL_CORES=${GUEST_CPU_CORES} + fi + + local SMP="-smp cores=${GUEST_CPU_LOGICAL_CORES},threads=${GUEST_CPU_THREADS},sockets=${HOST_CPU_SOCKETS}" + echo " - CPU: ${HOST_CPU_MODEL}" + echo -n " - CPU VM: ${HOST_CPU_SOCKETS} Socket(s), ${GUEST_CPU_LOGICAL_CORES} Core(s), ${GUEST_CPU_THREADS} Thread(s)" + + local RAM_VM="2G" + if [ -z "${ram}" ]; then + local RAM_HOST="" + RAM_HOST=$(free --mega -h | grep Mem | cut -d':' -f2 | cut -d'G' -f1 | sed 's/ //g') + #Round up - https://github.com/wimpysworld/quickemu/issues/11 + RAM_HOST=$(printf '%.*f\n' 0 "${RAM_HOST}") + if [ "${RAM_HOST}" -ge 128 ]; then + RAM_VM="32G" + elif [ "${RAM_HOST}" -ge 64 ]; then + RAM_VM="16G" + elif [ "${RAM_HOST}" -ge 16 ]; then + RAM_VM="8G" + elif [ "${RAM_HOST}" -ge 8 ]; then + RAM_VM="4G" + fi + else + RAM_VM="${ram}" + fi + echo ", ${RAM_VM} RAM" + + if [ "${guest_os}" == "macos" ] || [ "${guest_os}" == "windows" ]; then + if [ "${RAM_VM//G/}" -lt 4 ]; then + echo "ERROR! You have insufficient RAM to run ${guest_os} in a VM" + exit 1 + fi + fi + + # Force to lowercase. + boot=${boot,,} + guest_os=${guest_os,,} + + if [ "${guest_os}" == "macos" ] || [ "${guest_os}" == "windows" ]; then + # Display MSRs alert if the guest is macOS or windows + ignore_msrs_alert + fi + + # Always Boot macOS using EFI + if [ "${guest_os}" == "macos" ]; then + boot="efi" + if [ -e "${VMDIR}/OVMF_CODE.fd" ] && [ -e "${VMDIR}/OVMF_VARS-1024x768.fd" ]; then + EFI_CODE="${VMDIR}/OVMF_CODE.fd" + EFI_VARS="${VMDIR}/OVMF_VARS-1024x768.fd" + else + MAC_MISSING="Firmware" + fi + + if [ -e "${VMDIR}/OpenCore.qcow2" ]; then + MAC_BOOTLOADER="${VMDIR}/OpenCore.qcow2" + elif [ -e "${VMDIR}/ESP.qcow2" ]; then + # Backwards compatibility for Clover + MAC_BOOTLOADER="${VMDIR}/ESP.qcow2" + else + MAC_MISSING="Bootloader" + fi + + if [ -n "${MAC_MISSING}" ]; then + echo "ERROR! macOS ${MAC_MISSING} was not found." + echo " Use 'quickget' to download the required files." + exit 1 + fi + BOOT_STATUS="EFI (macOS), OVMF ($(basename "${EFI_CODE}")), SecureBoot (${secureboot})." + elif [[ "${boot}" == *"efi"* ]]; then + EFI_VARS="${VMDIR}/OVMF_VARS.fd" + + # Preserve backward compatibility + if [ -e "${VMDIR}/${VMNAME}-vars.fd" ]; then + mv "${VMDIR}/${VMNAME}-vars.fd" "${EFI_VARS}" + elif [ -e "${VMDIR}/OVMF_VARS_4M.fd" ]; then + mv "${VMDIR}/OVMF_VARS_4M.fd" "${EFI_VARS}" + fi + + # OVMF_CODE_4M.fd is for booting guests in non-Secure Boot mode. + # While this image technically supports Secure Boot, it does so + # without requiring SMM support from QEMU + + # OVMF_CODE.secboot.fd is like OVMF_CODE_4M.fd, but will abort if QEMU + # does not support SMM. + + # https://bugzilla.redhat.com/show_bug.cgi?id=1929357#c5 + if [ -n "${EFI_CODE}" ] || [ ! -e "${EFI_CODE}" ]; then + case ${secureboot} in + on) + ovmfs=("/usr/share/OVMF/OVMF_CODE_4M.secboot.fd","/usr/share/OVMF/OVMF_VARS_4M.fd" \ + "/usr/share/edk2/ovmf/OVMF_CODE.secboot.fd","/usr/share/edk2/ovmf/OVMF_VARS.fd" \ + "/usr/share/OVMF/x64/OVMF_CODE.secboot.fd","/usr/share/OVMF/x64/OVMF_VARS.fd" \ + "/usr/share/edk2-ovmf/OVMF_CODE.secboot.fd","/usr/share/edk2-ovmf/OVMF_VARS.fd" \ + "/usr/share/qemu/ovmf-x86_64-smm-ms-code.bin","/usr/share/qemu/ovmf-x86_64-smm-ms-vars.bin" \ + "/usr/share/qemu/edk2-x86_64-secure-code.fd","/usr/share/qemu/edk2-x86_64-code.fd" \ + "/usr/share/edk2-ovmf/x64/OVMF_CODE.secboot.fd","/usr/share/edk2-ovmf/x64/OVMF_VARS.fd" + ) + ;; + *) + ovmfs=("/usr/share/OVMF/OVMF_CODE_4M.fd","/usr/share/OVMF/OVMF_VARS_4M.fd" \ + "/usr/share/edk2/ovmf/OVMF_CODE.fd","/usr/share/edk2/ovmf/OVMF_VARS.fd" \ + "/usr/share/OVMF/OVMF_CODE.fd","/usr/share/OVMF/OVMF_VARS.fd" \ + "/usr/share/OVMF/x64/OVMF_CODE.fd","/usr/share/OVMF/x64/OVMF_VARS.fd" \ + "/usr/share/edk2-ovmf/OVMF_CODE.fd","/usr/share/edk2-ovmf/OVMF_VARS.fd" \ + "/usr/share/qemu/ovmf-x86_64-4m-code.bin","/usr/share/qemu/ovmf-x86_64-4m-vars.bin" \ + "/usr/share/qemu/edk2-x86_64-code.fd","/usr/share/qemu/edk2-x86_64-code.fd" \ + "/usr/share/edk2-ovmf/x64/OVMF_CODE.fd","/usr/share/edk2-ovmf/x64/OVMF_VARS.fd" + ) + ;; + esac + # Attempt each EFI_CODE file one by one, selecting the corresponding code and vars + # when an existing file is found. + _IFS=$IFS + IFS="," + for f in "${ovmfs[@]}"; do + set -- $f; + if [ -e "${1}" ]; then + EFI_CODE="${1}" + EFI_EXTRA_VARS="${2}" + fi + done + IFS=$_IFS + fi + if [ -z "${EFI_CODE}" ] || [ ! -e "${EFI_CODE}" ]; then + if [ "$secureboot" == "on" ]; then + echo "ERROR! SecureBoot was requested but no SecureBoot capable firmware was found." + else + echo "ERROR! EFI boot requested but no EFI firmware found." + fi + echo " Please install OVMF firmware." + exit 1 + fi + if [ ! -z "${EFI_EXTRA_VARS}" ]; then + if [ ! -e "${EFI_EXTRA_VARS}" ]; then + echo " - EFI: ERROR! EFI_EXTRA_VARS file ${EFI_EXTRA_VARS} does not exist." + exit 1 + fi + efi_vars "${EFI_EXTRA_VARS}" "${EFI_VARS}" + fi + + # Make sure EFI_VARS references an actual, writeable, file + if [ ! -f "${EFI_VARS}" ] || [ ! -w "${EFI_VARS}" ]; then + echo " - EFI: ERROR! ${EFI_VARS} is not a regular file or not writeable." + echo " Deleting ${EFI_VARS}. Please re-run quickemu." + rm -f "${EFI_VARS}" + exit 1 + fi + + # If EFI_CODE references a symlink, resolve it to the real file. + if [ -L "${EFI_CODE}" ]; then + echo " - EFI: WARNING! ${EFI_CODE} is a symlink." + echo -n " Resolving to... " + EFI_CODE=$(realpath "${EFI_CODE}") + echo "${EFI_CODE}" + fi + BOOT_STATUS="EFI (${guest_os^}), OVMF (${EFI_CODE}), SecureBoot (${secureboot})." + else + BOOT_STATUS="Legacy BIOS (${guest_os^})" + boot="legacy" + secureboot="off" + fi + + echo " - BOOT: ${BOOT_STATUS}" + + # Make any OS specific adjustments + case ${guest_os} in + batocera|*bsd|freedos|haiku|linux) + CPU="-cpu host,kvm=on" + if [ "${HOST_CPU_VENDOR}" == "AuthenticAMD" ]; then + CPU="${CPU},topoext" + fi + + if [ "${guest_os}" == "freebsd" ] || [ "${guest_os}" == "ghostbsd" ]; then + MOUSE="usb" + elif [ "${guest_os}" == "batocera" ] || [ "${guest_os}" == "freedos" ] || [ "${guest_os}" == "haiku" ]; then + MACHINE_TYPE="pc" + NET_DEVICE="rtl8139" + fi + + if [ "${guest_os}" == "freedos" ] ; then + # fix for #382 + SMM="on" + fi + + if [ -z "${disk_size}" ]; then + disk_size="16G" + fi + ;; + kolibrios|reactos) + CPU="-cpu qemu32,kvm=on" + if [ "${HOST_CPU_VENDOR}" == "AuthenticAMD" ]; then + CPU="${CPU},topoext" + fi + MACHINE_TYPE="pc" + case ${guest_os} in + kolibrios) NET_DEVICE="rtl8139";; + reactos) + NET_DEVICE="e1000" + KEYBOARD="ps2" + ;; + esac + ;; + macos) + #https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/ + # A CPU with SSE4.1 support is required for >= macOS Sierra + # A CPU with AVX2 support is required for >= macOS Ventura + case ${macos_release} in + ventura) + if check_cpu_flag sse4_1 && check_cpu_flag avx2; then + CPU="-cpu Haswell,kvm=on,vendor=GenuineIntel,+hypervisor,+invtsc,+kvm_pv_eoi,+kvm_pv_unhalt" + else + echo "ERROR! macOS ${macos_release} requires a CPU with SSE 4.1 and AVX2 support." + exit 1 + fi + ;; + *) + if check_cpu_flag sse4_1; then + # Used in past versions: +movbe,+smep,+xgetbv1,+xsavec,+avx2 + # Warn on AMD: +fma4,+pcid + CPU="-cpu Penryn,kvm=on,vendor=GenuineIntel,+aes,+avx,+bmi1,+bmi2,+fma,+hypervisor,+invtsc,+kvm_pv_eoi,+kvm_pv_unhalt,+popcnt,+ssse3,+sse4.2,vmware-cpuid-freq=on,+xsave,+xsaveopt,check" + else + echo "ERROR! macOS ${macos_release} requires a CPU with SSE 4.1 support." + exit 1 + fi + ;; + esac + + OSK=$(echo "bheuneqjbexolgurfrjbeqfthneqrqcyrnfrqbagfgrny(p)NccyrPbzchgreVap" | tr 'A-Za-z' 'N-ZA-Mn-za-m') + # Disable S3 support in the VM to prevent macOS suspending during install + GUEST_TWEAKS="-no-hpet -global kvm-pit.lost_tick_policy=discard -global ICH9-LPC.disable_s3=1 -device isa-applesmc,osk=${OSK}" + + # Tune Qemu optimisations based on the macOS release, or fallback to lowest + # common supported options if none is specified. + # * VirtIO Block Media doesn't work in High Sierra (at all) or the Mojave (Recovery Image) + # * VirtIO Network is supported since Big Sur + # * VirtIO Memory Balloning is supported since Big Sur (https://pmhahn.github.io/virtio-balloon/) + # * VirtIO RNG is supported since Big Sur, but exposed to all guests by default. + case ${macos_release} in + catalina) + BALLOON="" + MAC_DISK_DEV="virtio-blk-pci" + NET_DEVICE="vmxnet3" + USB_HOST_PASSTHROUGH_CONTROLLER="usb-ehci" + ;; + big-sur|monterey|ventura) + BALLOON="-device virtio-balloon" + MAC_DISK_DEV="virtio-blk-pci" + NET_DEVICE="virtio-net" + USB_HOST_PASSTHROUGH_CONTROLLER="nec-usb-xhci" + GUEST_TWEAKS="${GUEST_TWEAKS} -global nec-usb-xhci.msi=off" + ;; + *) + # Backwards compatibility if no macos_release is specified. + # Also safe catch all for High Sierra and Mojave + BALLOON="" + MAC_DISK_DEV="ide-hd,bus=ahci.2" + NET_DEVICE="vmxnet3" + USB_HOST_PASSTHROUGH_CONTROLLER="usb-ehci" + ;; + esac + + if [ -z "${disk_size}" ]; then + disk_size="96G" + fi + ;; + windows) + if [ "${QEMU_VER_SHORT}" -gt 60 ]; then + CPU="-cpu host,kvm=on,+hypervisor,+invtsc,l3-cache=on,migratable=no,hv_passthrough" + else + CPU="-cpu host,kvm=on,+hypervisor,+invtsc,l3-cache=on,migratable=no,hv_frequencies,kvm_pv_unhalt,hv_reenlightenment,hv_relaxed,hv_spinlocks=8191,hv_stimer,hv_synic,hv_time,hv_vapic,hv_vendor_id=1234567890ab,hv_vpindex" + fi + if [ "${HOST_CPU_VENDOR}" == "AuthenticAMD" ]; then + CPU="${CPU},topoext" + fi + # Disable S3 support in the VM to ensure Windows can boot with SecureBoot enabled + # - https://wiki.archlinux.org/title/QEMU#VM_does_not_boot_when_using_a_Secure_Boot_enabled_OVMF + GUEST_TWEAKS="-no-hpet -global kvm-pit.lost_tick_policy=discard -global ICH9-LPC.disable_s3=1" + + if [ -z "${disk_size}" ]; then + disk_size="64G" + fi + SMM="on" + ;; + *) + CPU="-cpu host,kvm=on" + NET_DEVICE="rtl8139" + if [ -z "${disk_size}" ]; then + disk_size="32G" + fi + echo "WARNING! Unrecognised guest OS: ${guest_os}" + ;; + esac + + echo " - Disk: ${disk_img} (${disk_size})" + if [ ! -f "${disk_img}" ]; then + # If there is no disk image, create a new image. + mkdir -p "${VMDIR}" 2>/dev/null + case ${preallocation} in + off|metadata|falloc|full) true;; + *) + echo "ERROR! ${preallocation} is an unsupported disk preallocation option." + exit 1;; + esac + + # https://blog.programster.org/qcow2-performance + if ! ${QEMU_IMG} create -q -f qcow2 -o lazy_refcounts=on,preallocation="${preallocation}" "${disk_img}" "${disk_size}"; then + echo "ERROR! Failed to create ${disk_img}" + exit 1 + fi + + if [ -z "${iso}" ] && [ -z "${img}" ]; then + echo "ERROR! You haven't specified a .iso or .img image to boot from." + exit 1 + fi + echo " Just created, booting from ${iso}${img}" + DISK_USED="no" + elif [ -e "${disk_img}" ]; then + # Check there isn't already a process attached to the disk image. + if ! ${QEMU_IMG} info "${disk_img}" >/dev/null; then + echo " Failed to get \"write\" lock. Is another process using the disk?" + exit 1 + else + # Only check disk image size if preallocation is off + if [ "${preallocation}" == "off" ]; then + DISK_CURR_SIZE=$(stat -c%s "${disk_img}") + if [ "${DISK_CURR_SIZE}" -le "${DISK_MIN_SIZE}" ]; then + echo " Looks unused, booting from ${iso}${img}" + if [ -z "${iso}" ] && [ -z "${img}" ]; then + echo "ERROR! You haven't specified a .iso or .img image to boot from." + exit 1 + fi + else + DISK_USED="yes" + fi + else + DISK_USED="yes" + fi + fi + fi + + if [ "${DISK_USED}" == "yes" ] && [ "${guest_os}" != "kolibrios" ]; then + # If there is a disk image that appears to be used do not boot from installation media. + iso="" + img="" + fi + + # Has the status quo been requested? + if [ "${STATUS_QUO}" == "-snapshot" ]; then + if [ -z "${img}" ] && [ -z "${iso}" ]; then + echo " Existing disk state will be preserved, no writes will be committed." + fi + fi + + if [ -n "${iso}" ] && [ -e "${iso}" ]; then + echo " - Boot ISO: ${iso}" + elif [ -n "${img}" ] && [ -e "${img}" ]; then + echo " - Recovery: ${img}" + fi + + if [ -n "${fixed_iso}" ] && [ -e "${fixed_iso}" ]; then + echo " - CD-ROM: ${fixed_iso}" + fi + + # Setup the appropriate audio device based on the display output + # https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/ + case ${OUTPUT} in + none|spice|spice-app) AUDIO_DEV="spice,id=audio0";; + *) AUDIO_DEV="pa,id=audio0";; + esac + + # Determine a sane resolution for Linux guests. + if [ "${guest_os}" == "linux" ]; then + local X_RES=1152 + local Y_RES=648 + if [ "${XDG_SESSION_TYPE}" == "x11" ]; then + local LOWEST_WIDTH="" + if [ -z "${SCREEN}" ]; then + LOWEST_WIDTH=$(xrandr --listmonitors | grep -v Monitors | cut -d' ' -f4 | cut -d'/' -f1 | sort | head -n1) + else + LOWEST_WIDTH=$(xrandr --listmonitors | grep -v Monitors | grep "^ ${SCREEN}:" | cut -d' ' -f4 | cut -d'/' -f1 | head -n1) + fi + if [ "${FULLSCREEN}" ]; then + if [ -z "${SCREEN}" ]; then + X_RES=$(xrandr --listmonitors | grep -v Monitors | cut -d' ' -f4 | cut -d'/' -f1 | sort | head -n1) + Y_RES=$(xrandr --listmonitors | grep -v Monitors | cut -d' ' -f4 | cut -d'/' -f2 | cut -d'x' -f2 | sort | head -n1) + else + X_RES=$(xrandr --listmonitors | grep -v Monitors | grep "^ ${SCREEN}:" | cut -d' ' -f4 | cut -d'/' -f1 | head -n1) + Y_RES=$(xrandr --listmonitors | grep -v Monitors | grep "^ ${SCREEN}:" | cut -d' ' -f4 | cut -d'/' -f2 | cut -d'x' -f2 | head -n1) + fi + elif [ "${LOWEST_WIDTH}" -ge 3840 ]; then + X_RES=3200 + Y_RES=1800 + elif [ "${LOWEST_WIDTH}" -ge 2560 ]; then + X_RES=2048 + Y_RES=1152 + elif [ "${LOWEST_WIDTH}" -ge 1920 ]; then + X_RES=1664 + Y_RES=936 + elif [ "${LOWEST_WIDTH}" -ge 1280 ]; then + X_RES=1152 + Y_RES=648 + fi + fi + fi + + # https://www.kraxel.org/blog/2019/09/display-devices-in-qemu/ + if [ "${guest_os}" == "linux" ]; then + case ${OUTPUT} in + none|spice|spice-app) + DISPLAY_DEVICE="virtio-gpu";; + *) + DISPLAY_DEVICE="virtio-vga";; + esac + elif [ "${guest_os}" == "macos" ]; then + # qxl-vga supports seamless mouse and sane resolutions if only one scanout + # is used. Which is whay '-vga none' is added to the QEMU command line. + DISPLAY_DEVICE="qxl-vga" + elif [ "${guest_os}" == "windows" ]; then + case ${OUTPUT} in + # virtio-gpu "works" with gtk but is limited to 1024x1024 and exhibits other issues. + # https://kevinlocke.name/bits/2021/12/10/windows-11-guest-virtio-libvirt/#video + gtk|none|spice) DISPLAY_DEVICE="qxl-vga";; + sdl|spice-app) DISPLAY_DEVICE="virtio-vga";; + esac + else + DISPLAY_DEVICE="qxl-vga" + fi + + # Map Quickemu OUTPUT to QEMU -display + case ${OUTPUT} in + gtk) DISPLAY_RENDER="${OUTPUT},grab-on-hover=on,zoom-to-fit=off,gl=${gl}";; + none|spice) DISPLAY_RENDER="none";; + sdl) DISPLAY_RENDER="${OUTPUT},gl=${gl}";; + spice-app) DISPLAY_RENDER="${OUTPUT},gl=${gl}";; + *) DISPLAY_RENDER="${OUTPUT}";; + esac + + # https://www.kraxel.org/blog/2021/05/virtio-gpu-qemu-graphics-update/ + if [ "${gl}" == "on" ] && [ "${DISPLAY_DEVICE}" == "virtio-vga" ]; then + if [ "${QEMU_VER_SHORT}" -ge 61 ]; then + DISPLAY_DEVICE="${DISPLAY_DEVICE}-gl" + else + DISPLAY_DEVICE="${DISPLAY_DEVICE},virgl=on" + fi + echo " - Display: ${OUTPUT^^}, ${DISPLAY_DEVICE}, GL (${gl}), VirGL (on)" + else + echo " - Display: ${OUTPUT^^}, ${DISPLAY_DEVICE}, GL (${gl}), VirGL (off)" + fi + + # Build the video configuration + VIDEO="-device ${DISPLAY_DEVICE}" + + # Try and coerce the display resolution for Linux guests only. + if [ "${guest_os}" == "linux" ]; then + VIDEO="${VIDEO},xres=${X_RES},yres=${Y_RES}" + fi + + # Allocate VRAM to VGA devices + case ${DISPLAY_DEVICE} in + bochs-display) VIDEO="${VIDEO},vgamem=67108864";; + qxl|qxl-vga) VIDEO="${VIDEO},ram_size=65536,vram_size=65536,vgamem_mb=64";; + ati-vga|cirrus-vga|VGA) VIDEO="${VIDEO},vgamem_mb=64";; + esac + + # Configure multiscreen if max_outputs was provided in the .conf file + if [ -v max_outputs ]; then + VIDEO="${VIDEO},max_outputs=${max_outputs}" + fi + + # Run QEMU with '-vga none' to avoid having two scanouts, one for VGA and + # another for virtio-vga-gl. This works around a GTK assertion failure and + # allows seamless mouse in macOS when using the qxl-vga device. + # https://www.collabora.com/news-and-blog/blog/2021/11/26/venus-on-qemu-enabling-new-virtual-vulkan-driver/ + # https://github.com/quickemu-project/quickemu/issues/222 + VGA="-vga none" + + # Add fullscreen options + VIDEO="${VGA} ${VIDEO} ${FULLSCREEN}" + + # Set the hostname of the VM + local NET="user,hostname=${VMNAME}" + + echo -n "" > "${VMDIR}/${VMNAME}.ports" + + if [ -z "${SSH_PORT}" ]; then + # Find a free port to expose ssh to the guest + SSH_PORT=$(get_port 22220 9) + fi + + if [ -n "${SSH_PORT}" ]; then + echo "ssh,${SSH_PORT}" >> "${VMDIR}/${VMNAME}.ports" + NET="${NET},hostfwd=tcp::${SSH_PORT}-:22" + echo " - ssh: On host: ssh user@localhost -p ${SSH_PORT}" + else + echo " - ssh: All ssh ports have been exhausted." + fi + + # Have any port forwards been requested? + if (( ${#port_forwards[@]} )); then + echo " - PORTS: Port forwards requested:" + for FORWARD in "${port_forwards[@]}"; do + HOST_PORT=$(echo "${FORWARD}" | cut -d':' -f1) + GUEST_PORT=$(echo "${FORWARD}" | cut -d':' -f2) + echo " - ${HOST_PORT} => ${GUEST_PORT}" + NET="${NET},hostfwd=tcp::${HOST_PORT}-:${GUEST_PORT}" + NET="${NET},hostfwd=udp::${HOST_PORT}-:${GUEST_PORT}" + done + fi + + if [ "${OUTPUT}" == "none" ] || [ "${OUTPUT}" == "spice" ] || [ "${OUTPUT}" == "spice-app" ]; then + local SPICE="disable-ticketing=on" + # gl=on can be use with 'spice' too, but only over local connections (not tcp ports) + if [ "${OUTPUT}" == "spice-app" ]; then + SPICE+=",gl=${gl}" + fi + + # TODO: Don't use ports so local-only connections can be used with gl=on + if [ -z "${SPICE_PORT}" ]; then + # Find a free port for spice + SPICE_PORT=$(get_port 5930 9) + fi + + if [ -z "${SPICE_PORT}" ]; then + echo " - SPICE: All SPICE ports have been exhausted." + if [ "${OUTPUT}" == "none" ] || [ "${OUTPUT}" == "spice" ] || [ "${OUTPUT}" == "spice-app" ]; then + echo " ERROR! Requested SPICE display, but no SPICE ports are free." + exit 1 + fi + else + if [ "${OUTPUT}" == "spice-app" ]; then + echo " - SPICE: Enabled" + else + echo "spice,${SPICE_PORT}" >> "${VMDIR}/${VMNAME}.ports" + echo -n " - SPICE: On host: spicy --title \"${VMNAME}\" --port ${SPICE_PORT}" + if [ "${guest_os}" != "macos" ] && [ -n "${PUBLIC}" ]; then + echo -n " --spice-shared-dir ${PUBLIC}" + fi + echo "${FULLSPICY}" + SPICE="${SPICE},port=${SPICE_PORT},addr=127.0.0.1" + fi + fi + fi + + if [ -n "${PUBLIC}" ]; then + case ${guest_os} in + macos) + if [ "${OUTPUT}" == "none" ] || [ "${OUTPUT}" == "spice" ] || [ "${OUTPUT}" == "spice-app" ]; then + # Reference: https://gitlab.gnome.org/GNOME/phodav/-/issues/5 + echo " - WebDAV: On guest: build spice-webdavd (https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24)" + echo " - WebDAV: On guest: Finder -> Connect to Server -> http://localhost:9843/" + fi + ;; + *) + echo " - WebDAV: On guest: dav://localhost:9843/";; + esac + fi + + if [ "${guest_os}" != "windows" ] && [ -n "${PUBLIC}" ]; then + echo -n " - 9P: On guest: " + if [ "${guest_os}" == "linux" ]; then + echo "sudo mount -t 9p -o trans=virtio,version=9p2000.L,msize=104857600 ${PUBLIC_TAG} ~/$(basename "${PUBLIC}")" + elif [ "${guest_os}" == "macos" ]; then + # PUBLICSHARE needs to be world writeable for seamless integration with + # macOS. Test if it is world writeable, and prompt what to do if not. + echo "sudo mount_9p ${PUBLIC_TAG}" + if [ "${PUBLIC_PERMS}" != "drwxrwxrwx" ]; then + echo " - 9P: On host: chmod 777 ${PUBLIC}" + echo " Required for macOS integration 👆" + fi + fi + fi + + # If smbd is available and ~/Public is present export it to the guest via samba + if [[ -e "/usr/sbin/smbd" && -n ${PUBLIC} ]]; then + NET="${NET},smb=${PUBLIC}" + echo " - smbd: On guest: smb://10.0.2.4/qemu" + fi + + enable_usb_passthrough + + echo "#!/usr/bin/env bash" > "${VMDIR}/${VMNAME}.sh" + + # Start TPM + if [ "${tpm}" == "on" ]; then + local tpm_args=() + # shellcheck disable=SC2054 + tpm_args+=(socket + --ctrl type=unixio,path="${VMDIR}/${VMNAME}.swtpm-sock" + --terminate + --tpmstate dir="${VMDIR}" + --tpm2) + echo "${SWTPM} ${tpm_args[*]} &" >> "${VMDIR}/${VMNAME}.sh" + ${SWTPM} "${tpm_args[@]}" >> "${VMDIR}/${VMNAME}.log" & + echo " - TPM: ${VMDIR}/${VMNAME}.swtpm-sock (${!})" + sleep 0.25 + fi + + # Boot the VM + local args=() + + # shellcheck disable=SC2054,SC2206,SC2140 + args+=(-name ${VMNAME},process=${VMNAME} -pidfile "${VMDIR}/${VMNAME}.pid" + -enable-kvm -machine ${MACHINE_TYPE},smm=${SMM},vmport=off ${GUEST_TWEAKS} + ${CPU} ${SMP} + -m ${RAM_VM} ${BALLOON} + ${VIDEO} -display ${DISPLAY_RENDER} + -audiodev ${AUDIO_DEV} + -device intel-hda -device hda-duplex,audiodev=audio0 + -rtc base=localtime,clock=host,driftfix=slew) + + # Only enable SPICE is using SPICE display + if [ "${OUTPUT}" == "none" ] || [ "${OUTPUT}" == "spice" ] || [ "${OUTPUT}" == "spice-app" ]; then + args+=(-spice ${SPICE} + -device virtio-serial-pci + -chardev socket,id=agent0,path="${VMDIR}/${VMNAME}-agent.sock",server=on,wait=off + -device virtserialport,chardev=agent0,name=org.qemu.guest_agent.0 + -chardev spicevmc,id=vdagent0,name=vdagent + -device virtserialport,chardev=vdagent0,name=com.redhat.spice.0 + -chardev spiceport,id=webdav0,name=org.spice-space.webdav.0 + -device virtserialport,chardev=webdav0,name=org.spice-space.webdav.0) + fi + + args+=(-device virtio-rng-pci,rng=rng0 + -object rng-random,id=rng0,filename=/dev/urandom + -device ${USB_HOST_PASSTHROUGH_CONTROLLER},id=spicepass + -chardev spicevmc,id=usbredirchardev1,name=usbredir + -device usb-redir,chardev=usbredirchardev1,id=usbredirdev1 + -chardev spicevmc,id=usbredirchardev2,name=usbredir + -device usb-redir,chardev=usbredirchardev2,id=usbredirdev2 + -chardev spicevmc,id=usbredirchardev3,name=usbredir + -device usb-redir,chardev=usbredirchardev3,id=usbredirdev3 + -device pci-ohci,id=smartpass + -device usb-ccid + -chardev spicevmc,id=ccid,name=smartcard + -device ccid-card-passthru,chardev=ccid + ) + + # setup usb-controller + [ -z "${USB_CONTROLLER}" ] && USB_CONTROLLER="$usb_controller" + if [ "${USB_CONTROLLER}" == "ehci" ]; then + args+=(-device usb-ehci,id=input) + elif [ "${USB_CONTROLLER}" == "xhci" ]; then + args+=(-device qemu-xhci,id=input) + elif [ -z "${USB_CONTROLLER}" ] || [ "${USB_CONTROLLER}" == "none" ]; then + # add nothing + : + else + echo "WARNING! Unknown usb-controller value: '${USB_CONTROLLER}'" + fi + + # setup keyboard + # @INFO: must be set after usb-controller + [ -z "${KEYBOARD}" ] && KEYBOARD="$keyboard" + if [ "${KEYBOARD}" == "usb" ]; then + args+=(-device usb-kbd,bus=input.0) + elif [ "${KEYBOARD}" == "virtio" ]; then + args+=(-device virtio-keyboard) + elif [ "${KEYBOARD}" == "ps2" ] || [ -z "${KEYBOARD}" ]; then + # add nothing, default is ps/2 keyboard + : + else + echo "WARNING! Unknown keyboard value: '${KEYBOARD}'; Fallback to ps2" + fi + + # setup keyboard_layout + # @INFO: When using the VNC display, you must use the -k parameter to set the keyboard layout if you are not using en-us. + [ -z "${KEYBOARD_LAYOUT}" ] && KEYBOARD_LAYOUT="$keyboard_layout" + if [ -n "${KEYBOARD_LAYOUT}" ]; then + args+=(-k ${KEYBOARD_LAYOUT}) + fi + + # FIXME: Check for device availability. qemu will fail to start otherwise + if [ -n "${BRAILLE}" ]; then + # shellcheck disable=SC2054 + args+=(-chardev braille,id=brltty + -device usb-braille,id=usbbrl,chardev=brltty) + fi + + # setup mouse + # @INFO: must be set after usb-controller + [ -z "${MOUSE}" ] && MOUSE="$mouse" + if [ "${MOUSE}" == "usb" ]; then + args+=(-device usb-mouse,bus=input.0) + elif [ "${MOUSE}" == "tablet" ]; then + args+=(-device usb-tablet,bus=input.0) + elif [ "${MOUSE}" == "virtio" ]; then + args+=(-device virtio-mouse) + elif [ "${MOUSE}" == "ps2" ] || [ -z "${MOUSE}" ]; then + # add nothing, default is ps/2 mouse + : + else + echo "WARNING! Unknown mouse value: '${MOUSE}; Fallback to ps2'" + fi + + # $bridge backwards compatibility for Quickemu <= 4.0 + if [ -n "${bridge}" ]; then + network="${bridge}" + fi + + if [ "${network}" == "none" ]; then + # Disbale all networking + echo " - Network: Disabled" + args+=(-nic none) + elif [ "${network}" == "restrict" ]; then + echo " - Network: Restricted (${NET_DEVICE})" + # shellcheck disable=SC2054,SC2206 + args+=(-device ${NET_DEVICE},netdev=nic -netdev ${NET},restrict=y,id=nic) + elif [ -n "${network}" ]; then + # Enable bridge mode networking + echo " - Network: Bridged (${network})" + + # If a persistent MAC address is provided, use it. + local MAC="" + if [ -n "${macaddr}" ]; then + MAC=",mac=${macaddr}" + fi + + # shellcheck disable=SC2054,SC2206 + args+=(-nic bridge,br=${network},model=virtio-net-pci${MAC}) + else + echo " - Network: User (${NET_DEVICE})" + # shellcheck disable=SC2054,SC2206 + args+=(-device ${NET_DEVICE},netdev=nic -netdev ${NET},id=nic) + fi + + # Add the disks + # - https://turlucode.com/qemu-disk-io-performance-comparison-native-or-threads-windows-10-version/ + if [[ "${boot}" == *"efi"* ]]; then + # shellcheck disable=SC2054 + args+=(-global driver=cfi.pflash01,property=secure,value=on + -drive if=pflash,format=raw,unit=0,file="${EFI_CODE}",readonly=on + -drive if=pflash,format=raw,unit=1,file="${EFI_VARS}") + fi + + if [ -n "${iso}" ] && [ "${guest_os}" == "freedos" ]; then + # FreeDOS reboots after partitioning the disk, and QEMU tries to boot from disk after first restart + # This flag sets the boot order to cdrom,disk. It will persist until powering down the VM + args+=(-boot order=dc) + elif [ -n "${iso}" ] && [ "${guest_os}" == "kolibrios" ]; then + # Since there is bug (probably) in KolibriOS: cdrom indexes 0 or 1 make system show an extra unexisting iso, so we use index=2 + # shellcheck disable=SC2054 + args+=(-drive media=cdrom,index=2,file="${iso}") + iso="" + elif [ -n "${iso}" ] && [ "${guest_os}" == "reactos" ]; then + # https://reactos.org/wiki/QEMU + # shellcheck disable=SC2054 + args+=(-boot order=d + -drive if=ide,index=2,media=cdrom,file="${iso}") + iso="" + elif [ -n "${iso}" ] && [ "${guest_os}" == "windows" ] && [ -e "${VMDIR}/unattended.iso" ]; then + # Attach the unattended configuration to Windows guests when booting from ISO + # shellcheck disable=SC2054 + args+=(-drive media=cdrom,index=2,file="${VMDIR}/unattended.iso") + fi + + if [ -n "${floppy}" ]; then + # shellcheck disable=SC2054 + args+=(-drive if=floppy,format=raw,file="${floppy}") + fi + + if [ -n "${iso}" ]; then + # shellcheck disable=SC2054 + args+=(-drive media=cdrom,index=0,file="${iso}") + fi + + if [ -n "${fixed_iso}" ]; then + # shellcheck disable=SC2054 + args+=(-drive media=cdrom,index=1,file="${fixed_iso}") + fi + + if [ "${guest_os}" == "macos" ]; then + # shellcheck disable=SC2054 + args+=(-device ahci,id=ahci + -device ide-hd,bus=ahci.0,drive=BootLoader,bootindex=0 + -drive id=BootLoader,if=none,format=qcow2,file="${MAC_BOOTLOADER}") + + if [ -n "${img}" ]; then + # shellcheck disable=SC2054 + args+=(-device ide-hd,bus=ahci.1,drive=RecoveryImage + -drive id=RecoveryImage,if=none,format=raw,file="${img}") + fi + + # shellcheck disable=SC2054,SC2206 + args+=(-device ${MAC_DISK_DEV},drive=SystemDisk + -drive id=SystemDisk,if=none,format=qcow2,file="${disk_img}" ${STATUS_QUO}) + elif [ "${guest_os}" == "kolibrios" ]; then + # shellcheck disable=SC2054,SC2206 + args+=(-device ahci,id=ahci + -device ide-hd,bus=ahci.0,drive=SystemDisk + -drive id=SystemDisk,if=none,format=qcow2,file="${disk_img}" ${STATUS_QUO}) + + elif [ "${guest_os}" == "batocera" ] ; then + # shellcheck disable=SC2054,SC2206 + args+=(-device virtio-blk-pci,drive=BootDisk + -drive id=BootDisk,if=none,format=raw,file="${img}" + -device virtio-blk-pci,drive=SystemDisk + -drive id=SystemDisk,if=none,format=qcow2,file="${disk_img}" ${STATUS_QUO}) + + elif [ "${guest_os}" == "reactos" ]; then + # https://reactos.org/wiki/QEMU + # shellcheck disable=SC2054,SC2206 + args+=(-drive if=ide,index=0,media=disk,file="${disk_img}") + + else + # shellcheck disable=SC2054,SC2206 + args+=(-device virtio-blk-pci,drive=SystemDisk + -drive id=SystemDisk,if=none,format=qcow2,file="${disk_img}" ${STATUS_QUO}) + fi + + # https://wiki.qemu.org/Documentation/9psetup + # https://askubuntu.com/questions/772784/9p-libvirt-qemu-share-modes + if [ "${guest_os}" != "windows" ] && [ -n "${PUBLIC}" ]; then + # shellcheck disable=SC2054 + args+=(-fsdev local,id=fsdev0,path="${PUBLIC}",security_model=mapped-xattr + -device virtio-9p-pci,fsdev=fsdev0,mount_tag="${PUBLIC_TAG}") + fi + + if [ -n "${USB_PASSTHROUGH}" ]; then + # shellcheck disable=SC2054,SC2206 + args+=(-device ${USB_HOST_PASSTHROUGH_CONTROLLER},id=hostpass + ${USB_PASSTHROUGH}) + fi + + if [ "${tpm}" == "on" ] && [ -S "${VMDIR}/${VMNAME}.swtpm-sock" ]; then + # shellcheck disable=SC2054 + args+=(-chardev socket,id=chrtpm,path="${VMDIR}/${VMNAME}.swtpm-sock" + -tpmdev emulator,id=tpm0,chardev=chrtpm + -device tpm-tis,tpmdev=tpm0) + fi + + if [ -z "${MONITOR}" ]; then + MONITOR="${monitor:-none}" + fi + + if [ -z "${MONITOR_TELNET_HOST}" ]; then + MONITOR_TELNET_HOST="${monitor_telnet_host:-localhost}" + fi + if [ -z "${MONITOR_TELNET_PORT}" ]; then + MONITOR_TELNET_PORT="${monitor_telnet_port}" + fi + if [ -n "${MONITOR_TELNET_PORT}" ] && ! is_numeric "${MONITOR_TELNET_PORT}"; then + echo "ERROR: telnet-port must be a number!" + exit 1 + fi + + if [ "${MONITOR}" == "none" ]; then + args+=(-monitor none) + echo " - Monitor: (off)" + elif [ "${MONITOR}" == "telnet" ]; then + # Find a free port to expose monitor-telnet to the guest + local temp_port="$(get_port ${MONITOR_TELNET_PORT} 9)" + if [ -z "${temp_port}" ]; then + echo " - Monitor: All Monitor-Telnet ports have been exhausted." + else + MONITOR_TELNET_PORT="${temp_port}" + args+=(-monitor telnet:${MONITOR_TELNET_HOST}:${MONITOR_TELNET_PORT},server,nowait) + echo " - Monitor: On host: telnet ${MONITOR_TELNET_HOST} ${MONITOR_TELNET_PORT}" + echo "monitor-telnet,${MONITOR_TELNET_PORT},${MONITOR_TELNET_HOST}" >> "${VMDIR}/${VMNAME}.ports" + fi + elif [ "${MONITOR}" == "socket" ]; then + args+=(-monitor unix:${VM_MONITOR_SOCKETPATH},server,nowait) + echo " - Monitor: On host: nc -U \"${VM_MONITOR_SOCKETPATH}\"" + echo " or : socat -,echo=0,icanon=0 unix-connect:${VM_MONITOR_SOCKETPATH}" + else + echo "ERROR! \"${MONITOR}\" is an unknown monitor option." + exit 1 + fi + + if [ -z "${SERIAL}" ]; then + SERIAL="${serial:-none}" + fi + + if [ -z "${SERIAL_TELNET_HOST}" ]; then + SERIAL_TELNET_HOST="${serial_telnet_host:-localhost}" + fi + if [ -z "${SERIAL_TELNET_PORT}" ]; then + SERIAL_TELNET_PORT="${serial_telnet_port}" + fi + if [ -n "${SERIAL_TELNET_PORT}" ] && ! is_numeric "${SERIAL_TELNET_PORT}"; then + echo "ERROR: serial-port must be a number!" + exit 1 + fi + + if [ "${SERIAL}" == "none" ]; then + args+=(-serial none) + elif [ "${SERIAL}" == "telnet" ]; then + # Find a free port to expose serial-telnet to the guest + local temp_port="$(get_port ${SERIAL_TELNET_PORT} 9)" + if [ -z "${temp_port}" ]; then + echo " - Serial: All Serial-Telnet ports have been exhausted." + else + SERIAL_TELNET_PORT="${temp_port}" + args+=(-serial telnet:${SERIAL_TELNET_HOST}:${SERIAL_TELNET_PORT},server,nowait) + echo " - Serial: On host: telnet ${SERIAL_TELNET_HOST} ${SERIAL_TELNET_PORT}" + echo "serial-telnet,${SERIAL_TELNET_PORT},${SERIAL_TELNET_HOST}" >> "${VMDIR}/${VMNAME}.ports" + fi + elif [ "${SERIAL}" == "socket" ]; then + args+=(-serial unix:${VM_SERIAL_SOCKETPATH},server,nowait) + echo " - Serial: On host: nc -U \"${VM_SERIAL_SOCKETPATH}\"" + echo " or : socat -,echo=0,icanon=0 unix-connect:${VM_SERIAL_SOCKETPATH}" + else + echo "ERROR! \"${SERIAL}\" is an unknown serial option." + exit 1 + fi + + + if [ -z "${EXTRA_ARGS}" ]; then + EXTRA_ARGS="${extra_args}" + fi + if [ -n "${EXTRA_ARGS}" ]; then + args+=(${EXTRA_ARGS}) + fi + + # The OSK parameter contains parenthesis, they need to be escaped in the shell + # scripts. The vendor name, Quickemu Project, contains a space. It needs to be + # double-quoted. + SHELL_ARGS="${args[*]}" + SHELL_ARGS="${SHELL_ARGS//\(/\\(}" + SHELL_ARGS="${SHELL_ARGS//)/\\)}" + SHELL_ARGS="${SHELL_ARGS//Quickemu Project/\"Quickemu Project\"}" + + if [ ${VM_UP} -eq 0 ]; then + # Enable grab-on-hover for SDL: https://github.com/quickemu-project/quickemu/issues/541 + case "${OUTPUT}" in + sdl) export SDL_MOUSE_FOCUS_CLICKTHROUGH=1;; + esac + echo "${QEMU}" "${SHELL_ARGS}" >> "${VMDIR}/${VMNAME}.sh" + ${QEMU} "${args[@]}" > "${VMDIR}/${VMNAME}.log" & + sleep 0.25 + fi + + echo " - Process: Starting ${VM} as ${VMNAME} ($(cat "${VMDIR}/${VMNAME}.pid"))" +} + +function start_viewer { + errno=0 + if [ "${VIEWER}" != "none" ]; then + + # If output is 'none' then SPICE was requested. + if [ "${OUTPUT}" == "spice" ]; then + if [ "${VIEWER}" == "remote-viewer" ]; then + # show via viewer: remote-viewer + + if [ -n "${PUBLIC}" ]; then + echo " - Viewer: ${VIEWER} --title \"${VMNAME}\" --spice-shared-dir \"${PUBLIC}\" ${FULLSPICY} \"spice://localhost:${SPICE_PORT}\" >/dev/null 2>&1 &" + ${VIEWER} --title "${VMNAME}" --spice-shared-dir "${PUBLIC}" ${FULLSPICY} "spice://localhost:${SPICE_PORT}" >/dev/null 2>&1 & + errno=$? + else + echo " - Viewer: ${VIEWER} --title \"${VMNAME}\" ${FULLSPICY} \"spice://localhost:${SPICE_PORT}\" >/dev/null 2>&1 &" + ${VIEWER} --title "${VMNAME}" ${FULLSPICY} "spice://localhost:${SPICE_PORT}" >/dev/null 2>&1 & + errno=$? + fi + + elif [ "${VIEWER}" == "spicy" ]; then + # show via viewer: spicy + + if [ -n "${PUBLIC}" ]; then + echo " - Viewer: ${VIEWER} --title \"${VMNAME}\" --port \"${SPICE_PORT}\" --spice-shared-dir \"${PUBLIC}\" \"${FULLSPICY}\" >/dev/null 2>&1 &" + ${VIEWER} --title "${VMNAME}" --port "${SPICE_PORT}" --spice-shared-dir "${PUBLIC}" "${FULLSPICY}" >/dev/null 2>&1 & + errno=$? + else + echo " - Viewer: ${VIEWER} --title \"${VMNAME}\" --port \"${SPICE_PORT}\" \"${FULLSPICY}\" >/dev/null 2>&1 &" + ${VIEWER} --title "${VMNAME}" --port "${SPICE_PORT}" "${FULLSPICY}" >/dev/null 2>&1 & + errno=$? + fi + fi + if [ $errno -ne 0 ]; then + echo "WARNING! Could not start viewer(${VIEWER}) Err: $errno" + fi + fi + fi +} + +function shortcut_create { + local dirname="${HOME}/.local/share/applications" + local filename="${HOME}/.local/share/applications/${VMNAME}.desktop" + + if [ ! -d "${dirname}" ]; then + mkdir -p "${dirname}" + fi + cat << EOF > "${filename}" +[Desktop Entry] +Version=1.0 +Type=Application +Terminal=false +Exec=${0} --vm ${VM} +Path=${VMPATH} +Name=${VMNAME} +Icon=/usr/share/icons/hicolor/scalable/apps/qemu.svg +EOF + echo "Created ${VMNAME}.desktop file" +} + +function usage() { + echo + echo "Usage" + echo " ${LAUNCHER} --vm ubuntu.conf" + echo + echo "You can also pass optional parameters" + echo " --braille : Enable braille support. Requires SDL." + echo " --delete-disk : Delete the disk image and EFI variables" + echo " --delete-vm : Delete the entire VM and it's configuration" + echo " --display : Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or 'spice-app'" + echo " --fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)" + echo " --ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers" + echo " --screen : Use specified screen to determine the window size." + echo " --shortcut : Create a desktop shortcut" + echo " --snapshot apply : Apply/restore a snapshot." + echo " --snapshot create : Create a snapshot." + echo " --snapshot delete : Delete a snapshot." + echo " --snapshot info : Show disk/snapshot info." + echo " --status-quo : Do not commit any changes to disk/snapshot." + echo " --viewer : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'" + echo " --ssh-port : Set ssh-port manually" + echo " --spice-port : Set spice-port manually" + echo " --public-dir : expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '', 'none'" + echo " --monitor : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'" + echo " --monitor-telnet-host : Set telnet host for monitor. (default: 'localhost')" + echo " --monitor-telnet-port : Set telnet port for monitor. (default: '4440')" + echo " --monitor-cmd : Send command to monitor if available. (Example: system_powerdown)" + echo " --serial : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none'" + echo " --serial-telnet-host : Set telnet host for serial. (default: 'localhost')" + echo " --serial-telnet-port : Set telnet port for serial. (default: '6660')" + echo " --keyboard : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'" + echo " --keyboard_layout : Set keyboard layout." + echo " --mouse : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'" + echo " --usb-controller : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'" + echo " --extra_args : Pass additional arguments to qemu" + echo " --version : Print version" + exit 1 +} + +function display_param_check() { + if [ "${OUTPUT}" != "gtk" ] && [ "${OUTPUT}" != "none" ] && [ "${OUTPUT}" != "sdl" ] && [ "${OUTPUT}" != "spice" ] && [ "${OUTPUT}" != "spice-app" ]; then + echo "ERROR! Requested output '${OUTPUT}' is not recognised." + exit 1 + fi +} + +function viewer_param_check() { + if [ "${VIEWER}" != "none" ] && [ "${VIEWER}" != "spicy" ] && [ "${VIEWER}" != "remote-viewer" ]; then + echo "ERROR! Requested viewer '${VIEWER}' is not recognised." + exit 1 + fi + if [ "${VIEWER}" == "spicy" ] && ! command -v spicy &>/dev/null; then + echo "ERROR! Requested 'spicy' as viewer, but 'spicy' is not installed." + exit 1 + elif [ "${VIEWER}" == "remote-viewer" ] && ! command -v remote-viewer &>/dev/null; then + echo "ERROR! Requested 'remote-viewer' as viewer, but 'remote-viewer' is not installed." + exit 1 + fi +} + +function parse_ports_from_file { + local FILE="${VMDIR}/${VMNAME}.ports" + + # parse ports + local port_name=( $(cat "$FILE" | cut -d, -f1) ) + local port_number=( $(cat "$FILE" | cut -d, -f2) ) + local host_name=( $(cat "$FILE" | gawk 'FS="," {print $3,"."}') ) + + for ((i=0; i<${#port_name[@]}; i++)); do + if [ "${port_name[$i]}" == "ssh" ]; then + SSH_PORT="${port_number[$i]}" + elif [ "${port_name[$i]}" == "spice" ]; then + SPICE_PORT="${port_number[$i]}" + elif [ "${port_name[$i]}" == "monitor-telnet" ]; then + MONITOR_TELNET_PORT="${port_number[$i]}" + MONITOR_TELNET_HOST="${host_name[$i]}" + elif [ "${port_name[$i]}" == "serial-telnet" ]; then + SERIAL_TELNET_PORT="${port_number[$i]}" + SERIAL_TELNET_HOST="${host_name[$i]}" + fi + done +} + +function is_numeric { + [[ "$1" =~ ^[0-9]+$ ]] +} + +function monitor_send_cmd { + local MSG="${1}" + + if [ -z "${MSG}" ]; then + echo "WARNING! Send to QEMU-Monitor: Message empty!" + return 1 + fi + + # Determine monitor channel + local monitor_channel="" + + if [ -S "${VMDIR}/${VMNAME}-monitor.socket" ]; then + monitor_channel="socket" + elif [ -n "${MONITOR_TELNET_PORT}" ] && [ -n "${MONITOR_TELNET_HOST}" ]; then + monitor_channel="telnet" + else + echo "WARNING! No qemu-monitor channel available - Couldn't send message to monitor!" + return + fi + + case "${monitor_channel}" in + socket) + echo -e " - Sending: ${MSG}" + echo -e "${MSG}" | socat -,shut-down unix-connect:"${VM_MONITOR_SOCKETPATH}" 2>&1 > /dev/null + ;; + telnet) + echo -e " - Sending: ${MSG}" + echo -e "${MSG}" | socat - tcp:"${MONITOR_TELNET_HOST}":"${MONITOR_TELNET_PORT}" 2>&1 > /dev/null + ;; + *) + echo "ERROR! This should never happen!" + exit 1 + ;; + esac + + return 0 +} + +### MAIN + +# Lowercase variables are used in the VM config file only +boot="efi" +cpu_cores="" +disk_img="" +disk_size="" +display="" +extra_args="" +fixed_iso="" +floppy="" +guest_os="linux" +img="" +iso="" +macaddr="" +macos_release="" +network="" +port_forwards=() +preallocation="off" +ram="" +secureboot="off" +tpm="off" +usb_devices=() +viewer="spicy" +ssh_port="" +spice_port="" +public_dir="" +monitor="socket" +monitor_telnet_port="4440" +monitor_telnet_host="localhost" +monitor_cmd="" +serial="socket" +serial_telnet_port="6660" +serial_telnet_host="localhost" +# options: ehci(USB2.0), xhci(USB3.0) +usb_controller="ehci" +# options: ps2, usb, virtio +keyboard="usb" +keyboard_layout="en-us" +# options: ps2, usb, tablet, virtio +mouse="tablet" + +BRAILLE="" +DELETE_DISK=0 +DELETE_VM=0 +FULLSCREEN="" +FULLSPICY="" +OUTPUT="" +PUBLIC="" +PUBLIC_PERMS="" +PUBLIC_TAG="" +SCREEN="" +SHORTCUT=0 +SNAPSHOT_ACTION="" +SNAPSHOT_TAG="" +STATUS_QUO="" +USB_PASSTHROUGH="" +VM="" +VMDIR="" +VMNAME="" +VMPATH="" +VIEWER="" +SSH_PORT="" +SPICE_PORT="" +MONITOR="" +MONITOR_TELNET_PORT="" +MONITOR_TELNET_HOST="" +MONITOR_CMD="" +VM_MONITOR_SOCKETPATH="" +VM_SERIAL_SOCKETPATH="" +SERIAL="" +SERIAL_TELNET_PORT="" +SERIAL_TELNET_HOST="" +KEYBOARD="" +KEYBOARD_LAYOUT="" +MOUSE="" +USB_CONTROLLER="" +EXTRA_ARGS="" + +# shellcheck disable=SC2155 +readonly LAUNCHER=$(basename "${0}") +readonly DISK_MIN_SIZE=$((197632 * 8)) +readonly VERSION="4.6" + +# TODO: Make this run the native architecture binary +QEMU=$(command -v qemu-system-x86_64) +QEMU_IMG=$(command -v qemu-img) +if [ ! -e "${QEMU}" ] || [ ! -e "${QEMU_IMG}" ]; then + echo "ERROR! QEMU not found. Please make install qemu-system-x86_64 and qemu-img" + exit 1 +fi + +QEMU_VER_LONG=$(${QEMU} -version | head -n1 | cut -d' ' -f4 | cut -d'(' -f1) +QEMU_VER_SHORT=$(${QEMU} -version | head -n1 | cut -d' ' -f4 | cut -d'(' -f1 | sed 's/\.//g' | cut -c1-2) +if [ "${QEMU_VER_SHORT}" -lt 60 ]; then + echo "ERROR! Qemu 6.0.0 or newer is required, detected ${QEMU_VER_LONG}." + exit 1 +fi + +# Take command line arguments +if [ $# -lt 1 ]; then + usage + exit 0 +else + while [ $# -gt 0 ]; do + case "${1}" in + -braille|--braille) + BRAILLE="on" + shift;; + -delete|--delete|-delete-disk|--delete-disk) + DELETE_DISK=1 + shift;; + -delete-vm|--delete-vm) + DELETE_VM=1 + shift;; + -display|--display) + OUTPUT="${2}" + display_param_check + shift + shift;; + -fullscreen|--fullscreen|-full-screen|--full-screen) + FULLSCREEN="-full-screen" + FULLSPICY="--full-screen" + shift;; + -ignore-msrs-always|--ignore-msrs-always) + ignore_msrs_always + exit;; + -screen|--screen) + SCREEN="${2}" + shift + shift;; + -snapshot|--snapshot) + SNAPSHOT_ACTION="${2}" + if [ -z "${SNAPSHOT_ACTION}" ]; then + echo "ERROR! No snapshot action provided." + exit 1 + fi + shift + SNAPSHOT_TAG="${2}" + if [ -z "${SNAPSHOT_TAG}" ] && [ "${SNAPSHOT_ACTION}" != "info" ]; then + echo "ERROR! No snapshot tag provided." + exit 1 + fi + shift + shift;; + -status-quo|--status-quo) + STATUS_QUO="-snapshot" + shift;; + -shortcut|--shortcut) + SHORTCUT=1 + shift;; + -vm|--vm) + VM="${2}" + shift + shift;; + -viewer|--viewer) + VIEWER="${2}" + shift + shift;; + -ssh-port|--ssh-port) + SSH_PORT="${2}" + shift; + shift;; + -spice-port|--spice-port) + SPICE_PORT="${2}" + shift; + shift;; + -public-dir|--public-dir) + PUBLIC="${2}" + shift; + shift;; + -monitor|--monitor) + MONITOR="${2}" + shift; + shift;; + -monitor-cmd|--monitor-cmd) + MONITOR_CMD="${2}" + shift; + shift;; + -monitor-telnet-host|--monitor-telnet-host) + MONITOR_TELNET_HOST="${2}" + shift; + shift;; + -monitor-telnet-port|--monitor-telnet-port) + MONITOR_TELNET_PORT="${2}" + shift; + shift;; + -serial|--serial) + SERIAL="${2}" + shift; + shift;; + -serial-telnet-host|--serial-telnet-host) + SERIAL_TELNET_HOST="${2}" + shift; + shift;; + -serial-telnet-port|--serial-telnet-port) + SERIAL_TELNET_PORT="${2}" + shift; + shift;; + -keyboard|--keyboard) + KEYBOARD="${2}" + shift; + shift;; + -mouse|--mouse) + MOUSE="${2}" + shift; + shift;; + -usb-controller|--usb-controller) + USB_CONTROLLER="${2}" + shift; + shift;; + -extra_args|--extra_args) + EXTRA_ARGS="${2}" + shift; + shift;; + -version|--version) + echo "${VERSION}" + exit;; + -h|--h|-help|--help) + usage;; + *) + echo "ERROR! \"${1}\" is not a supported parameter." + usage;; + esac + done +fi + +if [ -n "${VM}" ] && [ -e "${VM}" ]; then + # shellcheck source=/dev/null + source "${VM}" + if [ -z "${disk_img}" ]; then + echo "ERROR! No disk_img defined." + exit 1 + fi + + VMDIR=$(dirname "${disk_img}") + VMNAME=$(basename "${VM}" .conf) + VMPATH=$(realpath "$(dirname "${VM}")") + VM_MONITOR_SOCKETPATH="${VMDIR}/${VMNAME}-monitor.socket" + VM_SERIAL_SOCKETPATH="${VMDIR}/${VMNAME}-serial.socket" + + # Backwards compatibility for ${driver_iso} + if [ -n "${driver_iso}" ] && [ -z "${fixed_iso}" ]; then + fixed_iso="${driver_iso}" + fi + + # Backwards compatibility for ${disk} (size) + if [ -n "${disk}" ]; then + disk_size="${disk}" + fi + + if [ -n "${display}" ]; then + OUTPUT="${display}" + fi + + # Set the default OUTPUT if not provided by user + if [ -z "${OUTPUT}" ]; then + OUTPUT="sdl" + fi + + # Braille support requires SDL. Override OUTPUT if braille was requested. + if [ -n "${BRAILLE}" ]; then + OUTPUT="sdl" + fi + display_param_check + + if [ -z "${VIEWER}" ]; then + VIEWER="${viewer}" + fi + viewer_param_check + + # Set the default 3D acceleration. + if [ -z "${gl}" ]; then + gl="on" + fi + + if [ -z "${PUBLIC}" ]; then + PUBLIC="${public_dir}" + fi + + if [ "${PUBLIC}" == "none" ]; then + PUBLIC="" + else + # PUBLICSHARE is the only directory exposed to guest VMs for file + # sharing via 9P, spice-webdavd and Samba. This path is not configurable. + if [ -z "${PUBLIC}" ]; then + if command -v xdg-user-dir &>/dev/null; then + PUBLIC=$(xdg-user-dir PUBLICSHARE) + fi + fi + + if [ ! -d "${PUBLIC}" ]; then + echo "ERROR! Public directory: '${PUBLIC}' doesn't exist!" + exit 1 + fi + + PUBLIC_TAG="Public-${USER,,}" + # shellcheck disable=SC2012 + PUBLIC_PERMS=$(ls -ld "${PUBLIC}" | cut -d' ' -f1) + fi + + if [ -z "${SSH_PORT}" ]; then + SSH_PORT=${ssh_port} + fi + if [ -n "${SSH_PORT}" ] && ! is_numeric "${SSH_PORT}"; then + echo "ERROR: ssh-port must be a number!" + exit 1 + fi + + if [ -z "${SPICE_PORT}" ]; then + SPICE_PORT=${spice_port} + fi + if [ -n "${SPICE_PORT}" ] && ! is_numeric "${SPICE_PORT}"; then + echo "ERROR: spice-port must be a number!" + exit 1 + fi + + # Check if vm is already run + VM_PID=0 + VM_UP=0 + if [ -r "${VMDIR}/${VMNAME}.pid" ]; then + VM_PID=$(head -c50 "${VMDIR}/${VMNAME}.pid") + kill -0 ${VM_PID} 2>&1 >/dev/null + if [ $? -eq 0 ]; then + echo "VM already started!" + VM_UP=1 + fi + fi + + if [ "${tpm}" == "on" ]; then + SWTPM=$(command -v swtpm) + if [ ! -e "${SWTPM}" ]; then + echo "ERROR! TPM is enabled, but swtpm was not found." + exit 1 + fi + fi +else + echo "ERROR! Virtual machine configuration not found." + usage +fi + +if [ ${DELETE_DISK} -eq 1 ]; then + delete_disk + exit +fi + +if [ ${DELETE_VM} -eq 1 ]; then + delete_vm + exit +fi + +if [ -n "${SNAPSHOT_ACTION}" ]; then + case ${SNAPSHOT_ACTION} in + apply) + snapshot_apply "${SNAPSHOT_TAG}" + snapshot_info + exit;; + create) + snapshot_create "${SNAPSHOT_TAG}" + snapshot_info + exit;; + delete) + snapshot_delete "${SNAPSHOT_TAG}" + snapshot_info + exit;; + info) + snapshot_info + exit;; + *) + echo "ERROR! \"${SNAPSHOT_ACTION}\" is not a supported snapshot action." + usage;; + esac +fi + +if [ ${SHORTCUT} -eq 1 ]; then + shortcut_create + exit +fi + +if [ ${VM_UP} -eq 0 ]; then + vm_boot + # If the VM being started is an uninstalled Windows VM then auto-skip the press-any key prompt. + if [ -n "${iso}" ] && [ "${guest_os}" == "windows" ]; then + sleep 3.5 + monitor_send_cmd "sendkey ret" + fi + start_viewer +else + parse_ports_from_file + start_viewer +fi + +[ -n "${MONITOR_CMD}" ] && monitor_send_cmd "${MONITOR_CMD}" + +# vim:tabstop=2:shiftwidth=2:expandtab diff --git a/quickget b/quickget new file mode 100755 index 0000000..88309fb --- /dev/null +++ b/quickget @@ -0,0 +1,1810 @@ +#!/usr/bin/env bash +export LC_ALL=C + +# Here the quick 'n dirty guide to adding a new OS to quickget +# +# 1. Update os_support() - add new OS, all lowercase +# 2. Update pretty_name() - add a pretty name for new OS *only if the catch all is not suitable* +# 3. Create a releases_newos() generator (required) outputs the current supported release versions +# 4. Create a editions_newos() generator (optional) outputs the editions if new OS has multiple flavours/editions +# 5. Update make_vm_config() - add any *required* new OS tweaks +# 6. Create a get_newos() function - that does something like this: +# function get_newos() { +# local EDITION="${1:-}" +# local HASH="" +# local ISO="newos-${RELEASE}-${EDITION}-amd64.iso" +# local URL="https://www.newos.org/download/${RELEASE}/${EDITION}" +# +# HASH=$(wget -q -O- "${URL}/SHA512SUMS" | grep "${ISO}" | cut -d' ' -f1) +# echo "${URL}/${ISO} ${HASH}" +# } + +function cleanup() { + if [ -n "$(jobs -p)" ]; then + kill "$(jobs -p)" + fi +} + +function pretty_name() { + local SIMPLE_NAME="" + local PRETTY_NAME="" + SIMPLE_NAME="${1}" + case ${SIMPLE_NAME} in + agarimos) PRETTY_NAME="AgarimOS";; + alma) PRETTY_NAME="Alma Linux";; + alpine) PRETTY_NAME="Alpine Linux";; + android) PRETTY_NAME="Android x86";; + archlinux) PRETTY_NAME="Arch Linux";; + archcraft) PRETTY_NAME="Archcraft";; + arcolinux) PRETTY_NAME="Arco Linux";; + cachyos) PRETTY_NAME="CachyOS";; + centos-stream) PRETTY_NAME="CentOS Stream";; + cereus) PRETTY_NAME="Cereus Linux";; + dietpi) PRETTY_NAME="DietPi";; + dragonflybsd) PRETTY_NAME="DragonFlyBSD";; + elementary) PRETTY_NAME="elementary OS";; + endeavouros) PRETTY_NAME="EndeavourOS";; + freebsd) PRETTY_NAME="FreeBSD";; + freedos) PRETTY_NAME="FreeDOS";; + fvoid) PRETTY_NAME="F-Void";; + gabeeos) PRETTY_NAME="gabeeOS Linux";; + garuda) PRETTY_NAME="Garuda Linux";; + ghostbsd) PRETTY_NAME="GhostBSD";; + kdeneon) PRETTY_NAME="KDE Neon";; + kolibrios) PRETTY_NAME="KolibriOS";; + linuxmint) PRETTY_NAME="Linux Mint";; + lmde) PRETTY_NAME="Linux Mint Debian Edition";; + mageia) PRETTY_NAME="Mageia";; + mxlinux) PRETTY_NAME="MX Linux";; + netboot) PRETTY_NAME="netboot.xyz";; + netbsd) PRETTY_NAME="NetBSD";; + nixos) PRETTY_NAME="NixOS";; + openbsd) PRETTY_NAME="OpenBSD";; + opensuse) PRETTY_NAME="openSUSE";; + oraclelinux) PRETTY_NAME="Oracle Linux";; + popos) PRETTY_NAME="Pop!_OS";; + reactos) PRETTY_NAME="ReactOS";; + rebornos) PRETTY_NAME="RebornOS";; + rockylinux) PRETTY_NAME="Rocky Linux";; + slitaz) PRETTY_NAME="SliTaz GNU/Linux";; + steamos) PRETTY_NAME="SteamOS HoloISO";; + truenas-core) PRETTY_NAME="TrueNAS Core";; + truenas-scale) PRETTY_NAME="TrueNAS Scale";; + ubuntu-budgie) PRETTY_NAME="Ubuntu Budgie";; + ubuntukylin) PRETTY_NAME="Ubuntu Kylin";; + ubuntu-mate) PRETTY_NAME="Ubuntu MATE";; + ubuntustudio) PRETTY_NAME="Ubuntu Studio";; + ubuntu-unity) PRETTY_NAME="Ubuntu Unity";; + void) PRETTY_NAME="Void Linux";; + voidpup) PRETTY_NAME="Void Puppy";; + vxlinux) PRETTY_NAME="VX Linux";; + xerolinux) PRETTY_NAME="XeroLinux";; + zorin) PRETTY_NAME="Zorin OS";; + *) PRETTY_NAME="${SIMPLE_NAME^}";; + esac + echo "${PRETTY_NAME}" +} + +function validate_release() { + local DISPLAY_NAME="" + local RELEASE_GENERATOR="" + local RELEASES="" + DISPLAY_NAME="$(pretty_name "${OS}")" + case ${OS} in + *ubuntu*) RELEASE_GENERATOR="releases_ubuntu";; + *) RELEASE_GENERATOR="${1}";; + esac + RELEASES=$(${RELEASE_GENERATOR}) + if [[ "${RELEASES}" != *"${RELEASE}"* ]]; then + echo -e "ERROR! ${DISPLAY_NAME} ${RELEASE} is not a supported release.\n" + echo -n "${RELEASES}" + exit 1 + fi +} + +function list_json() { + # Reference: https://stackoverflow.com/a/67359273 + list_csv | jq -R 'split(",") as $h|reduce inputs as $in ([]; . += [$in|split(",")|. as $a|reduce range(0,length) as $i ({};.[$h[$i]]=$a[$i])])' + exit 0 +} + +function list_csv() { + local DISPLAY_NAME + local DL="" + local DOWNLOADER + local FUNC + local OPTION + local OS + local PNG + local RELEASE + local SVG + local HAS_ZSYNC=0 + # Check if zsync is available + if command -v zsync &>/dev/null; then + HAS_ZSYNC=1 + fi + if command -v aria2c &>/dev/null; then + DL="aria2c" + elif command -v wget &>/dev/null; then + DL="wget" + fi + echo "Display Name,OS,Release,Option,Downloader,PNG,SVG" + for OS in $(os_support); do + DISPLAY_NAME="$(pretty_name "${OS}")" + if [[ "${OS}" == *"ubuntu"* ]]; then + FUNC="ubuntu" + else + FUNC="${OS}" + fi + PNG="https://quickemu-project.github.io/quickemu-icons/png/${FUNC}/${FUNC}-quickemu-white-pinkbg.png" + SVG="https://quickemu-project.github.io/quickemu-icons/svg/${FUNC}/${FUNC}-quickemu-white-pinkbg.svg" + for RELEASE in $("releases_${FUNC}"); do + if [ "${OS}" == "ubuntu" ] && [ "${RELEASE}" == "canary" ] && [ ${HAS_ZSYNC} -eq 1 ]; then + DOWNLOADER="zsync" + elif [[ "${OS}" == *"ubuntu"* ]] && [ "${RELEASE}" == "devel" ] && [ ${HAS_ZSYNC} -eq 1 ]; then + DOWNLOADER="zsync" + else + DOWNLOADER="${DL}" + fi + # If the OS has an editions_() function, use it. + if [[ $(type -t "editions_${OS}") == function ]]; then + for OPTION in $(editions_"${OS}"); do + echo "${DISPLAY_NAME},${OS},${RELEASE},${OPTION},${DOWNLOADER},${PNG},${SVG}" + done + else + echo "${DISPLAY_NAME},${OS},${RELEASE},,${DOWNLOADER},${PNG},${SVG}" + fi + done + done + exit 0 +} + +function os_support() { + echo agarimos \ + alma \ + alpine \ + android \ + archlinux \ + archcraft \ + arcolinux \ + batocera \ + cachyos \ + centos-stream \ + cereus \ + debian \ + deepin \ + devuan \ + dietpi \ + dragonflybsd \ + elementary \ + endeavouros \ + fedora \ + freebsd \ + freedos \ + fvoid \ + gabeeos \ + garuda \ + gentoo \ + ghostbsd \ + haiku \ + kali \ + kdeneon \ + kolibrios \ + kubuntu \ + linuxmint \ + lmde \ + mageia \ + manjaro \ + mxlinux \ + netboot \ + netbsd \ + nixos \ + lubuntu \ + openbsd \ + opensuse \ + oraclelinux \ + popos \ + reactos \ + rebornos \ + rockylinux \ + slackware \ + slitaz \ + solus \ + steamos \ + tails \ + truenas-core \ + truenas-scale \ + ubuntu \ + ubuntu-budgie \ + ubuntukylin \ + ubuntu-mate \ + ubuntustudio \ + ubuntu-unity \ + void \ + voidpup \ + vxlinux \ + xerolinux \ + xubuntu \ + zorin +} + +function releases_agarimos() { + echo 20230305 20230303 20230225 20230216 +} + +function releases_alma() { + echo 8.6 8.7 9.0 9.1 +} + +function editions_alma() { + echo minimal dvd +} + +function releases_alpine() { + echo 3.12 3.13 3.14 3.15 latest +} + +function releases_android() { + echo 7.1 8.1 9.0 +} + +function editions_android() { + echo x86 x86_64 +} + +function releases_archlinux() { + echo latest +} + +function releases_archcraft() { + echo latest +} + +function releases_arcolinux() { + echo v21.09.11 v21.11.05 v22.01.10 +} + +function editions_arcolinux() { + echo large small +} + +function releases_batocera() { + echo 32 33 34 +} + +function releases_cachyos() { + echo 230305 +} + +function editions_cachyos() { + echo kde gnome +} + +function releases_centos-stream() { + echo 8 9 +} + +function editions_centos-stream() { + echo dvd1 boot +} + +function releases_cereus() { + echo latest +} + +function editions_cereus() { + echo base lxqt xfce +} + +function releases_debian() { + DEBCURRENT=$(wget -q https://cdimage.debian.org/debian-cd/ -O- |grep '\.[0-9]/'|cut -d\> -f9|cut -d\/ -f1) + local DEBOLD=$(wget -q https://cdimage.debian.org/cdimage/archive/ -O- |grep -e '>[1-9][0-9]\.'|grep -v 'live' | cut -d\> -f9|cut -d\/ -f1 ) + echo ${DEBOLD} ${DEBCURRENT} +} + +function editions_debian() { + echo standard cinnamon gnome kde lxde lxqt mate xfce netinst +} + +function releases_deepin() { + echo 20 20.1 20.2 20.2.1 20.2.2 20.2.3 20.2.4 20.3 20.4 20.5 20.6 20.7 +} + +function releases_devuan() { + echo beowulf chimaera +} + +function releases_dietpi() { + echo bios uefi +} + +function editions_dietpi() { + echo bookworm bookworm-installer bullseye bullseye-installer +} + +function releases_dragonflybsd() { + echo 6.4.0 +} + +function releases_elementary() { + echo 7.0 +} + +function releases_endeavouros() { + echo apollo_22_1 \ + artemis-22_6 \ + artemis_neo_22_7 \ + artemis_neo_22_8 \ + artemis_nova_22_9 \ + atlantis-21_4 \ + atlantis_neo-21_5 \ + cassini_22_12 +} + +function releases_fedora() { + echo 33 34 35 36 37 +} + +function editions_fedora() { + echo Workstation \ + Cinnamon \ + i3 \ + KDE \ + LXDE \ + LXQt \ + Mate \ + Xfce \ + Silverblue \ + Server +} + +function releases_freebsd(){ + local FBSD_RELEASES=$(curl -sL https://download.freebsd.org/ftp/releases/amd64/amd64/ISO-IMAGES/|grep -e 'class="link"' |grep -v '\.\.'|cut -d\" -f4|tr -d '/') + echo ${FBSD_RELEASES} +} + +function editions_freebsd(){ + echo disc1 dvd1 +} + +function releases_freedos() { + echo 1.2 1.3 +} + +function releases_fvoid() { + echo latest +} + +function releases_gabeeos() { + echo latest +} + +function releases_garuda() { + echo latest +} + +function editions_garuda() { + URL="https://mirrors.fossho.st/garuda/iso/latest/garuda/" + echo $(wget -q -O - ${URL} | grep '^ dvd at 9.0 +function editions_rockylinux() { + echo minimal \ + "dvd (dvd1 prior to 9.0)" +} + +function releases_slackware() { + echo 14.2 15.0 +} + +function releases_slitaz() { + echo preferred core core64 loram core-5in1 preinit +} + +function releases_solus() { + echo 4.3 +} + +function editions_solus() { + echo Budgie GNOME MATE Plasma +} + +function releases_steamos() { + echo 4.0 +} + +function releases_tails() { + echo stable +} + +function releases_truenas() { + if [[ $OS == truenas ]] ; then + echo "ERROR! The supported TrueNAS OS values are truenas-core or truenas-scale" + exit 1; + fi + } + +function releases_truenas-core() { + echo 12.0 13.0 +} + +function releases_truenas-scale() { + echo 22.02 22.12 +} + +function releases_ubuntu() { + local LTS_SUPPORT="14.04 16.04 18.04 20.04 22.04" + local INTERIM_SUPPORT="22.10" + case "${OS}" in + kubuntu|lubuntu|ubuntukylin|\ + ubuntu-mate|ubuntustudio|xubuntu) + ## after 14.04 + LTS_SUPPORT="${LTS_SUPPORT/14.04 /}" + ;; + ubuntu-budgie) + #after 16.04 + LTS_SUPPORT="${LTS_SUPPORT/14.04 16.04 /}" + ;; + ubuntu-unity) + INTERIM_SUPPORT="${INTERIM_SUPPORT}" + ;; + esac + INTERIM_SUPPORT="${INTERIM_SUPPORT/22.10 /}" + if [ "${OS}" == "ubuntu-unity" ]; then + echo ${INTERIM_SUPPORT} \ + daily-live \ + daily-canary \ + ; + else + echo ${LTS_SUPPORT} \ + ${INTERIM_SUPPORT} \ + jammy-daily \ + daily-live \ + daily-canary \ + eol-4.10 \ + eol-5.04 \ + eol-5.10 \ + eol-6.06.0 eol-6.06.1 eol-6.06.2 \ + eol-6.10 \ + eol-7.04 \ + eol-7.10 \ + eol-8.04.0 eol-8.04.1 eol-8.04.2 eol-8.04.3 eol-8.04.4 \ + eol-8.10 \ + eol-9.04 \ + eol-9.10 \ + eol-10.04.0 eol-10.04.1 eol-10.04.2 eol-10.04.3 eol-10.04.4 \ + eol-10.10 \ + eol-11.04 \ + eol-11.10 \ + eol-12.04 eol-12.04.0 eol-12.04.1 eol-12.04.2 eol-12.04.3 eol-12.04.4 eol-12.04.5 \ + eol-12.10 \ + eol-13.04 \ + eol-13.10 \ + eol-14.04.0 eol-14.04.1 eol-14.04.2 eol-14.04.3 eol-14.04.4 eol-14.04.5 \ + eol-14.10 \ + eol-15.04 \ + eol-15.10 \ + eol-16.04.0 eol-16.04.1 eol-16.04.2 eol-16.04.3 eol-16.04.4 eol-16.04.5 eol-16.04.6 \ + eol-16.10 \ + eol-17.04 \ + eol-17.10 \ + eol-18.04 eol-18.04.0 eol-18.04.1 eol-18.04.2 eol-18.04.3 eol-18.04.4 eol-18.04.5 \ + eol-18.10 \ + eol-19.04 \ + eol-19.10 \ + eol-20.04 eol-20.04.0 eol-20.04.1 eol-20.04.2 \ + eol-20.10 \ + eol-21.04 \ + eol-21.10 \ + ; + fi +} + +function releases_void() { + echo current 20221001 20210316 20210930 20210218 20191109 20190526 20190217 20181111 20171007 20170825 20170220 +} + +function editions_void() { + echo base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl gnome gnome-musl lxde lxde-musl lxqt lxqt-musl mate mate-musl xfce xfce-musl +} + +function releases_voidpup() { + echo latest +} + +function releases_vxlinux() { + echo 6.1 5.0 4.2 4.1 4.0 +} + +function releases_xerolinux() { + echo kde +} + +function releases_zorin() { + echo 16 +} + +function editions_zorin() { + echo core64 lite64 education64 edulite64 +} + +function check_hash() { + local iso="" + local hash="" + local hash_algo="" + iso="${VM_PATH}/${1}" + hash="${2}" + # Guess the hash algorithm by the hash length + case ${#hash} in + 32) hash_algo=md5sum;; + 40) hash_algo=sha1sum;; + 64) hash_algo=sha256sum;; + 128) hash_algo=sha512sum;; + *) echo "WARNING! Can't guess hash algorithm, not checking ${iso} hash." + return;; + esac + echo -n "Checking ${iso} with ${hash_algo}... " + if ! echo "${hash} ${iso}" | ${hash_algo} --check --status; then + echo "ERROR!" + echo "${iso} doesn't match ${hash}. Try running 'quickget' again." + exit 1 + else + echo "Good!" + fi +} + +function web_get() { + local DIR="${2}" + local FILE="" + local URL="${1}" + if [ -n "${3}" ]; then + FILE="${3}" + else + FILE="${URL##*/}" + fi + if ! mkdir -p "${DIR}" 2>/dev/null; then + echo "ERROR! Unable to create directory ${DIR}" + exit 1 + fi + if command -v aria2c &>/dev/null; then + if ! aria2c --stderr -x16 --continue=true --summary-interval=0 --download-result=hide --console-log-level=error "${URL}" -o "${DIR}/${FILE}"; then + echo #Necessary as aria2c in suppressed mode does not have new lines + echo "ERROR! Failed to download ${URL} with aria2c. Try running 'quickget' again." + exit 1 + fi + echo #Necessary as aria2c in suppressed mode does not have new lines + else + if ! wget --quiet --continue --show-progress --progress=bar:force:noscroll "${URL}" -O "${DIR}/${FILE}"; then + echo "ERROR! Failed to download ${URL} with wget. Try running 'quickget' again." + exit 1 + fi + fi +} + +function zsync_get() { + local DIR="${2}" + local FILE="${1##*/}" + local OUT="" + local URL="${1}" + + if command -v zsync &>/dev/null; then + if [ -n "${3}" ]; then + OUT="${3}" + else + OUT="${FILE}" + fi + if ! mkdir -p "${DIR}" 2>/dev/null; then + echo "ERROR! Unable to create directory ${DIR}" + exit 1 + fi + # Only force http for zsync - not earlier because we might fall through here + if ! zsync "${URL/https/http}.zsync" -i "${DIR}/${OUT}" -o "${DIR}/${OUT}" 2>/dev/null; then + echo "ERROR! Failed to download ${URL/https/http}.zsync" + exit 1 + fi + if [ -e "${DIR}/${OUT}.zs-old" ]; then + rm "${DIR}/${OUT}.zs-old" + fi + else + echo "INFO: zsync not found, falling back to wget/aria2c" + if [ -n "${3}" ]; then + web_get "${1}" "${2}" "${3}" + else + web_get "${1}" "${2}" + fi + fi +} + +function make_vm_config() { + local CONF_FILE="" + local IMAGE_FILE="" + local ISO_FILE="" + local IMAGE_TYPE="" + local GUEST="" + local SEC_BOOT="" + IMAGE_FILE="${1}" + ISO_FILE="${2}" + case "${OS}" in + batocera) + GUEST="batocera" + IMAGE_TYPE="img";; + dragonflybsd) + GUEST="dragonflybsd" + IMAGE_TYPE="iso";; + freebsd|ghostbsd) + GUEST="freebsd" + IMAGE_TYPE="iso";; + haiku) + GUEST="haiku" + IMAGE_TYPE="iso";; + freedos) + GUEST="freedos" + IMAGE_TYPE="iso";; + kolibrios) + GUEST="kolibrios" + IMAGE_TYPE="iso";; + netbsd) + GUEST="netbsd" + IMAGE_TYPE="iso";; + openbsd) + GUEST="openbsd" + IMAGE_TYPE="iso";; + reactos) + GUEST="reactos" + IMAGE_TYPE="iso";; + truenas*) + GUEST="truenas" + IMAGE_TYPE="iso";; + *) + GUEST="linux" + IMAGE_TYPE="iso";; + esac + if [ -n "${EDITION}" ]; then + CONF_FILE="${OS}-${RELEASE}-${EDITION}.conf" + else + CONF_FILE="${OS}-${RELEASE}.conf" + fi + if [ ! -e "${CONF_FILE}" ]; then + echo "Making ${CONF_FILE}" + cat << EOF > "${CONF_FILE}" +#!$(which quickemu) --vm +guest_os="${GUEST}" +disk_img="${VM_PATH}/disk.qcow2" +${IMAGE_TYPE}="${VM_PATH}/${IMAGE_FILE}" +EOF + echo "Giving user execute permissions on ${CONF_FILE}," + chmod u+x "${CONF_FILE}" + if [ -n "${ISO_FILE}" ]; then + echo "fixed_iso=\"${VM_PATH}/${ISO_FILE}\"" >> "${CONF_FILE}" + fi + # OS specific tweaks + case ${OS} in + alma|centos-stream|oraclelinux|popos|rockylinux) + echo "disk_size=\"32G\"" >> "${CONF_FILE}";; + batocera) + echo "disk_size=\"8G\"" >> "${CONF_FILE}";; + dietpi) + if [ "${RELEASE}" == "bios" ]; then + echo "boot=\"legacy\"" >> "${CONF_FILE}" + fi + ;; + dragonflybsd|haiku|openbsd|netbsd|slackware|tails) + echo "boot=\"legacy\"" >> "${CONF_FILE}";; + deepin) + echo "disk_size=\"64G\"" >> "${CONF_FILE}" + echo "ram=\"4G\"" >> "${CONF_FILE}" + ;; + freedos) + echo "boot=\"legacy\"" >> "${CONF_FILE}" + echo "disk_size=\"4G\"" >> "${CONF_FILE}" + echo "ram=\"256M\"" >> "${CONF_FILE}" + ;; + kolibrios) + echo "boot=\"legacy\"" >> "${CONF_FILE}" + echo "disk_size=\"2G\"" >> "${CONF_FILE}" + echo "ram=\"128M\"" >> "${CONF_FILE}" + ;; + slitaz) + echo "boot=\"legacy\"" >> "${CONF_FILE}" + echo "disk_size=\"4G\"" >> "${CONF_FILE}" + echo "ram=\"512M\"" >> "${CONF_FILE}" + ;; + truenas-scale|truenas-core) + echo + echo "boot=\"legacy\"" >> "${CONF_FILE}" + # the rest is non-functional + # echo "bootdrive_size=\"5G\"" >> "${CONF_FILE}" # boot drive + # echo "1stdrive_size=\"20G\"" >> "${CONF_FILE}" # for testing + # echo "2nddrive_size=\"20G\"" >> "${CONF_FILE}" # again, for testing + ;; + zorin) + case ${EDITION} in + education64|edulite64) + echo "disk_size=\"32G\"" >> "${CONF_FILE}";; + esac + ;; + reactos) + echo "boot=\"legacy\"" >> "${CONF_FILE}" + echo "disk_size=\"12G\"" >> "${CONF_FILE}" + echo "ram=\"2048M\"" >> "${CONF_FILE}" + ;; + esac + fi + echo + echo "To start your $(pretty_name "${OS}") virtual machine run:" + echo " quickemu --vm ${CONF_FILE}" + echo + exit 0 +} + +function get_agarimos() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="" + case ${RELEASE} in + 20230305) + URL="https://sourceforge.net/projects/agarimos/files/Gnome" + ISO="AgarimOS-Gnome-Catppuccin-Live-x86_64-6.1.14_1-20230305.iso" + ;; + 20230303) + URL="https://sourceforge.net/projects/agarimos/files/Plasma" + ISO="AgarimOS-Plasma-Dracula-Live-x86_64-6.1.14_1-20230303.iso" + ;; + 20230225) + URL="https://sourceforge.net/projects/agarimos/files/XFCE4" + ISO="AgarimOS-XFCE4-Catppuccin-Live-x86_64-6.1.12_1-20230216.iso" + ;; + 20230216) + URL="https://sourceforge.net/projects/agarimos/files/XFCE4" + ISO="AgarimOS-XFCE4-Catppuccin-Live-6.1.13_1-20230225.iso" + ;; + esac + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_alma() { + local EDITION="${1:-}" + local HASH="" + local ISO="AlmaLinux-${RELEASE}-x86_64-${EDITION}.iso" + local URL="http://lon.mirror.rackspace.com/almalinux/${RELEASE/beta-1/beta}/isos/x86_64/" + HASH="$(wget -q -O- "${URL}/CHECKSUM" | grep "(${ISO}" | cut -d' ' -f4)" + echo "${URL}/${ISO} ${HASH}" +} + +function get_alpine() { + local HASH="" + local ISO="" + local URL="" + local VERSION="" + case ${RELEASE} in + latest) URL="https://dl-cdn.alpinelinux.org/alpine/latest-stable/releases/x86_64";; + *) URL="https://dl-cdn.alpinelinux.org/alpine/v${RELEASE}/releases/x86_64";; + esac + VERSION=$(wget -qO- "${URL}/latest-releases.yaml" | awk '/"Xen"/{found=0} {if(found) print} /"Virtual"/{found=1}' | grep 'version:' | awk '{print $2}') + ISO="alpine-virt-${VERSION}-x86_64.iso" + HASH=$(wget -qO- "${URL}/latest-releases.yaml" | awk '/"Xen"/{found=0} {if(found) print} /"Virtual"/{found=1}' | grep 'sha256:' | awk '{print $2}') + echo "${URL}/${ISO} ${HASH}" +} + +function get_android() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local JSON_ALL="" + local JSON_REL="" + local URL="https://mirrors.gigenet.com/OSDN/android-x86" + JSON_ALL=$(wget -q -O- "https://www.fosshub.com/Android-x86-old.html" | grep "var settings =" | cut -d'=' -f2-) + JSON_REL=$(echo "${JSON_ALL}" | jq --arg ver "${OS}-${EDITION}-${RELEASE}" 'first(.pool.f[] | select((.n | startswith($ver)) and (.n | endswith(".iso"))))') + ISO=$(echo "${JSON_REL}" | jq -r .n) + HASH=$(echo "${JSON_REL}" | jq -r .hash.sha256) + # Traverse the directories to find the .iso location + for DIR in $(wget -4 -q -O- "${URL}" | grep -o -E '[0-9]{5}' | sort -ur); do + if wget -4 -q -O- "${URL}/${DIR}" | grep "${ISO}" &>/dev/null; then + URL="${URL}/${DIR}" + break + fi + done + echo "${URL}/${ISO} ${HASH}" +} + +function get_archlinux() { + local HASH="" + local ISO="" + local URL="https://mirror.rackspace.com/archlinux" + ISO=$(wget -q -O- "https://archlinux.org/releng/releases/json/" | jq -r '.releases[0].iso_url') + HASH=$(wget -q -O- "https://archlinux.org/releng/releases/json/" | jq -r '.releases[0].sha1_sum') + echo "${URL}/${ISO} ${HASH}" +} + +function get_archcraft() { + local HASH="" + local URL="" + local TMPURL="" + TMPURL=$(wget -q -S -O- --max-redirect=0 "https://sourceforge.net/projects/archcraft/files/latest/download" 2>&1 | grep -i Location | cut -d' ' -f4) + URL=${TMPURL%\?*} + echo "${URL} ${HASH}" +} + +function get_arcolinux() { + local EDITION="${1:-}" + local HASH="" + local ISO="arcolinux${EDITION:0:1}-${RELEASE}-x86_64.iso" + local URL="https://ant.seedhost.eu/arcolinux/iso/${RELEASE}" + HASH=$(wget -q -O- "${URL}/${ISO}.sha1" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_batocera() { + local HASH="" + local URL="https://mirrors.o2switch.fr/batocera/x86_64/stable/last" + local ISO="$(curl -sl ${URL}/ | grep -e 'batocera.*img.gz'|cut -d\" -f2)" + local CURRENT_RELEASE=$(echo "${ISO}"| cut -d\- -f3) + case ${RELEASE} in + ${CURRENT_RELEASE}) #Current release + URL+="" + ;; + *) + URL+="/archives/${RELEASE}" + ISO="$(curl -sl ${URL}/ | grep -e 'batocera.*img.gz'|cut -d\" -f2)" + ;; # non-current are here + esac + echo "${URL}/${ISO} ${HASH}" +} + +function get_cachyos() { + local HASH="" + local ISO="cachyos-${EDITION}-linux-${RELEASE}.iso" + local URL="https://mirror.cachyos.org/ISO/${EDITION}/${RELEASE}" + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_centos-stream() { + local HASH="" + local ISO="" + case ${RELEASE} in + 8) + ISO="CentOS-Stream-${RELEASE}-x86_64-latest-${EDITION}.iso" + URL="https://mirrors.ocf.berkeley.edu/centos/8-stream/isos/x86_64" + HASH=$(wget -q -O- ${URL}/CHECKSUM | grep "SHA256 (${ISO}" | cut -d' ' -f4) + ;; + 9) + ISO="CentOS-Stream-${RELEASE}-latest-x86_64-${EDITION}.iso" + URL="https://mirrors.ocf.berkeley.edu/centos-stream/9-stream/BaseOS/x86_64/iso" + HASH=$(wget -q -O- ${URL}/${ISO}.SHA256SUM | grep "SHA256 (${ISO}" | cut -d' ' -f4) + ;; + esac + echo "${URL}/${ISO} ${HASH}" +} + +function get_cereus() { + local HASH="" + local ISO="" + local URL="" + case ${EDITION} in + base) + ISO="cereus-beta-live-x86_64-xfce-2023.02.17.iso" + URL="https://sourceforge.net/projects/cereus-linux/files/isos/beta/latest/base" + HASH=$(wget -q -O- ${URL}/SHA256 | grep "${ISO}" | cut -d' ' -f2) + ;; + lxqt) + ISO="cereus-beta-live-x86_64-lxqt-2023.02.17.iso" + URL="https://sourceforge.net/projects/cereus-linux/files/isos/beta/latest/lxqt" + HASH=$(wget -q -O- ${URL}/SHA256 | grep "${ISO}" | cut -d' ' -f4) + ;; + xfce) + ISO="cereus-beta-live-x86_64-xfce-2023.02.17.iso" + URL="https://sourceforge.net/projects/cereus-linux/files/isos/beta/latest/xfce" + HASH=$(wget -q -O- ${URL}/SHA256 | grep "${ISO}" | cut -d' ' -f4) + ;; + esac + echo "${URL}/${ISO} ${HASH}" +} + +function get_debian() { + local EDITION="${1:-}" + local HASH="" + local ISO="debian-live-${RELEASE}-amd64-${EDITION}.iso" + local URL="" + DEBCURRENT=$(wget -q https://cdimage.debian.org/debian-cd/ -O- |grep '\.[0-9]/'|cut -d\> -f9|cut -d\/ -f1) + case ${RELEASE} in + "${DEBCURRENT}") URL="https://cdimage.debian.org/debian-cd/${RELEASE}-live/amd64/iso-hybrid";; + *) URL="https://cdimage.debian.org/cdimage/archive/${RELEASE}-live/amd64/iso-hybrid/";; + esac + if [ "${EDITION}" == "netinst" ]; then + URL="${URL/-live/}" + URL="${URL/hybrid/cd}" + ISO="${ISO/-live/}" + fi + HASH=$(wget -q -O- "${URL}/SHA512SUMS" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_deepin() { + local HASH="" + local EDITION="" + local ISO="deepin-desktop-community-${RELEASE}-amd64.iso" + # deepin-desktop-community-20.3-amd64.iso + local URL="https://cdimage.deepin.com/releases/"${RELEASE} + # fix iso name + if [[ "${RELEASE}" == *"20" ]] ; then + EDITION="1003" + ISO="deepin-desktop-community-${EDITION}-amd64.iso" + elif [[ "${RELEASE}" == *"20.1" ]]; then + EDITION="1010" + ISO="deepin-desktop-community-${EDITION}-amd64.iso" + fi + HASH=$(wget -q -O- "${URL}/SHA256SUMS" | grep "${ISO}" | cut -d' ' -f1) + #echo "${URL}/${ISO} ${HASH}" + web_get "${URL}/${ISO}" "${VM_PATH}" + check_hash "${ISO}" "${HASH}" + make_vm_config "${ISO}" +} + +function get_devuan() { + local HASH="" + local ISO="" + local URL="https://files.devuan.org/devuan_${RELEASE}/desktop-live" + case ${RELEASE} in + beowulf) ISO="devuan_${RELEASE}_3.1.1_amd64_desktop-live.iso";; + chimaera) ISO="devuan_${RELEASE}_4.0.2_amd64_desktop-live.iso";; + esac + HASH=$(wget -q -O- "${URL}/SHASUMS.txt" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_dietpi() { + local HASH="" + local ISO="" + local URL="https://dietpi.com/downloads/images" + case ${RELEASE} in + bios) + case ${EDITION} in + bookworm) + local ISO="DietPi_NativePC-BIOS-x86_64-Bookworm.7z" + ;; + bullseye) + local ISO="DietPi_NativePC-BIOS-x86_64-Bullseye.7z" + ;; + bookworm-installer) + local ISO="DietPi_NativePC-BIOS-x86_64-Bookworm_Installer.7z" + ;; + bullseye-installer) + local ISO="DietPi_NativePC-BIOS-x86_64-Bullseye_Installer.7z" + ;; + esac + ;; + uefi) + case ${EDITION} in + bookworm-installer) + local ISO="DietPi_NativePC-UEFI-x86_64-Bookworm_Installer.7z" + ;; + bullseye-installer) + local ISO="DietPi_NativePC-UEFI-x86_64-Bullseye_Installer.7z" + ;; + esac + ;; + esac + HASH=$(wget -q -O- "${URL}/SHASUMS.txt" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_dragonflybsd() { + local HASH="" + local ISO="dfly-x86_64-${RELEASE}_REL.iso" + local URL="http://mirror-master.dragonflybsd.org/iso-images" + HASH=$(wget -q -O- "${URL}/md5.txt" | grep "(${ISO})" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_elementary() { + local HASH="" + case ${RELEASE} in + 6.2) + local ISO="elementaryos-${RELEASE}-stable.20211218-rc.iso" + ;; + 7.0) + local ISO="elementaryos-${RELEASE}-stable.20230129rc.iso" + ;; + esac + local URL="https://ams3.dl.elementary.io/download" + echo "${URL}/$(date +%s | base64)/${ISO} ${HASH}" +} + +function get_endeavouros() { + local HASH="" + # Endeavour release names are Capitalized and our $RELEASE is forced to lowercase so we have to revert it + local ISO="EndeavourOS_${RELEASE@u}.iso" + local URL="https://github.com/endeavouros-team/ISO/releases/download/1-EndeavourOS-ISO-releases-archive" + HASH=$(wget -q -O- "${URL}/${ISO}.sha512sum" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_fedora() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local JSON="" + local URL="" + local VARIANT="" + case ${EDITION} in + Server|Silverblue|Workstation) VARIANT="${EDITION}";; + *) VARIANT="Spins";; + esac + JSON=$(wget -q -O- "https://getfedora.org/releases.json" | jq '.[] | select(.variant=="'${VARIANT}'" and .subvariant=="'"${EDITION}"'" and .arch=="x86_64" and .version=="'"${RELEASE}"'")') + URL=$(echo "${JSON}" | jq -r '.link' | head -n1) + HASH=$(echo "${JSON}" | jq -r '.sha256' | head -n1) + echo "${URL} ${HASH}" +} + +function get_freebsd() { + local EDITION="${1}" + local HASH="" + local ISO="FreeBSD-${RELEASE}-RELEASE-amd64-${EDITION}.iso" + local URL="https://download.freebsd.org/ftp/releases/amd64/amd64/ISO-IMAGES/${RELEASE}" + HASH=$(wget -q -O- "${URL}/CHECKSUM.SHA256-FreeBSD-${RELEASE}-RELEASE-amd64" | grep "${ISO}" | grep -v ".xz" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_freedos() { + local HASH="" + local ISO="" + local URL="http://www.ibiblio.org/pub/micro/pc-stuff/freedos/files/distributions/${RELEASE}/official" + case ${RELEASE} in + 1.2) + ISO="FD12CD.iso" + HASH=$(wget -q -O- "${URL}/FD12.sha" | grep "${ISO}" | cut -d' ' -f1) + ;; + 1.3) + ISO="FD13-LiveCD.zip" + HASH=$(wget -q -O- "${URL}/verify.txt" | grep -A 8 "sha256sum" | grep "${ISO}" | cut -d' ' -f1) + ;; + esac + echo "${URL}/${ISO} ${HASH}" +} + +function get_fvoid() { + local HASH="" + local URL="" + local TMPURL="" + TMPURL=$(wget -q -S -O- --max-redirect=0 "https://sourceforge.net/projects/f-void/files/latest/download" 2>&1 | grep -i Location | cut -d' ' -f4) + URL=${TMPURL%\?*} + echo "${URL} ${HASH}" +} + +function get_gabeeos() { + local HASH="" + local URL="" + local TMPURL="" + + TMPURL=$(wget -q -S -O- --max-redirect=0 "https://sourceforge.net/projects/gabeeos/files/latest/download" 2>&1 | grep -i Location | cut -d' ' -f4) + URL=${TMPURL%\?*} + echo "${URL} ${HASH}" +} + +function get_garuda() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="https://mirrors.fossho.st/garuda/iso/latest/garuda/" + ISO=${EDITION}/latest.iso + HASH="$(wget -q -O- "${URL}/${ISO}.sha256" | cut -d' ' -f1)" + echo "${URL}/${ISO} ${HASH}" +} + +function get_gentoo() { + local HASH="" + local ISO="" + local URL="https://mirror.bytemark.co.uk/gentoo/releases/amd64/autobuilds/" + ISO=$(wget -q -O- "${URL}/${RELEASE}-iso.txt" | grep install | cut -d' ' -f1) + HASH=$( wget -q -O- "${URL}/${ISO}.DIGESTS" | grep iso | grep -v CONTENTS | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_ghostbsd() { + local EDITION="${1:-}" + local ISO="" + local URL="https://download.ghostbsd.org/releases/amd64/${RELEASE}" + local HASH="" + case ${EDITION} in + mate) ISO="GhostBSD-${RELEASE}.iso";; + xfce) ISO="GhostBSD-${RELEASE}-XFCE.iso";; + esac + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | grep "${ISO}" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_haiku() { + local EDITION="${1:-}" + local ISO="haiku-${RELEASE}-${EDITION}-anyboot.iso" + # local URL="https://cdn.haiku-os.org/haiku-release/${RELEASE}" # domain gone + local URL="http://mirror.rit.edu/haiku/${RELEASE}" # NY, USA + # local URL="https://mirrors.tnonline.net/haiku/haiku-release/${RELEASE}" # Sweden + # local URL="https://mirror.aarnet.edu.au/pub/haiku/${RELEASE}" # Aus + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | grep "${ISO}" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_kali() { + local HASH="" + local ISO="" + local URL="https://cdimage.kali.org/${RELEASE}" + ISO=$(wget -q -O- "${URL}/?C=M;O=D" | grep -o ">kali-linux-.*-installer-amd64.iso" | head -n 1 | cut -c 2-) + HASH=$(wget -q -O- "${URL}/SHA256SUMS" | grep -v torrent | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_kdeneon() { + local HASH="" + local ISO="" + local URL="https://files.kde.org/neon/images/${RELEASE}/current" + ISO=$(wget -q -O- "${URL}/neon-${RELEASE}-current.sha256sum" | cut -d' ' -f3-) + HASH=$(wget -q -O- "${URL}/neon-${RELEASE}-current.sha256sum" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_kolibrios() { + local HASH="" + local ISO="kolibri.iso" + local URL="https://builds.kolibrios.org/eng" + echo "${URL}/${ISO} ${HASH}" +} + +function get_linuxmint() { + local EDITION="${1:-}" + local HASH="" + local ISO="linuxmint-${RELEASE}-${EDITION}-64bit.iso" + local URL="https://mirror.bytemark.co.uk/linuxmint/stable/${RELEASE}" + HASH=$(wget -q -O- "${URL}/sha256sum.txt" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_lmde() { + local EDITION="${1:-}" + local HASH="" + local ISO="lmde-${RELEASE}-${EDITION}-64bit.iso" + local URL="https://mirror.bytemark.co.uk/linuxmint/debian" + HASH=$(wget -q -O- "${URL}/sha256sum.txt" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_mageia() { + local EDITION="${1:-}" + local ISO=$(wget -q https://www.mageia.org/en/downloads/get/?q="Mageia-${RELEASE}-Live-${EDITION}-x86_64.iso" -O- | grep 'click here'| grep -o 'href=.*\.iso'|cut -d\" -f2) + local HASH=$(wget -q -O- "${ISO}.sha512" | cut -d' ' -f1) + echo "${ISO} ${HASH}" +} + +function get_manjaro() { + local HASH="" + local ISO="" + local MANIFESTURL="" + local URL="" + case ${RELEASE} in + gnome|kde|xfce) MANIFESTURL="https://gitlab.manjaro.org/webpage/manjaro-homepage/-/raw/master/site/content/downloads/official/${RELEASE}.md";; + budgie|cinnamon|deepin|i3|mate) MANIFESTURL="https://gitlab.manjaro.org/webpage/manjaro-homepage/-/raw/master/site/content/downloads/community/${RELEASE}.md";; + esac + URL="$(wget -qO- "${MANIFESTURL}" | grep "Download_x64 =" | cut -d'"' -f2)" + HASH=$(wget -qO- "${MANIFESTURL}" | grep "Download_x64_Checksum =" | cut -d'"' -f2) + echo "${URL} ${HASH}" +} + +function get_mxlinux() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="https://sourceforge.net/projects/mx-linux/files/Final/${EDITION}" + case ${EDITION} in + Xfce) ISO="MX-${RELEASE}_x64.iso";; + KDE) ISO="MX-${RELEASE}_KDE_x64.iso";; + Fluxbox) ISO="MX-${RELEASE}_fluxbox_x64.iso";; + esac + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_netboot() { + local ISO="netboot.xyz.iso" + local HASH="" + local URL="https://boot.netboot.xyz/ipxe" + HASH=$(wget -q -O- "${URL}/netboot.xyz-sha256-checksums.txt" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_netbsd() { + local HASH="" + local ISO="NetBSD-${RELEASE}-amd64.iso" + local URL="https://cdn.netbsd.org/pub/NetBSD/NetBSD-${RELEASE}/images/" + HASH=$(wget -q -O- "${URL}/MD5" | grep "${ISO}" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_nixos() { + local EDITION="${1:-}" + local HASH="" + local ISO="latest-nixos-${EDITION}-x86_64-linux.iso" + local URL="https://channels.nixos.org/nixos-${RELEASE}" + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_openbsd() { + local HASH="" + local ISO="install${RELEASE//\./}.iso" + local URL="https://mirror.leaseweb.com/pub/OpenBSD/${RELEASE}/amd64" + HASH=$(wget -q -O- "${URL}/SHA256" | grep "${ISO}" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_opensuse() { + local HASH="" + local ISO="" + local URL="" + if [ "${RELEASE}" == "tumbleweed" ]; then + ISO="openSUSE-Tumbleweed-DVD-x86_64-Current.iso" + URL="https://download.opensuse.org/tumbleweed/iso" + elif [ "${RELEASE}" == "microos" ]; then + ISO="openSUSE-MicroOS-DVD-x86_64-Current.iso" + URL="https://download.opensuse.org/tumbleweed/iso" + elif [ "$RELEASE" == 15.0 ] || [ "$RELEASE" == 15.1 ]; then + ISO="openSUSE-Leap-${RELEASE}-DVD-x86_64.iso" + URL="https://download.opensuse.org/distribution/leap/${RELEASE}/iso" + else + ISO="openSUSE-Leap-${RELEASE}-DVD-x86_64-Current.iso" + URL="https://download.opensuse.org/distribution/leap/${RELEASE}/iso" + fi + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" |awk '{if(NR==4) print $0}'|cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_oraclelinux() { + local HASH="" + local ISO="" + local VER_MAJ=${RELEASE::1} + local VER_MIN=${RELEASE:2:1} + local URL="https://yum.oracle.com/ISOS/OracleLinux/OL${VER_MAJ}/u${VER_MIN}/x86_64/" + case ${VER_MAJ} in + 7) ISO="OracleLinux-R${VER_MAJ}-U${VER_MIN}-Server-x86_64-dvd.iso";; + *) ISO="OracleLinux-R${VER_MAJ}-U${VER_MIN}-x86_64-dvd.iso";; + esac + HASH=$(wget -q -O- "https://linux.oracle.com/security/gpg/checksum/OracleLinux-R${VER_MAJ}-U${VER_MIN}-Server-x86_64.checksum" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_popos() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="" + URL=$(wget -q -O- "https://api.pop-os.org/builds/${RELEASE}/${EDITION}" | jq -r .url) + HASH=$(wget -q -O- "https://api.pop-os.org/builds/${RELEASE}/${EDITION}" | jq -r .sha_sum) + echo "${URL} ${HASH}" +} + +function get_reactos() { + local HASH="" + local URL="" + local TMPURL="" + TMPURL=$(wget -q -S -O- --max-redirect=0 "https://sourceforge.net/projects/reactos/files/latest/download" 2>&1 | grep -i Location | cut -d' ' -f4) + URL=${TMPURL%\?*} + echo "${URL} ${HASH}" +} + +function get_rebornos() { + local ISO=$(curl -s 'https://www.rebornos.org/download/' | grep -ohE 'https://pub-cb7a4d4f7a974896b3bf40c52d1defbc.r2.dev/RebornOS-ISO/(rebornos_xfce_minimal|rebornos_iso)-[0-9]{4}.[0-9]{2}.[0-9]{2}-x86_64.iso' | tail -n1) + local HASH=$(curl -s 'https://www.rebornos.org/download/' | grep -ozP 'Checksum MD5:.*[0-9a-fA-F]{32}' | grep -zoP '[0-9a-fA-F]{32}' | cut -d '' -f1) + echo "${ISO} ${HASH}" +} + +function get_rockylinux() { + local EDITION="${1:-}" + local HASH="" + local ISO="Rocky-${RELEASE}-x86_64-${EDITION}.iso" + local URL="" + case ${RELEASE} in + 9.1) URL="https://download.rockylinux.org/pub/rocky/${RELEASE}/isos/x86_64";; + *) URL="http://dl.rockylinux.org/vault/rocky/${RELEASE}/isos/x86_64/";; + esac + HASH=$(wget -q -O- "${URL}/CHECKSUM" | grep "SHA256" | grep "${ISO})" | cut -d' ' -f4) + echo "${URL}/${ISO} ${HASH}" +} + +function get_slackware() { + local HASH="" + local ISO="slackware64-${RELEASE}-install-dvd.iso" + local URL="https://slackware.nl/slackware/slackware-iso/slackware64-${RELEASE}-iso" + HASH=$(wget -q -O- "${URL}/${ISO}.md5" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_slitaz() { + local HASH="" + local ISO="slitaz-rolling-${RELEASE}" + local URL="http://mirror.slitaz.org/iso/rolling" + case ${RELEASE} in + preferred) ISO="slitaz-rolling";; + *) ISO="slitaz-rolling-${RELEASE}";; + esac + HASH=$(wget -q -O- "${URL}/${ISO}.md5" | cut -d' ' -f1) + echo "${URL}/${ISO}.iso ${HASH}" +} + +function get_solus() { + local EDITION="${1:-}" + local HASH="" + local ISO="Solus-${RELEASE}-${EDITION}.iso" + local URL="https://mirrors.rit.edu/solus/images/${RELEASE}" + HASH=$(wget -q -O- "${URL}/${ISO}.sha256sum" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_steamos() { + local HASH="" + local DATE="20221211" + local ISO="HoloISO_${RELEASE}_OfflineInstaller-${DATE}_1636-x86_64.iso" + local URL="http://holoiso.itsvixano.me" + HASH=$(wget -q -O- "${URL}/${ISO}.sha256sum" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_tails() { + local ISO="" + local JSON="" + local HASH="" + local URL="" + JSON="$(wget -q -O- "https://tails.boum.org/install/v2/Tails/amd64/${RELEASE}/latest.json")" + URL=$(echo "${JSON}" | jq -r '.installations[0]."installation-paths"[]|select(.type=="iso")|."target-files"[0].url') + HASH=$(echo "${JSON}" | jq -r '.installations[0]."installation-paths"[]|select(.type=="iso")|."target-files"[0].sha256') + echo "${URL} ${HASH}" +} + +function get_truenas-scale() { + local ISO="" + local URL="" + local DLINFO="https://www.truenas.com/download-truenas-scale/" + URL=$(wget -q ${DLINFO} -O- | grep -o "\"https://.*${RELEASE}.*\.iso\""|cut -d\" -f2) + HASH=$(wget -q ${URL}.sha256 -O- | cut -d' ' -f1 ) + echo "${URL} ${HASH}" +} + +function get_truenas-core() { + local ISO="" + local URL="" + local DLINFO="https://www.truenas.com/download-truenas-core/" + URL=$(wget -q ${DLINFO} -O- | grep -o "\"https://.*${RELEASE}.*\.iso\""|cut -d\" -f2) + HASH=$(wget -q ${URL}.sha256 -O- | cut -d' ' -f1) + echo "${URL} ${HASH}" +} + +function get_ubuntu() { + local ISO="" + local HASH="" + local URL="" + if [[ "${RELEASE}" == *"daily"* ]] && [ "${OS}" == "ubuntustudio" ]; then + # Ubuntu Studio daily-live images are in the dvd directory + RELEASE="dvd" + elif [ "${RELEASE}" == "daily-canary" ] && [ "${OS}" != "ubuntu" ]; then + # daily-canary is only available for Ubuntu, switch flavours to daily-live + RELEASE="daily-live" + fi + if [[ "${RELEASE}" == "eol-"* ]]; then + URL="https://old-releases.ubuntu.com/releases/${RELEASE/eol-/}" + elif [[ "${RELEASE}" == "jammy-daily" ]]; then + URL="https://cdimage.ubuntu.com/${OS}/jammy/daily-live/current" + VM_PATH="${OS}-jammy-live" + elif [[ "${RELEASE}" == *"daily"* ]] || [ "${RELEASE}" == "dvd" ]; then + URL="https://cdimage.ubuntu.com/${OS}/${RELEASE}/current" + VM_PATH="${OS}-daily-live" + elif [ "${OS}" == "ubuntu" ]; then + URL="https://releases.ubuntu.com/${RELEASE}" + else + URL="https://cdimage.ubuntu.com/${OS}/releases/${RELEASE}/release" + fi + if wget -q --spider "${URL}/SHA256SUMS"; then + ISO=$(wget -q -O- "${URL}/SHA256SUMS" | grep 'desktop\|dvd\|install' | grep amd64 | grep iso | cut -d'*' -f2) + HASH=$(wget -q -O- "${URL}/SHA256SUMS" | grep 'desktop\|dvd\|install' | grep amd64 | grep iso |cut -d' ' -f1) + else + ISO=$(wget -q -O- "${URL}/MD5SUMS" | grep 'desktop\|dvd\|install' | grep amd64 | grep iso | cut -d' ' -f3) + HASH=$(wget -q -O- "${URL}/MD5SUMS" | grep 'desktop\|dvd\|install' | grep amd64 | grep iso | cut -d' ' -f1) + fi + #echo "${URL}/${ISO} ${HASH}" + if [[ "${RELEASE}" == *"daily"* ]] || [ "${RELEASE}" == "dvd" ]; then + zsync_get "${URL}/${ISO}" "${VM_PATH}" "${OS}-devel.iso" + make_vm_config "${OS}-devel.iso" + else + web_get "${URL}/${ISO}" "${VM_PATH}" + check_hash "${ISO}" "${HASH}" + make_vm_config "${ISO}" + fi +} + +function get_void() { + local DATE="" + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="https://alpha.de.repo.voidlinux.org/live/${RELEASE}" + if [[ "${RELEASE}" == "current" ]]; then + DATE=$(wget -q -O- "${URL}/sha256sum.txt" | head -n1 | cut -d'.' -f1 | cut -d'-' -f4) + case ${EDITION} in + base) ISO="void-live-x86_64-${DATE}-base.iso";; + base-musl) ISO="void-live-x86_64-musl-${DATE}-base.iso";; + xfce) ISO="void-live-x86_64-${DATE}-xfce.iso";; + xfce-musl) ISO="void-live-x86_64-musl-${DATE}-xfce.iso";; + esac + else + case ${EDITION} in + cinnamon) ISO="void-live-x86_64-${RELEASE}-cinnamon.iso";; + cinnamon-musl) ISO="void-live-x86_64-musl-${RELEASE}-cinnamon.iso";; + enlightenment) ISO="void-live-x86_64-${RELEASE}-enlightenment.iso";; + enlightenment-musl) ISO="void-live-x86_64-musl-${RELEASE}-enlightenment.iso";; + gnome) ISO="void-live-x86_64-${RELEASE}-gnome.iso";; + gnome-musl) ISO="void-live-x86_64-musl-${RELEASE}-gnome.iso";; + lxde) ISO="void-live-x86_64-${RELEASE}-lxde.iso";; + lxde-musl) ISO="void-live-x86_64-musl-${RELEASE}-lxde.iso";; + lxqt) ISO="void-live-x86_64-${RELEASE}-lxqt.iso";; + lxqt-musl) ISO="void-live-x86_64-musl-${RELEASE}-lxqt.iso";; + mate) ISO="void-live-x86_64-${RELEASE}-mate.iso";; + mate-musl) ISO="void-live-x86_64-musl-${RELEASE}-mate.iso";; + xfce) ISO="void-live-x86_64-${RELEASE}-xfce.iso";; + xfce-musl) ISO="void-live-x86_64-musl-${RELEASE}-xfce.iso";; + base) ISO="void-live-x86_64-${RELEASE}.iso";; + base-musl) ISO="void-live-x86_64-musl-${RELEASE}.iso";; + esac + fi + HASH="$(wget -q -O- "${URL}/sha256sum.txt" | grep "${ISO}" | cut -d' ' -f4)" + echo "${URL}/${ISO} ${HASH}" +} + +function get_voidpup() { + local HASH="" + local URL="" + local TMPURL="" + TMPURL=$(wget -q -S -O- --max-redirect=0 "https://sourceforge.net/projects/vpup/files/latest/download" 2>&1 | grep -i Location | cut -d' ' -f4) + URL=${TMPURL%\?*} + echo "${URL} ${HASH}" +} + +function get_vxlinux() { + local HASH="" + local ISO="" + local URL="https://github.com/dessington/vx-linux/releases/download/${RELEASE}" + + if [ "$RELEASE" == "4.0" ]; then + ISO="vx-linux-4.0-qt.iso" + else + ISO="vx-linux-${RELEASE}.iso" + fi + echo "${URL}/${ISO} ${HASH}" +} + +function get_xerolinux() { + local HASH="" + local URL="" + local ISO="xerolinux-2022.12-x86_64.iso" + local URL="https://sourceforge.net/projects/xerolinux/files/Releases" + HASH=$(wget -q -O- "${URL}/${ISO}.sha256" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_zorin() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="" + # Parse out the iso URL from the redirector + URL=$(wget -q -S -O- --max-redirect=0 "https://zrn.co/${RELEASE}${EDITION}" 2>&1 | grep Location | cut -d' ' -f4) + echo "${URL} ${HASH}" +} + +create_vm() { + # shellcheck disable=SC2206 + local URL_HASH=(${1// / }) + local URL="${URL_HASH[0]}" + local HASH="${URL_HASH[1]}" + local ISO="${URL##*/}" + #echo "${URL}" + #echo "${ISO}" + #echo "${HASH}" + web_get "${URL}" "${VM_PATH}" + if [ -n "${HASH}" ]; then + check_hash "${ISO}" "${HASH}" + fi + if [ ${OS} == "freedos" ] && [[ $ISO =~ ".zip" ]]; then + unzip ${VM_PATH}/${ISO} -d ${VM_PATH} + ISO=$(ls ${VM_PATH} | grep -i '.iso') + fi + if [[ ${OS} == "batocera" ]] && [[ ${ISO} =~ ".gz" ]]; then + gzip -d "${VM_PATH}/${ISO}" + ISO="${ISO/.gz/}" + fi + if [ ${OS} == "dietpi" ] && [[ $ISO =~ ".7z" ]]; then + 7zip x -o${VM_PATH} ${VM_PATH}/${ISO} + ISO=$(ls ${VM_PATH} | grep -i '.iso') + fi + if [ ${OS} == "reactos" ] && [[ $ISO =~ ".zip" ]]; then + unzip ${VM_PATH}/${ISO} -d ${VM_PATH} + ISO=$(ls ${VM_PATH} | grep -i '.iso' | grep -v '.zip') + fi + make_vm_config "${ISO}" +} + +trap cleanup EXIT + +if ((BASH_VERSINFO[0] < 4)); then + echo "Sorry, you need bash 4.0 or newer to run this script." + exit 1 +fi +if [ -n "${1}" ]; then + OS="${1,,}" + if [ "${OS}" == "list" ] || [ "${OS}" == "list_csv" ]; then + list_csv + elif [ "${OS}" == "list_json" ]; then + list_json + elif [ "${OS}" == "--version" ] || [ "${OS}" == "-version" ] || [ "${OS}" == "version" ]; then + WHERE=$(dirname "${BASH_SOURCE[0]}") + "${WHERE}/quickemu" --version + exit 0 + fi +else + echo "ERROR! You must specify an operating system." + echo -n " - Operating Systems: " + os_support + exit 1 +fi +if [[ ! $(os_support) =~ ${OS} ]]; then + echo -e "ERROR! ${OS} is not a supported OS.\n" + os_support + exit 1 +fi +if [ -n "${2}" ]; then + RELEASE="${2,,}" + VM_PATH="${OS}-${RELEASE}" + # If the OS has an editions_() function, use it. + if [[ $(type -t "editions_${OS}") == function ]]; then + EDITIONS=($(editions_${OS})) + EDITION=${EDITIONS[0]} + if [ -n "${3}" ]; then + EDITION="${3}" + if [[ ! ${EDITIONS[*]} =~ ${EDITION} ]]; then + echo -e "ERROR! ${EDITION} is not a supported $(pretty_name "${OS}") edition:\n" + for EDITION in "${EDITIONS[@]}"; do + echo -n "${EDITION} " + done + exit 1 + fi + fi + # Handle odd missing fedora cominations + if [[ $OS == fedora ]] ; then + if [[ ${RELEASE} = "33" && ${EDITION} = "i3" ]] || [[ ${RELEASE} = "34" && ${EDITION} = "Cinnamon" ]] ; then + echo "ERROR! Unsupported combination" + echo " Fedora 33 i3 and Fedora 34 Cinnamon are not available, please choose another Release or Edition" + exit 1; + fi + fi + # Handle odd missing dietpi cominations + if [[ $OS == dietpi ]] ; then + if [[ ${RELEASE} = "uefi" && ${EDITION} = "bookworm" ]] || [[ ${RELEASE} = "uefi" && ${EDITION} = "bullseye" ]] ; then + echo "ERROR! Unsupported combination" + echo "Only installers are supported for uefi, please choose another Release or Edition" + exit 1; + fi + fi + # Handle void missing edition + case "${RELEASE}-${EDITION}" in + "20170220-gnome"|"20170220-gnome-musl") + echo "ERROR! Unsupported combination" + echo "Posible editions are: base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl lxde lxde-musl lxqt lxqt-musl mate mate-musl xfce xfce-musl" + exit 1; + ;; + "20170825-gnome"|"20170825-gnome-musl"|"20170825-enlightenment"|"20170825-enlightenment-musl"|"20170825-lxqt"|"20170825-lxqt-musl"|"20170825-base"|"20170825-mate-musl"|"20170825-lxde"|"20170825-lxde-musl"|"20170825-cinnamon"|"20170825-cinnamon-musl"|"20170825-xfce"|"20170825-xfce-musl"|"20170825-base-musl") + echo "ERROR! Unsupported combination" + echo "Only one possible edition: mate" + exit 1; + ;; + "20171007-gnome"|"20171007-gnome-musl") + echo "ERROR! Unsupported combination" + echo "Posible editions are: base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl lxde lxde-musl lxqt lxqt-musl mate mate-musl xfce xfce-musl" + exit 1; + ;; + "20181111-gnome"|"20181111-gnome-musl") + echo "ERROR! Unsupported combination" + echo "Posible editions are: base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl lxde lxde-musl lxqt lxqt-musl mate mate-musl xfce xfce-musl" + exit 1; + ;; + "20190217-gnome"|"20190217-gnome-musl") + echo "ERROR! Unsupported combination" + echo "Posible editions are: base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl lxde lxde-musl lxqt lxqt-musl mate mate-musl xfce xfce-musl" + exit 1; + ;; + "20190526-gnome"|"20190526-gnome-musl"|"20190526-enlightenment"|"20190526-enlightenment-musl"|"20190526-lxqt"|"20190526-lxqt-musl"|"20190526-mate"|"20190526-mate-musl") + echo "ERROR! Unsupported combination" + echo "Posible editions are only: base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl lxde lxde-musl lxqt lxqt-musl" + exit 1; + ;; + "20191109:gnome"|"20191109:gnome-musl") + echo "ERROR! Unsupported combination" + echo "Possible editions are: base base-musl cinnamon cinnamon-musl enlightenment enlightenment-musl lxde lxde-musl lxqt lxqt-musl mate mate-musl xfce xfce-musl" + exit 1 + ;; + "20210316:gnome"|"20210316:gnome-musl"|"20210316:enlightenment"|"20210316:enlightenment-musl"|"20210316:lxqt"|"20210316:lxqt-musl"|"20210316:mate"|"20210316:mate-musl") + echo "ERROR! Unsupported combination" + echo "Possible editions are only: base base-musl cinnamon cinnamon-musl lxde lxde-musl xfce xfce-musl" + exit 1 + ;; + "20210930:gnome"|"20210930:gnome-musl"|"20210930:enlightenment"|"20210930:enlightenment-musl"|"20210930:lxqt"|"20210930:lxqt-musl"|"20210930:mate"|"20210930:mate-musl"|"20210930:lxde"|"20210930:lxde-musl"|"20210930:cinnamon"|"20210930:cinnamon-musl") + echo "ERROR! Unsupported combination" + echo "Possible editions are only: base base-musl xfce xfce-musl" + exit 1 + ;; + "20221001:gnome"|"20221001:gnome-musl"|"20221001:enlightenment"|"20221001:enlightenment-musl"|"20221001:lxqt"|"20221001:lxqt-musl"|"20221001:mate"|"20221001:mate-musl"|"20221001:lxde"|"20221001:lxde-musl"|"20221001:cinnamon"|"20221001:cinnamon-musl") + echo "ERROR! Unsupported combination" + echo "Possible editions are only: base base-musl xfce xfce-musl" + exit 1 + ;; + "current:gnome"|"current:gnome-musl"|"current:enlightenment"|"current:enlightenment-musl"|"current:lxqt"|"current:lxqt-musl"|"current:mate"|"current:mate-musl"|"current:lxde"|"current:lxde-musl"|"current:cinnamon"|"current:cinnamon-musl") + echo "ERROR! Unsupported combination" + echo "Possible editions are only: base base-musl xfce xfce-musl" + exit 1 + ;; + esac + VM_PATH="${OS}-${RELEASE}-${EDITION}" + validate_release "releases_${OS}" + create_vm "$("get_${OS}" "${EDITION}")" + elif [[ "${OS}" == *"ubuntu"* ]]; then + # Ubuntu doesn't use create_vm() + validate_release releases_ubuntu + get_ubuntu + elif [[ "${OS}" == *"deepin"* ]]; then + # deepin doesn't use create_vm() + validate_release releases_deepin + get_deepin + else + validate_release "releases_${OS}" + create_vm "$("get_${OS}")" + fi +else + echo "ERROR! You must specify a release." + case ${OS} in + *ubuntu*) + echo -n " - Releases: " + releases_ubuntu | sed -Ee 's/eol-\S+//g' # hide eol releases + ;; + *) + echo -n " - Releases: " + releases_"${OS}" + if [[ $(type -t "editions_${OS}") == function ]]; then + echo -n " - Editions: " + editions_"${OS}" + fi + ;; + esac + exit 1 +fi + +# vim:tabstop=4:shiftwidth=4:expandtab diff --git a/quickgui b/quickgui new file mode 100755 index 0000000..6bdebbb --- /dev/null +++ b/quickgui @@ -0,0 +1,112 @@ +#!/bin/bash + +# DEBUG mod +#bash -x quickyad 2>&1 | tee output.log + +# YAD gui script for excellent quickemu +#TODO Download Icons +#TODO Add homepages to right click + +echo "Running..." +# dependencies checks +if ! command -v yad >/dev/null 2>&1; then + echo "You are missing yad..." >&2 + exit 1 +fi +if ! command -v quickemu >/dev/null 2>&1; then + echo "You are missing quickemu..." >&2 + exit 1 +fi +# generate random key for yad (for connecting tabs in notebook together) +key=$((RANDOM % 9000 + 1000)) +# set current dir as QUICKEMU_VMS_DIR +#QUICKEMU_VMS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" +# set default directories +QUICKEMU_VMS_DIR="$HOME/.local/share/quickemu" +CONFIG_DIR="$HOME/.config/quickemu" +ICON_DIR="$CONFIG_DIR/vms_icons" +TERMINAL=sakura +replace='"!"' +export "QUICKEMU_VMS_DIR" "CONFIG_DIR" "ICON_DIR" +# create default dirs if they are not present +mkdir -p "$CONFIG_DIR" "$CONFIG_DIR/vms_ready" "$CONFIG_DIR/vms_supported" +# remove desktop files (ready to run VMs) +rm "$CONFIG_DIR"/vms_ready/* +# Enter quickemu VMs dir +cd "$QUICKEMU_VMS_DIR" || exit +# check for VMs .conf files (ready to run VMs) +for vm_config_file in *.conf; do + vm_desktop_file=$(basename "$QUICKEMU_VMS_DIR/$vm_config_file" .conf) + # Use fuzzy matching to find the best matching icon file (ready to run VMs) + icon_name=$(basename "$QUICKEMU_VMS_DIR/$vm_config_file" .conf | cut -d'-' -f -2) + icon_file=$(find "$ICON_DIR" -type f -iname "${icon_name// /}.*") + # If no icon was found, try shorter name (ready to run VMs) + if [ -z "$icon_file" ]; then + icon_name=$(basename "$QUICKEMU_VMS_DIR/$vm_config_file" .conf | cut -d'-' -f1) + icon_file=$(find "$ICON_DIR" -type f -iname "${icon_name// /}.*") + fi + # If no icon was found, use a default icon (ready to run VMs) + if [ -z "$icon_file" ]; then + icon_file="$ICON_DIR/tux.svg" + fi + # content of desktop files (ready to run VMs) + desktop_file_content="[Desktop Entry] +Type=Application +Name=$vm_desktop_file +Exec=quickemu -vm \"$vm_config_file\" +Icon=$icon_file +Categories=System;Virtualization;" + # create desktop files (ready to run VMs) + echo "$desktop_file_content" > "$CONFIG_DIR"/vms_ready/"$vm_desktop_file".desktop +done + +# remove desktop files (supported VMs) +rm "$CONFIG_DIR"/vms_supported/* +# get supported VMs +quickget | sed 1d | cut -d':' -f2 | grep -o '[^ ]*' > "$CONFIG_DIR/supported.txt" +while read -r get_name; do + vm_desktop_file=$(echo "$get_name" | tr ' ' '_') + releases=$(quickget "$vm_desktop_file" | grep 'Releases' | cut -d':' -f2 | sed 's/^ //') + editions=$(quickget "$vm_desktop_file" | grep 'Editions' | cut -d':' -f2 | sed 's/^ //') + icon_name="$ICON_DIR/$get_name" + if [ -f "$icon_name.svg" ]; then + icon_file="$icon_name.svg" + elif [ -f "$icon_name.png" ]; then + icon_file="$icon_name.png" + else + icon_file="$ICON_DIR/tux.svg" + fi + # Check if there are editions + if [ -z "$editions" ]; then + # Create desktop file for VMs without editions + desktop_file_content="[Desktop Entry] +Type=Application +Name=$get_name +releases=$releases +replace='\"!\"' +Exec=sh -c 'cd $QUICKEMU_VMS_DIR && yad --form --separator=\" \" --field=\"Release:CB\" \"${releases// /$replace}\" | xargs -I{} $TERMINAL -e \"quickget $get_name {}\"' +Icon=$icon_file +Categories=System;Virtualization;" + echo "$desktop_file_content" > "$CONFIG_DIR"/vms_supported/"$vm_desktop_file".desktop + else + # Create desktop file for VMs with editions + desktop_file_content="[Desktop Entry] +Type=Application +Name=$get_name +releases=$releases +editions=$editions +replace=$replace +Exec=sh -c 'cd $QUICKEMU_VMS_DIR && yad --form --separator=\" \" --field=\"Release:CB\" \"${releases// /$replace}\" --field=\"Edition:CB\" \"${editions// /$replace}\" | xargs -I{} $TERMINAL -e \"quickget $get_name {}\"' +Icon=$icon_file +Categories=System;Virtualization;" + echo "$desktop_file_content" > "$CONFIG_DIR"/vms_supported/"$vm_desktop_file".desktop + fi +done < "$CONFIG_DIR"/supported.txt + +# show YAD notebook +yad --plug="$key" --tabnum=1 --icons --listen --read-dir="$CONFIG_DIR"/vms_ready --sort-by-name --no-buttons --borders=0 --icon-size=48 --item-width=76 & +yad --plug="$key" --tabnum=2 --icons --listen --read-dir="$CONFIG_DIR"/vms_supported --sort-by-name --no-buttons --borders=0 --icon-size=48 --item-width=76 & +yad --plug="$key" --tabnum=3 --icons --listen --read-dir="$CONFIG_DIR" --sort-by-name --no-buttons --borders=0 --icon-size=48 --item-width=76 & +yad --dynamic --notebook --key="$key" --width=900 --height=800 --title="GUI for Quickemu" --listen --no-buttons --tab="run VM" --tab="download and run VM" --tab="settings" +# exit peacfully +exit 0 diff --git a/quicktui b/quicktui new file mode 100755 index 0000000..c2f0e73 --- /dev/null +++ b/quicktui @@ -0,0 +1,96 @@ +#!/usr/bin/bash + +# Author: zenobit +# Description: Uses fzf to provide a simple GUI for quickemu and quickget +# script must be in same directory as quickget and quickemu! +# License MIT + +# Define variables +progname="${progname:="${0##*/}"}" +version="0.21" +vms=(*.conf) + +# Set traps to catch the signals and exit gracefully +trap "exit" INT +trap "exit" EXIT + +# Dependency check: check if fzf is installed and can be executed +if ! command -v fzf >/dev/null 2>&1; then + echo "You are missing fzf..." && exit 255 +fi +# Dispaly version and prepared VMs +#printf " $progname: $version\n quickemu: $(quickemu --version)\n\n Prepared VMs:\n-------------\n" +printf '%s: v.%s\nquickemu: v.%s\n\n Work dir.: %s\n\n Prepared VMs:\n-------------\n' "$progname" "$version" "$(quickemu --version)" "$(pwd)" +# Check if there are any VMs +if [ ${#vms[@]} -eq 0 ]; then + echo "No VMs found." + exit 1 +fi + +# Print the names of the available VMs +printf "%s\n" "${vms[@]%.*}" +echo "-------------" + +# Action prompt +printf " Do you want to create a new VM? (c) + or run an existing one? (press anything)\n" +read -rn 1 -s start +case $start in + c ) + todo="create" + ;; +esac + +# If the user chose to create a new VM +if [ "$todo" = "create" ]; then + os=$(quickget | sed 1d | cut -d':' -f2 | grep -o '[^ ]*' | fzf --cycle --header='Choose OS to download + or CTRL-c or ESC to quit') + # If the OS is Windows + if [ "$os" = windows ]; then + answer=$(echo "Default English +Choose other language" | fzf --cycle) + # If the user wants another windows language + if [ "$answer" = "Choose other language" ]; then + wrelease=$(echo "8 +10 +11" | fzf --cycle) + # get window language list + wlend=$(($(cat quickget | sed '/Arabic/,$!d' | grep -n '}' | cut -d':' -f1 | head -n 1) - 1)) + # get windows language + wlang=$(cat quickget | sed '/Arabic/,$!d' | head -n $wlend | cut -d'=' -f2 | tail -c +2 | head -c -2 | sed 's/^[ \t]*//' | fzf --cycle --header='Choose Language + or CTRL-c or ESC to quit') + # downloading windows + printf '\n Trying to download Windows %s %s...\n\n' "$wrelease" "$wlang" + quickget "windows" "$wrelease" "$wlang" + fi + fi + # Get the release and edition to download, if necessary + choices=$(quickget "$os" | sed 1d) + if [ "$(echo "$choices" | wc -l)" = 1 ]; then + # get release + release=$(echo "$choices" | grep 'Releases' | cut -d':' -f2 | grep -o '[^ ]*' | fzf --cycle --header='Choose Release + or CTRL-c or ESC to quit') + # downloading + printf '\n Trying to download %s %s...\n\n' "$os" "$release" + quickget "$os" "$release" + else + # get release + release=$(echo "$choices" | grep 'Releases' | cut -d':' -f2 | grep -o '[^ ]*' | fzf --cycle --header='Choose Release + or CTRL-c or ESC to quit') + # get edition + edition=$(echo "$choices" | grep 'Editions' | cut -d':' -f2 | grep -o '[^ ]*' | fzf --cycle --header='Choose Edition + or CTRL-c or ESC to quit') + # downloading + printf '\n Trying to download %s %s %s...\n\n' "$os" "$release" "$edition" + quickget "$os" "$release" "$edition" + fi +fi +# choose VM to run +choosed=$(echo "$(ls *.conf 2>/dev/null | sed 's/\.conf$//')" | fzf --cycle --header='Choose VM to run + or CTRL-c or ESC to quit') + +# Run choosed VM +printf '\n Starting %s...\n\n' "$choosed" +quickemu -vm "$choosed.conf" + +exit 0 diff --git a/untitled b/untitled new file mode 100644 index 0000000..2c45f66 --- /dev/null +++ b/untitled @@ -0,0 +1,18 @@ +#!/bin/bash + +# YAD gui script for creating YAD graphical user interfaces +# This version use desktop files and notebook + +# set app name + +# + +# create tab + +# create desktop file + +# create notebook logic + +# test script + +exit 0 diff --git a/yadEmu.png b/yadEmu.png new file mode 100644 index 0000000..e8cb084 Binary files /dev/null and b/yadEmu.png differ