From c3bd9eb1955888cd1bffd5159c879911be4279f1 Mon Sep 17 00:00:00 2001 From: zenobit Date: Fri, 17 Nov 2023 14:35:57 +0100 Subject: [PATCH] merge upstream and other changes added sparky linux added bazzite --- docs/Makefile | 42 ++ docs/pandoc-man.mk | 8 + docs/quickemu.1 | 1037 ++++++++++++++++++++++++++++++++++++++ docs/quickemu.1.md | 735 +++++++++++++++++++++++++++ docs/quickemu_conf.1 | 327 ++++++++++++ docs/quickemu_conf.1.md | 299 +++++++++++ docs/quickget.1 | 632 +++++++++++++++++++++++ docs/quickget.1.md | 431 ++++++++++++++++ quickemu | 27 +- quickget | 1064 ++++++++++++++++++++++++++++----------- 10 files changed, 4293 insertions(+), 309 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/pandoc-man.mk create mode 100644 docs/quickemu.1 create mode 100644 docs/quickemu.1.md create mode 100644 docs/quickemu_conf.1 create mode 100644 docs/quickemu_conf.1.md create mode 100644 docs/quickget.1 create mode 100644 docs/quickget.1.md 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..cca5e0b --- /dev/null +++ b/docs/quickemu.1 @@ -0,0 +1,1037 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" 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" "November 17, 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-disk\f[R] +Delete the disk image. +.TP +\f[B]\[en]display\f[R] +Select display backend. +`sdl' (default), `gtk', `none', `spice' or `spice-app' +.TP +\f[B]\[en]sound-card\f[R] +Select virtual audio emulation. +`intel-hda' (default), `ac97' (solaris default), `es1370', `sb16' +(freedos default) or `none' +.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] 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 (and direct derivatives such as MX Linux): +.IP +.nf +\f[C] +sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 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]edubuntu\f[R] (Edubuntu) +.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]ubuntucinnamon\f[R] (Ubuntu Cinnamon) +.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) +.PP +You can also use \f[V]quickget\f[R] with options to: +.IP +.nf +\f[C] + # show an OS ISO download URL for {os} {release} [edition] + quickget --show-iso-url fedora 38 Silverblue + # test if and OS ISO is available for {os} {release} [edition] + quickget --test-iso-url nixos 23.05 plasma5 + # open an OS distribution homepage in a browser + quickget --open-distro-homepage ubuntu-mate +\f[R] +.fi +.PP +The \f[V]--show-iso-url\f[R] and \f[V]--test-iso-url\f[R] options +\f[B]do not\f[R] work for \f[V]Windows\f[R] (\f[V]quickget\f[R] will +begin downloading the requested release and edition of windows) +.SS Other Operating Systems +.PP +\f[V]quickget\f[R] also supports: +.IP \[bu] 2 +\f[V]agarimos\f[R] (AgarimOS) +.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]antix\f[R] (Antix) +.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]artixlinux\f[R] (Artix Linux) +.IP \[bu] 2 +\f[V]athenaos\f[R] (Athenaos) +.IP \[bu] 2 +\f[V]batocera\f[R] (Batocera) +.IP \[bu] 2 +\f[V]bazzite\f[R] (Bazzite) +.IP \[bu] 2 +\f[V]biglinux\f[R] (BigLinux) +.IP \[bu] 2 +\f[V]blendos\f[R] (BlendOS) +.IP \[bu] 2 +\f[V]bodhi\f[R] (Bodhi Linux) +.IP \[bu] 2 +\f[V]bunsenlabs\f[R] (Bunsenlabs) +.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]cereus\f[R] (Cereus Linux) +.IP \[bu] 2 +\f[V]chimera\f[R] (Chimera Linux) +.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]dietpi\f[R] (DietPi) +.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]endless\f[R] (Endless OS) +.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]fvoid\f[R] (F-Void) +.IP \[bu] 2 +\f[V]gabeeos\f[R] (gabeeOS Linux) +.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]holoiso\f[R] (Steam OS HoloISO) +.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]linuxlite\f[R] (Linux Lite) +.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]miyolinux\f[R] (Miyo Linux) +.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]openindiana\f[R] (OpenIndiana) +.IP \[bu] 2 +\f[V]opensuse\f[R] (openSUSE) +.IP \[bu] 2 +\f[V]oraclelinux\f[R] (Oracle Linux) +.IP \[bu] 2 +\f[V]peppermint\f[R] (PeppermintOS) +.IP \[bu] 2 +\f[V]popos\f[R] (Pop!_OS) +.IP \[bu] 2 +\f[V]porteus\f[R] (Porteus) +.IP \[bu] 2 +\f[V]pureos\f[R] (PureOS) +.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]siduction\f[R] (Siduction) +.IP \[bu] 2 +\f[V]slackware\f[R] (Slackware) +.IP \[bu] 2 +\f[V]slax\f[R] (Slax) +.IP \[bu] 2 +\f[V]slitaz\f[R] (SliTaz GNU/Linux) +.IP \[bu] 2 +\f[V]solus\f[R] (Solus) +.IP \[bu] 2 +\f[V]sparkylinux\f[R] (SparkyLinux) +.IP \[bu] 2 +\f[V]spiral\f[R] (SpiralLinux) +.IP \[bu] 2 +\f[V]tails\f[R] (Tails) +.IP \[bu] 2 +\f[V]tinycore\f[R] (Tiny Core Linux) +.IP \[bu] 2 +\f[V]trisquel\f[R] (Trisquel) +.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]tuxedoos\f[R] (TuxedoOS) +.IP \[bu] 2 +\f[V]vanillaos\f[R] (Vanilla OS) +.IP \[bu] 2 +\f[V]ventoy\f[R] (Ventoy) +.IP \[bu] 2 +\f[V]voidpup\f[R] (Void Puppy) +.IP \[bu] 2 +\f[V]void\f[R] (Void Linux) +.IP \[bu] 2 +\f[V]vxlinux\f[R] (VX Linux) +.IP \[bu] 2 +\f[V]xerolinux\f[R] (XeroLinux) +.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], \f[V]monterey\f[R] and \f[V]ventura\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 (on +Big Sur and above use \f[V]Apple Inc. VirtIO Block Device\f[R]) 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, Monterey +and Ventura), 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 +.IP \[bu] 2 +Ventura +.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 8, 10 & 11 Guests +.PP +\f[V]quickget\f[R] can download +Windows10 (https://www.microsoft.com/software-download/windows10) and +Windows 11 (https://www.microsoft.com/software-download/windows11) +automatically and create an optimised virtual machine configuration. +This configuration also includes the VirtIO drivers for +Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). +.PP +Windows 8.1 is also supported but doesn\[cq]t feature any automated +installation or driver optimisation. +.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 administrator 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]off\[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 + --access : Enable remote spice access support. \[aq]local\[aq] (default), \[aq]remote\[aq], \[aq]clientipaddress\[aq] + --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. + --screenpct : Percent of fullscreen for VM if --fullscreen is not specified. + --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] + --sound-card : Set sound card. \[at]Options: \[aq]intel-hda\[aq] (default), \[aq]ac97\[aq], \[aq]es1370\[aq], \[aq]sb16\[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. +.PP +The `\[en]screenpct' is an optional integer value between 25 <= pct < +100 which will override system default screen sizes. +The VM size will be `pct' of the chosen screen. +\f[B]If \[en]fullscreen is chosen screen will be fullsize instead of +being scaled down by \[en]screenpct value.\f[R] +.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..db537c8 --- /dev/null +++ b/docs/quickemu.1.md @@ -0,0 +1,735 @@ +--- +author: Martin Wimpress +date: November 17, 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-disk** +: Delete the disk image. + +**--display** +: Select display backend. 'sdl' (default), 'gtk', 'none', 'spice' or + 'spice-app' + +**--sound-card** +: Select virtual audio emulation. 'intel-hda' (default), 'ac97' + (solaris default), 'es1370', 'sb16' (freedos default) or 'none' + +**--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** 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 (and direct derivatives such as MX Linux): + + sudo apt install qemu bash coreutils ovmf grep jq lsb-base procps python3 genisoimage usbutils util-linux sed spice-client-gtk libtss2-tcti-swtpm0 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. + +- `edubuntu` (Edubuntu) +- `kubuntu` (Kubuntu) +- `lubuntu` (Lubuntu) +- `ubuntu-budgie` (Ubuntu Budgie) +- `ubuntucinnamon` (Ubuntu Cinnamon) +- `ubuntukylin` (Ubuntu Kylin) +- `ubuntu-mate` (Ubuntu MATE) +- `ubuntustudio` (Ubuntu Studio) +- `ubuntu` (Ubuntu) +- `ubuntu-unity` (Ubuntu Unity) +- `xubuntu` (Xubuntu) + +You can also use `quickget` with options to: + +``` shell + # show an OS ISO download URL for {os} {release} [edition] + quickget --show-iso-url fedora 38 Silverblue + # test if and OS ISO is available for {os} {release} [edition] + quickget --test-iso-url nixos 23.05 plasma5 + # open an OS distribution homepage in a browser + quickget --open-distro-homepage ubuntu-mate +``` + +The `--show-iso-url` and `--test-iso-url` options **do not** work for +`Windows` (`quickget` will begin downloading the requested release and +edition of windows) + +## Other Operating Systems + +`quickget` also supports: + +- `agarimos` (AgarimOS) +- `alma` (Alma Linux) +- `alpine` (Alpine Linux) +- `android` (Android x86) +- `antix` (Antix) +- `archcraft` (Archcraft) +- `archlinux` (Arch Linux) +- `arcolinux` (Arco Linux) +- `artixlinux` (Artix Linux) +- `athenaos` (Athenaos) +- `batocera` (Batocera) +- `bazzite` (Bazzite) +- `biglinux` (BigLinux) +- `blendos` (BlendOS) +- `bodhi` (Bodhi Linux) +- `bunsenlabs` (Bunsenlabs) +- `cachyos` (CachyOS) +- `centos-stream` (CentOS Stream) +- `cereus` (Cereus Linux) +- `chimera` (Chimera Linux) +- `debian` (Debian) +- `deepin` (Deepin) +- `devuan` (Devuan) +- `dietpi` (DietPi) +- `dragonflybsd` (DragonFlyBSD) +- `elementary` (elementary OS) +- `endeavouros` (EndeavourOS) +- `endless` (Endless OS) +- `fedora` (Fedora) +- `freebsd` (FreeBSD) +- `freedos` (FreeDOS) +- `fvoid` (F-Void) +- `gabeeos` (gabeeOS Linux) +- `garuda` (Garuda Linux) +- `gentoo` (Gentoo) +- `ghostbsd` (GhostBSD) +- `haiku` (Haiku) +- `holoiso` (Steam OS HoloISO) +- `kali` (Kali) +- `kdeneon` (KDE Neon) +- `kolibrios` (KolibriOS) +- `linuxlite` (Linux Lite) +- `linuxmint` (Linux Mint) +- `lmde` (Linux Mint Debian Edition) +- `mageia` (Mageia) +- `manjaro` (Manjaro) +- `miyolinux` (Miyo Linux) +- `mxlinux` (MX Linux) +- `netboot` (netboot.xyz) +- `netbsd` (NetBSD) +- `nixos` (NixOS) +- `openbsd` (OpenBSD) +- `openindiana` (OpenIndiana) +- `opensuse` (openSUSE) +- `oraclelinux` (Oracle Linux) +- `peppermint` (PeppermintOS) +- `popos` (Pop!\_OS) +- `porteus` (Porteus) +- `pureos` (PureOS) +- `reactos` (ReactOS) +- `rebornos` (RebornOS) +- `rockylinux` (Rocky Linux) +- `siduction` (Siduction) +- `slackware` (Slackware) +- `slax` (Slax) +- `slitaz` (SliTaz GNU/Linux) +- `solus` (Solus) +- `sparkylinux` (SparkyLinux) +- `spiral` (SpiralLinux) +- `tails` (Tails) +- `tinycore` (Tiny Core Linux) +- `trisquel` (Trisquel) +- `truenas-core` (TrueNAS Core) +- `truenas-scale` (TrueNAS Scale) +- `tuxedoos` (TuxedoOS) +- `vanillaos` (Vanilla OS) +- `ventoy` (Ventoy) +- `voidpup` (Void Puppy) +- `void` (Void Linux) +- `vxlinux` (VX Linux) +- `xerolinux` (XeroLinux) +- `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`, `monterey` and +`ventura` 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 (on + Big Sur and above use `Apple Inc. VirtIO Block Device`) and + click **Erase**. + - Enter a `Name:` for the disk + - If you are installing macOS Mojave or later (Catalina, Big + Sur, Monterey and Ventura), 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 + - Ventura +- `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 8, 10 & 11 Guests + +`quickget` can download +[Windows10](https://www.microsoft.com/software-download/windows10) and +[Windows 11](https://www.microsoft.com/software-download/windows11) +automatically and create an optimised virtual machine configuration. +This configuration also includes the [VirtIO drivers for +Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). + +Windows 8.1 is also supported but doesn't feature any automated +installation or driver optimisation. + +``` 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 administrator 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="off" +``` + +- `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 + --access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress' + --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. + --screenpct : Percent of fullscreen for VM if --fullscreen is not specified. + --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' + --sound-card : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', '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. + +The '--screenpct' is an optional integer value between 25 \<= pct \< 100 +which will override system default screen sizes. The VM size will be +'pct' of the chosen screen. **If --fullscreen is chosen screen will be +fullsize instead of being scaled down by --screenpct value.** + +# 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..ac21bd9 --- /dev/null +++ b/docs/quickemu_conf.1 @@ -0,0 +1,327 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" 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" "November 17, 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..db6e8c7 --- /dev/null +++ b/docs/quickemu_conf.1.md @@ -0,0 +1,299 @@ +--- +author: Martin Wimpress +date: November 17, 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..0b07139 --- /dev/null +++ b/docs/quickget.1 @@ -0,0 +1,632 @@ +.\" Automatically generated by Pandoc 2.17.1.1 +.\" +.\" 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" "November 17, 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]\f[VB]--show-iso-url\f[B] | -s\f[R] {\f[B]os\f[R]} {\f[B]release\f[R]} [\f[B]edition\f[R]] +show ISO download URL +.TP +\f[B]\f[VB]--test-iso-url\f[B] | -t\f[R] {\f[B]os\f[R]} {\f[B]release\f[R]} [\f[B]edition\f[R]] +test if ISO is available +.TP +\f[B]\f[VB]--open-distro-homepage\f[B] | -o\f[R] {\f[B]os\f[R]} +open OS homepage in browser +.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]edubuntu\f[R] (Edubuntu) +.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]ubuntucinnamon\f[R] (Ubuntu Cinnamon) +.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) +.PP +You can also use \f[V]quickget\f[R] with options to: +.IP +.nf +\f[C] + # show an OS ISO download URL for {os} {release} [edition] + quickget --show-iso-url fedora 38 Silverblue + # test if and OS ISO is available for {os} {release} [edition] + quickget --test-iso-url nixos 23.05 plasma5 + # open an OS distribution homepage in a browser + quickget --open-distro-homepage ubuntu-mate +\f[R] +.fi +.PP +The \f[V]--show-iso-url\f[R] and \f[V]--test-iso-url\f[R] options +\f[B]do not\f[R] work for \f[V]Windows\f[R] (\f[V]quickget\f[R] will +begin downloading the requested release and edition of windows) +.SS Other Operating Systems +.PP +\f[V]quickget\f[R] also supports: +.IP \[bu] 2 +\f[V]agarimos\f[R] (AgarimOS) +.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]antix\f[R] (Antix) +.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]artixlinux\f[R] (Artix Linux) +.IP \[bu] 2 +\f[V]athenaos\f[R] (Athenaos) +.IP \[bu] 2 +\f[V]batocera\f[R] (Batocera) +.IP \[bu] 2 +\f[V]bazzite\f[R] (Bazzite) +.IP \[bu] 2 +\f[V]biglinux\f[R] (BigLinux) +.IP \[bu] 2 +\f[V]blendos\f[R] (BlendOS) +.IP \[bu] 2 +\f[V]bodhi\f[R] (Bodhi Linux) +.IP \[bu] 2 +\f[V]bunsenlabs\f[R] (Bunsenlabs) +.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]cereus\f[R] (Cereus Linux) +.IP \[bu] 2 +\f[V]chimera\f[R] (Chimera Linux) +.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]dietpi\f[R] (DietPi) +.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]endless\f[R] (Endless OS) +.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]fvoid\f[R] (F-Void) +.IP \[bu] 2 +\f[V]gabeeos\f[R] (gabeeOS Linux) +.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]holoiso\f[R] (Steam OS HoloISO) +.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]linuxlite\f[R] (Linux Lite) +.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]miyolinux\f[R] (Miyo Linux) +.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]openindiana\f[R] (OpenIndiana) +.IP \[bu] 2 +\f[V]opensuse\f[R] (openSUSE) +.IP \[bu] 2 +\f[V]oraclelinux\f[R] (Oracle Linux) +.IP \[bu] 2 +\f[V]peppermint\f[R] (PeppermintOS) +.IP \[bu] 2 +\f[V]popos\f[R] (Pop!_OS) +.IP \[bu] 2 +\f[V]porteus\f[R] (Porteus) +.IP \[bu] 2 +\f[V]pureos\f[R] (PureOS) +.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]siduction\f[R] (Siduction) +.IP \[bu] 2 +\f[V]slackware\f[R] (Slackware) +.IP \[bu] 2 +\f[V]slax\f[R] (Slax) +.IP \[bu] 2 +\f[V]slitaz\f[R] (SliTaz GNU/Linux) +.IP \[bu] 2 +\f[V]solus\f[R] (Solus) +.IP \[bu] 2 +\f[V]sparkylinux\f[R] (SparkyLinux) +.IP \[bu] 2 +\f[V]spiral\f[R] (SpiralLinux) +.IP \[bu] 2 +\f[V]tails\f[R] (Tails) +.IP \[bu] 2 +\f[V]tinycore\f[R] (Tiny Core Linux) +.IP \[bu] 2 +\f[V]trisquel\f[R] (Trisquel) +.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]tuxedoos\f[R] (TuxedoOS) +.IP \[bu] 2 +\f[V]vanillaos\f[R] (Vanilla OS) +.IP \[bu] 2 +\f[V]ventoy\f[R] (Ventoy) +.IP \[bu] 2 +\f[V]voidpup\f[R] (Void Puppy) +.IP \[bu] 2 +\f[V]void\f[R] (Void Linux) +.IP \[bu] 2 +\f[V]vxlinux\f[R] (VX Linux) +.IP \[bu] 2 +\f[V]xerolinux\f[R] (XeroLinux) +.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], \f[V]monterey\f[R] and \f[V]ventura\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 (on +Big Sur and above use \f[V]Apple Inc. VirtIO Block Device\f[R]) 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, Monterey +and Ventura), 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 +.IP \[bu] 2 +Ventura +.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 8, 10 & 11 Guests +.PP +\f[V]quickget\f[R] can download +Windows10 (https://www.microsoft.com/software-download/windows10) and +Windows 11 (https://www.microsoft.com/software-download/windows11) +automatically and create an optimised virtual machine configuration. +This configuration also includes the VirtIO drivers for +Windows (https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). +.PP +Windows 8.1 is also supported but doesn\[cq]t feature any automated +installation or driver optimisation. +.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 administrator 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]off\[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..25f1418 --- /dev/null +++ b/docs/quickget.1.md @@ -0,0 +1,431 @@ +--- +author: Martin Wimpress +date: November 17, 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. + +**`--show-iso-url` \| -s** {**os**} {**release**} \[**edition**\] +: show ISO download URL + +**`--test-iso-url` \| -t** {**os**} {**release**} \[**edition**\] +: test if ISO is available + +**`--open-distro-homepage` \| -o** {**os**} +: open OS homepage in browser + +**\[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. + +- `edubuntu` (Edubuntu) +- `kubuntu` (Kubuntu) +- `lubuntu` (Lubuntu) +- `ubuntu-budgie` (Ubuntu Budgie) +- `ubuntucinnamon` (Ubuntu Cinnamon) +- `ubuntukylin` (Ubuntu Kylin) +- `ubuntu-mate` (Ubuntu MATE) +- `ubuntustudio` (Ubuntu Studio) +- `ubuntu` (Ubuntu) +- `ubuntu-unity` (Ubuntu Unity) +- `xubuntu` (Xubuntu) + +You can also use `quickget` with options to: + +``` shell + # show an OS ISO download URL for {os} {release} [edition] + quickget --show-iso-url fedora 38 Silverblue + # test if and OS ISO is available for {os} {release} [edition] + quickget --test-iso-url nixos 23.05 plasma5 + # open an OS distribution homepage in a browser + quickget --open-distro-homepage ubuntu-mate +``` + +The `--show-iso-url` and `--test-iso-url` options **do not** work for +`Windows` (`quickget` will begin downloading the requested release and +edition of windows) + +## Other Operating Systems + +`quickget` also supports: + +- `agarimos` (AgarimOS) +- `alma` (Alma Linux) +- `alpine` (Alpine Linux) +- `android` (Android x86) +- `antix` (Antix) +- `archcraft` (Archcraft) +- `archlinux` (Arch Linux) +- `arcolinux` (Arco Linux) +- `artixlinux` (Artix Linux) +- `athenaos` (Athenaos) +- `batocera` (Batocera) +- `bazzite` (Bazzite) +- `biglinux` (BigLinux) +- `blendos` (BlendOS) +- `bodhi` (Bodhi Linux) +- `bunsenlabs` (Bunsenlabs) +- `cachyos` (CachyOS) +- `centos-stream` (CentOS Stream) +- `cereus` (Cereus Linux) +- `chimera` (Chimera Linux) +- `debian` (Debian) +- `deepin` (Deepin) +- `devuan` (Devuan) +- `dietpi` (DietPi) +- `dragonflybsd` (DragonFlyBSD) +- `elementary` (elementary OS) +- `endeavouros` (EndeavourOS) +- `endless` (Endless OS) +- `fedora` (Fedora) +- `freebsd` (FreeBSD) +- `freedos` (FreeDOS) +- `fvoid` (F-Void) +- `gabeeos` (gabeeOS Linux) +- `garuda` (Garuda Linux) +- `gentoo` (Gentoo) +- `ghostbsd` (GhostBSD) +- `haiku` (Haiku) +- `holoiso` (Steam OS HoloISO) +- `kali` (Kali) +- `kdeneon` (KDE Neon) +- `kolibrios` (KolibriOS) +- `linuxlite` (Linux Lite) +- `linuxmint` (Linux Mint) +- `lmde` (Linux Mint Debian Edition) +- `mageia` (Mageia) +- `manjaro` (Manjaro) +- `miyolinux` (Miyo Linux) +- `mxlinux` (MX Linux) +- `netboot` (netboot.xyz) +- `netbsd` (NetBSD) +- `nixos` (NixOS) +- `openbsd` (OpenBSD) +- `openindiana` (OpenIndiana) +- `opensuse` (openSUSE) +- `oraclelinux` (Oracle Linux) +- `peppermint` (PeppermintOS) +- `popos` (Pop!\_OS) +- `porteus` (Porteus) +- `pureos` (PureOS) +- `reactos` (ReactOS) +- `rebornos` (RebornOS) +- `rockylinux` (Rocky Linux) +- `siduction` (Siduction) +- `slackware` (Slackware) +- `slax` (Slax) +- `slitaz` (SliTaz GNU/Linux) +- `solus` (Solus) +- `sparkylinux` (SparkyLinux) +- `spiral` (SpiralLinux) +- `tails` (Tails) +- `tinycore` (Tiny Core Linux) +- `trisquel` (Trisquel) +- `truenas-core` (TrueNAS Core) +- `truenas-scale` (TrueNAS Scale) +- `tuxedoos` (TuxedoOS) +- `vanillaos` (Vanilla OS) +- `ventoy` (Ventoy) +- `voidpup` (Void Puppy) +- `void` (Void Linux) +- `vxlinux` (VX Linux) +- `xerolinux` (XeroLinux) +- `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`, `monterey` and +`ventura` 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 (on + Big Sur and above use `Apple Inc. VirtIO Block Device`) and + click **Erase**. + - Enter a `Name:` for the disk + - If you are installing macOS Mojave or later (Catalina, Big + Sur, Monterey and Ventura), 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 + - Ventura +- `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 8, 10 & 11 Guests + +`quickget` can download +[Windows10](https://www.microsoft.com/software-download/windows10) and +[Windows 11](https://www.microsoft.com/software-download/windows11) +automatically and create an optimised virtual machine configuration. +This configuration also includes the [VirtIO drivers for +Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/). + +Windows 8.1 is also supported but doesn't feature any automated +installation or driver optimisation. + +``` 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 administrator 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="off" +``` + +- `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 index fd95218..01bed89 100755 --- a/quickemu +++ b/quickemu @@ -687,7 +687,7 @@ function vm_boot() { if [ "${guest_os}" == "linux" ]; then local X_RES=1152 local Y_RES=648 - if [ "${XDG_SESSION_TYPE}" == "x11" ]; then + if [ "${XDG_SESSION_TYPE}" == "x11" ] || [ "${XDG_SESSION_TYPE}" == "wayland" ]; 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) @@ -848,6 +848,19 @@ function vm_boot() { SPICE_PORT=$(get_port 5930 9) fi + # ALLOW REMOTE ACCESS TO SPICE OVER LAN RATHER THAN JUST LOCALHOST + if [ -z "${ACCESS}" ]; then + SPICE_ADDR="127.0.0.1" + else + if [ "${ACCESS}" == "remote" ]; then + SPICE_ADDR="" + elif [ "${ACCESS}" == "local" ]; then + SPICE_ADDR="127.0.0.1" + else + SPICE_ADDR="${ACCESS}" + fi + fi + if [ -z "${SPICE_PORT}" ]; then echo " - SPICE: All SPICE ports have been exhausted." if [ "${OUTPUT}" == "none" ] || [ "${OUTPUT}" == "spice" ] || [ "${OUTPUT}" == "spice-app" ]; then @@ -864,7 +877,7 @@ function vm_boot() { echo -n " --spice-shared-dir ${PUBLIC}" fi echo "${FULLSPICY}" - SPICE="${SPICE},port=${SPICE_PORT},addr=127.0.0.1" + SPICE="${SPICE},port=${SPICE_PORT},addr=${SPICE_ADDR}" fi fi fi @@ -899,7 +912,7 @@ function vm_boot() { fi # If smbd is available and ~/Public is present export it to the guest via samba - if [[ -e "/usr/sbin/smbd" && -n ${PUBLIC} ]]; then + if [[ -x "$(command -v smbd)" && -n ${PUBLIC} ]]; then NET="${NET},smb=${PUBLIC}" echo " - smbd: On guest: smb://10.0.2.4/qemu" fi @@ -1326,6 +1339,7 @@ function usage() { echo " ${LAUNCHER} --vm ubuntu.conf" echo echo "You can also pass optional parameters" + echo " --access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'" 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" @@ -1498,6 +1512,7 @@ mouse="tablet" # options: intel-hda, ac97, es1370, sb16, none sound_card="intel-hda" +ACCESS="" BRAILLE="" DELETE_DISK=0 DELETE_VM=0 @@ -1540,7 +1555,7 @@ SOUND_CARD="" # shellcheck disable=SC2155 readonly LAUNCHER=$(basename "${0}") readonly DISK_MIN_SIZE=$((197632 * 8)) -readonly VERSION="4.8" +readonly VERSION="4.9.1" # TODO: Make this run the native architecture binary QEMU=$(command -v qemu-system-x86_64) @@ -1564,6 +1579,10 @@ if [ $# -lt 1 ]; then else while [ $# -gt 0 ]; do case "${1}" in + -access|--access) + ACCESS="${2}" + shift + shift;; -braille|--braille) BRAILLE="on" shift;; diff --git a/quickget b/quickget index 98281c2..a1e43a0 100755 --- a/quickget +++ b/quickget @@ -5,10 +5,12 @@ export LC_ALL=C # # 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: +# 3. Update os_homepages() - add a homepage for new OS +# 4. Create a releases_newos() generator (required) outputs the current supported release versions +# 5. Create a editions_newos() generator (optional) outputs the editions if new OS has multiple flavours/editions +# 6. Update make_vm_config() - add any *required* new OS tweaks +# 7. Create a get_newos() function - that does something like this: +# # function get_newos() { # local EDITION="${1:-}" # local HASH="" @@ -24,6 +26,28 @@ function cleanup() { kill "$(jobs -p)" fi } +if [ "${1}" == '--test-iso-url' ] || [ "${1}" == '-t' ]; then + test_iso_url="on" + if [ -n "$4" ]; then + set -- "$2" "$3" "$4" + elif [ -n "$3" ]; then + set -- "$2" "$3" + else + set -- "$2" + fi +elif [ "${1}" == '--show-iso-url' ] || [ "${1}" == '-s' ]; then + show_iso_url="on" + if [ -n "$4" ]; then + set -- "$2" "$3" "$4" + elif [ -n "$3" ]; then + set -- "$2" "$3" + else + set -- "$2" + fi +elif [ "${1}" == '--open-distro-homepage' ] || [ "${1}" == '-o' ]; then + open_distro_homepage="on" + set -- "$2" +fi function pretty_name() { local SIMPLE_NAME="" @@ -34,10 +58,10 @@ function pretty_name() { alma) PRETTY_NAME="Alma Linux";; alpine) PRETTY_NAME="Alpine Linux";; android) PRETTY_NAME="Android x86";; - arch) PRETTY_NAME="Arch Linux";; + archlinux) PRETTY_NAME="Arch Linux";; archcraft) PRETTY_NAME="Archcraft";; - arco) PRETTY_NAME="Arco Linux";; - artix) PRETTY_NAME="Artix Linux";; + arcolinux) PRETTY_NAME="Arco Linux";; + artixlinux) PRETTY_NAME="Artix Linux";; atheanos) PRETTY_NAME="Athena OS";; biglinux) PRETTY_NAME="BigLinux";; blendos) PRETTY_NAME="BlendOS";; @@ -61,12 +85,12 @@ function pretty_name() { holoiso) PRETTY_NAME="Steam OS HoloISO";; kdeneon) PRETTY_NAME="KDE Neon";; kolibrios) PRETTY_NAME="KolibriOS";; - lite) PRETTY_NAME="Linux Lite";; + linuxlite) PRETTY_NAME="Linux Lite";; + linuxmint) PRETTY_NAME="Linux Mint";; lmde) PRETTY_NAME="Linux Mint Debian Edition";; mageia) PRETTY_NAME="Mageia";; - mint) PRETTY_NAME="Linux Mint";; - miyo) PRETTY_NAME="Miyo Linux";; - mx) PRETTY_NAME="MX Linux";; + miyolinux) PRETTY_NAME="Miyo Linux";; + mxlinux) PRETTY_NAME="MX Linux";; netboot) PRETTY_NAME="netboot.xyz";; netbsd) PRETTY_NAME="NetBSD";; nixos) PRETTY_NAME="NixOS";; @@ -74,12 +98,16 @@ function pretty_name() { openbsd) PRETTY_NAME="OpenBSD";; openindiana) PRETTY_NAME="OpenIndiana";; opensuse) PRETTY_NAME="openSUSE";; - oracle) PRETTY_NAME="Oracle Linux";; + oraclelinux) PRETTY_NAME="Oracle Linux";; + peppermint) PRETTY_NAME="PeppermintOS";; popos) PRETTY_NAME="Pop!_OS";; + pureos) PRETTY_NAME="PureOS";; reactos) PRETTY_NAME="ReactOS";; rebornos) PRETTY_NAME="RebornOS";; - rocky) PRETTY_NAME="Rocky Linux";; + rockylinux) PRETTY_NAME="Rocky Linux";; slitaz) PRETTY_NAME="SliTaz GNU/Linux";; + sparkylinux) PRETTY_NAME="SparkyLinux";; + spiral) PRETTY_NAME="SpiralLinux";; tinycore) PRETTY_NAME="Tiny Core Linux";; truenas-core) PRETTY_NAME="TrueNAS Core";; truenas-scale) PRETTY_NAME="TrueNAS Scale";; @@ -95,8 +123,8 @@ function pretty_name() { ventoy) PRETTY_NAME="Ventoy";; void) PRETTY_NAME="Void Linux";; voidpup) PRETTY_NAME="Void Puppy";; - vx) PRETTY_NAME="VX Linux";; - xero) PRETTY_NAME="XeroLinux";; + vxlinux) PRETTY_NAME="VX Linux";; + xerolinux) PRETTY_NAME="XeroLinux";; zorin) PRETTY_NAME="Zorin OS";; *) PRETTY_NAME="${SIMPLE_NAME^}";; esac @@ -166,10 +194,6 @@ function list_csv() { for RELEASE in $("releases_${FUNC}"); do if [ "${OS}" == "macos" ]; then DOWNLOADER="macrecovery" - elif [ "${OS}" == "ubuntu" ] && [ "${RELEASE}" == "daily-canary" ] && [ ${HAS_ZSYNC} -eq 1 ]; then - DOWNLOADER="zsync" - elif [ "${OS}" == "ubuntu" ] && [ "${RELEASE}" == "daily-legacy" ] && [ ${HAS_ZSYNC} -eq 1 ]; then - DOWNLOADER="zsync" elif [[ "${OS}" == *"ubuntu"* ]] && [ "${RELEASE}" == "devel" ] && [ ${HAS_ZSYNC} -eq 1 ]; then DOWNLOADER="zsync" else @@ -198,15 +222,18 @@ function os_support() { alma \ alpine \ android \ - arch \ + antix \ + archlinux \ archcraft \ - arco \ - artix \ + arcolinux \ + artixlinux \ athenaos \ batocera \ + bazzite \ biglinux \ blendos \ bodhi \ + bunsenlabs \ cachyos \ centos-stream \ cereus \ @@ -234,31 +261,36 @@ function os_support() { kdeneon \ kolibrios \ kubuntu \ - lite \ + linuxlite \ + linuxmint \ lmde \ + lubuntu \ mageia \ manjaro \ - mint \ - miyo \ - mx \ + miyolinux \ + mxlinux \ netboot \ netbsd \ nixos \ - lubuntu \ macos \ openbsd \ openindiana \ opensuse \ - oracle \ + oraclelinux \ + peppermint \ popos \ + porteus \ + pureos \ reactos \ rebornos \ - rocky \ + rockylinux \ siduction \ slackware \ slax \ slitaz \ solus \ + sparkylinux \ + spiral \ tails \ tinycore \ trisquel \ @@ -277,13 +309,118 @@ function os_support() { ventoy \ void \ voidpup \ - vx \ + vxlinux \ windows \ - xero \ + xerolinux \ xubuntu \ zorin } +function os_homepages(){ + local SIMPLE_NAME="" + local HOMEPAGE="" + SIMPLE_NAME="${1}" + case ${SIMPLE_NAME} in + agarimos) HOMEPAGE="https://sourceforge.net/projects/agarimos/";; + alma) HOMEPAGE="https://almalinux.org/";; + alpine) HOMEPAGE="https://alpinelinux.org/";; + android) HOMEPAGE="https://www.android-x86.org/";; + antix) HOMEPAGE="https://antixlinux.com/";; + archlinux) HOMEPAGE="https://archlinux.org/";; + archcraft) HOMEPAGE="https://archcraft.io/";; + arcolinux) HOMEPAGE="https://arcolinux.com/";; + artixlinux) HOMEPAGE="https://artixlinux.org/";; + athenaos) HOMEPAGE="https://athenaos.org/";; + batocera) HOMEPAGE="https://batocera.org/";; + bazzite) HOMEPAGE="https://bazzite.gg/";; + biglinux) HOMEPAGE="https://www.biglinux.com.br/";; + blendos) HOMEPAGE="https://blendos.co/";; + bodhi) HOMEPAGE="https://www.bodhilinux.com/";; + bunsenlabs) HOMEPAGE="https://www.bunsenlabs.org/";; + cachyos) HOMEPAGE="https://cachyos.org/";; + centos-stream) HOMEPAGE="https://www.centos.org/centos-stream/";; + cereus) HOMEPAGE="https://cereuslinuxproject.github.io/";; + chimeralinux) HOMEPAGE="https://chimera-linux.org/";; + debian) HOMEPAGE="https://www.debian.org/";; + deepin) HOMEPAGE="https://www.deepin.org/";; + devuan) HOMEPAGE="https://www.devuan.org/";; + dietpi) HOMEPAGE="https://dietpi.com/";; + dragonflybsd) HOMEPAGE="https://www.dragonflybsd.org/";; + edubuntu) HOMEPAGE="https://www.edubuntu.org/";; + elementary) HOMEPAGE="https://elementary.io/";; + endeavouros) HOMEPAGE="https://endeavouros.com/";; + endless) HOMEPAGE="https://www.endlessos.org/os";; + fedora) HOMEPAGE="https://www.fedoraproject.org/";; + freebsd) HOMEPAGE="https://www.freebsd.org/";; + freedos) HOMEPAGE="https://freedos.org/";; + fvoid) HOMEPAGE="https://sourceforge.net/projects/f-void/";; + gabeeos) HOMEPAGE="https://gabeeoslinux.github.io/gabeeOSLinux";; + garuda) HOMEPAGE="https://garudalinux.org/";; + gentoo) HOMEPAGE="https://www.gentoo.org/";; + ghostbsd) HOMEPAGE="https://www.ghostbsd.org/";; + haiku) HOMEPAGE="https://www.haiku-os.org/";; + holoiso) HOMEPAGE="https://github.com/HoloISO/holoiso";; + kali) HOMEPAGE="https://www.kali.org/";; + kdeneon) HOMEPAGE="https://neon.kde.org/";; + kolibrios) HOMEPAGE="http://kolibrios.org/en/";; + kubuntu) HOMEPAGE="https://kubuntu.org/";; + linuxlite) HOMEPAGE="https://www.linuxliteos.com/";; + linuxmint) HOMEPAGE="https://linuxmint.com/";; + lmde) HOMEPAGE="https://www.linuxmint.com/download_lmde.php";; + lubuntu) HOMEPAGE="https://lubuntu.me/";; + mageia) HOMEPAGE="https://www.mageia.org/";; + manjaro) HOMEPAGE="https://manjaro.org/";; + miyolinux) HOMEPAGE="https://sourceforge.net/projects/miyolinux/";; + mxlinux) HOMEPAGE="https://mxlinux.org/";; + netboot) HOMEPAGE="https://netboot.xyz/";; + netbsd) HOMEPAGE="https://www.netbsd.org/";; + nixos) HOMEPAGE="https://nixos.org/";; + macos) HOMEPAGE="https://www.apple.com/macos/";; + openbsd) HOMEPAGE="https://www.openbsd.org/";; + openindiana) HOMEPAGE="https://www.openindiana.org/";; + opensuse) HOMEPAGE="https://www.opensuse.org/";; + oraclelinux) HOMEPAGE="https://www.oracle.com/linux/";; + peppermint) HOMEPAGE="https://peppermintos.com/";; + popos) HOMEPAGE="https://pop.system76.com/";; + porteus) HOMEPAGE="http://www.porteus.org/";; + pureos) HOMEPAGE="https://www.pureos.net/";; + reactos) HOMEPAGE="https://reactos.org/";; + rebornos) HOMEPAGE="https://rebornos.org/";; + rockylinux) HOMEPAGE="https://rockylinux.org/";; + siduction) HOMEPAGE="https://siduction.org/";; + slackware) HOMEPAGE="http://www.slackware.com/";; + slax) HOMEPAGE="https://www.slax.org/";; + slitaz) HOMEPAGE="https://www.slitaz.org/";; + solus) HOMEPAGE="https://getsol.us/";; + sparkylinux) HOMEPAGE="https://sparkylinux.org/";; + spiral) HOMEPAGE="https://spirallinux.github.io/";; + tails) HOMEPAGE="https://tails.net/";; + tinycore) HOMEPAGE="http://www.tinycorelinux.net/";; + trisquel) HOMEPAGE="https://trisquel.info/";; + truenas-core) HOMEPAGE="https://www.truenas.com/truenas-core/";; + truenas-scale) HOMEPAGE="https://www.truenas.com/truenas-scale/";; + tuxedoos) HOMEPAGE="https://www.tuxedocomputers.com/en/TUXEDO-OS_1.tuxedo";; + ubuntu) HOMEPAGE="https://ubuntu.com/";; + ubuntu-budgie) HOMEPAGE="https://ubuntubudgie.org/";; + ubuntucinnamon) HOMEPAGE="https://ubuntucinnamon.org/";; + ubuntukylin) HOMEPAGE="https://ubuntukylin.com/";; + ubuntu-mate) HOMEPAGE="https://ubuntu-mate.org/";; + ubuntu-server) HOMEPAGE="https://ubuntu.com/server";; + ubuntustudio) HOMEPAGE="https://ubuntustudio.org/";; + ubuntu-unity) HOMEPAGE="https://ubuntuunity.org/";; + vanillaos) HOMEPAGE="https://vanillaos.org/";; + ventoy) HOMEPAGE="https://www.ventoy.net/en/index.html";; + void) HOMEPAGE="https://voidlinux.org/";; + voidpup) HOMEPAGE="https://sourceforge.net/projects/vpup/";; + vxlinux) HOMEPAGE="https://vxlinux.org/";; + windows) HOMEPAGE="https://www.microsoft.com/en-us/windows/";; + xerolinux) HOMEPAGE="https://xerolinux.xyz/";; + xubuntu) HOMEPAGE="https://xubuntu.org/";; + zorin) HOMEPAGE="https://zorin.com/os/";; + esac + echo "${HOMEPAGE}" +} + function releases_agarimos() { echo latest } @@ -301,7 +438,7 @@ function editions_alma() { } function releases_alpine() { - echo 3.12 3.13 3.14 3.15 latest + echo 3.12 3.13 3.14 3.15 3.16 3.17 3.18 latest } function releases_android() { @@ -312,29 +449,37 @@ function editions_android() { echo x86 x86_64 } +function releases_antix() { + echo 21 22 23 +} + +function editions_antix() { + echo net-sysv core-sysv base-sysv full-sysv net-runit core-runit base-runit full-runit +} + +function releases_archlinux() { + echo latest +} + function releases_archcraft() { echo latest } -function releases_arch() { - echo latest -} - -function releases_arco() { +function releases_arcolinux() { local RLIST RLIST=$(curl -s https://ant.seedhost.eu/arcolinux/iso/ | grep -o -E ">v[[:digit:]]{2}.[[:digit:]]{2}.[[:digit:]]{2}" | sed -e "s/>//" | tr '\r\n' ' ') echo ${RLIST} } -function editions_arco() { +function editions_arcolinux() { echo large small } -function releases_artix() { +function releases_artixlinux() { echo stable } -function editions_artix() { +function editions_artixlinux() { echo base-dinit base-openrc base-runit base-s6 cinnamon-dinit cinnamon-openrc cinnamon-runit cinnamon-s6 lxde-dinit lxde-openrc lxde-runit lxde-s6 lxqt-dinit lxqt-openrc lxqt-runit lxqt-s6 mate-dinit mate-openrc mate-runit mate-s6 plasma-dinit plasma-openrc plasma-runit plasma-s6 xfce-dinit xfce-openrc xfce-runit xfce-s6 community-gtk-openrc community-qt-openrc } @@ -343,7 +488,11 @@ function releases_athenaos() { } function releases_batocera() { - echo 32 33 34 + echo latest +} + +function releases_bazzite() { + echo $(wget -q -O- "https://api.github.com/repos/ublue-os/bazzite/releases" | grep 'download_url' | grep 'sum' | cut -d '/' -f8 | cut -d'v' -f2 | tr '\n' ' ') } function releases_biglinux() { @@ -370,6 +519,10 @@ function editions_bodhi() { echo standard hwe s76 } +function releases_bunsenlabs() { + echo latest +} + function releases_cachyos() { echo 230813 } @@ -436,12 +589,8 @@ function releases_dragonflybsd() { echo $DBSD_RELEASES } -function releases_edubuntu() { - echo 23.04 -} - function releases_elementary() { - echo 7.0 + echo 7.0 7.1 } function releases_endeavouros() { @@ -464,11 +613,7 @@ function editions_endless() { } function releases_fedora() { - echo 33 34 35 36 37 38 -} - -function releases_batocera() { - echo 32 33 34 + echo 33 34 35 36 37 38 39 } function editions_fedora() { @@ -485,7 +630,8 @@ function editions_fedora() { Sericea \ Kinoite \ Sway \ - Server + Server \ + Onyx } function releases_freebsd(){ @@ -544,7 +690,7 @@ function editions_haiku() { } function releases_holoiso() { - echo 4.5 + wget -q https://github.com/HoloISO/holoiso/releases/latest -O- | grep -o -e 'releases/tag/[[:digit:]]\+\.[[:digit:]]\+\.[[:digit:]]' | head -1 | cut -d/ -f3 } function releases_kali() { @@ -559,10 +705,18 @@ function releases_kolibrios() { echo latest } -function releases_lite() { +function releases_linuxlite() { echo 6.0 6.2 6.4 6.6 } +function releases_linuxmint(){ + echo 20.2 20.3 21 21.1 21.2 +} + +function editions_linuxmint(){ + echo cinnamon mate xfce +} + function editions_lmde(){ echo cinnamon } @@ -584,40 +738,26 @@ function editions_mageia(){ } function releases_manjaro() { - echo xfce \ - gnome \ - kde \ - budgie \ - cinnamon \ - i3 \ - mate + echo xfce gnome plasma budgie cinnamon i3 mate sway } function editions_manjaro(){ echo full minimal } -function releases_mint(){ - echo 20.2 20.3 21 21.1 21.2 -} - -function editions_mint(){ - echo cinnamon mate xfce -} - -function releases_miyo() { +function releases_miyolinux() { echo 2022 } -function editions_miyo(){ +function editions_miyolinux(){ echo Kwin Deboot-Ceres JWM Openbox MATE } -function releases_mx(){ +function releases_mxlinux(){ echo 21.3 } -function editions_mx(){ +function editions_mxlinux(){ echo Xfce KDE Fluxbox } @@ -655,10 +795,18 @@ function releases_opensuse(){ echo 15.0 15.1 15.2 15.3 15.4 microos tumbleweed } -function releases_oracle() { +function releases_oraclelinux() { echo 7.7 7.8 7.9 8.4 8.5 8.6 9.0 } +function releases_peppermint() { + echo latest +} + +function editions_peppermint() { + echo devuan-xfce devuan-gnome debian-xfce debian-gnome +} + function releases_popos() { echo 20.04 21.10 22.04 } @@ -667,6 +815,21 @@ function editions_popos() { echo intel nvidia } +function releases_porteus() { + echo 5.0 5.01 +} + +function editions_porteus() { + echo cinnamon gnome kde lxde lxqt mate openbox xfce +} + +function releases_pureos() { + echo 9.0 10.3 +} + +function editions_pureos() { + echo gnome plasma +} function releases_reactos() { echo latest } @@ -675,11 +838,17 @@ function releases_rebornos() { echo latest } -function releases_rocky() { +function get_rebornos() { + local ISO=$(wget -q -O- "https://meta.cdn.soulharsh007.dev/RebornOS-ISO?format=json" | jq -r ".url") + local HASH=$(wget -q -O- "https://meta.cdn.soulharsh007.dev/RebornOS-ISO?format=json" | jq -r ".md5") + echo "${ISO} ${HASH}" +} + +function releases_rockylinux() { echo 8.3 8.4 8.5 8.6 8.7 9.0 9.1 } -function editions_rocky() { +function editions_rockylinux() { echo minimal dvd boot } @@ -715,6 +884,22 @@ function editions_solus() { echo Budgie GNOME MATE Plasma } +function releases_sparkylinux() { + echo 7.1 2023.07 +} + +function editions_sparkylinux() { + echo lxqt mate xfce kde minimalgui minimalcli gameover multimedia rescue +} + +function releases_spiral() { + echo latest +} + +function editions_spiral() { + echo Plasma XFCE Mate LXQt Gnome Budgie Cinnamon Builder +} + function releases_tails() { echo stable } @@ -755,88 +940,57 @@ function releases_tuxedoos() { } function releases_ubuntu() { - local LTS_SUPPORT="14.04 16.04 18.04 20.04 22.04" - local INTERIM_SUPPORT="23.04" + local VERSION_DATA="$(IFS=$'\n' wget -qO- https://api.launchpad.net/devel/ubuntu/series | jq -r '.entries[]')" + local SUPPORTED_VERSIONS=($(IFS=$'\n' jq -r 'select(.status=="Supported" or .status=="Current Stable Release") | .version' <<<${VERSION_DATA} | sort)) + local EOL_VERSIONS=($(IFS=$'\n' jq -r 'select(.status=="Obsolete") | .version' <<<${VERSION_DATA} | sort)) + local LTS_SUPPORT=() + local INTERIM_SUPPORT=() + + for i in "${SUPPORTED_VERSIONS[@]}"; do + if [[ $(expr ${i%.*} % 2) == 0 && ${i#*.} == "04" ]]; then + LTS_SUPPORT+=($i) + else + INTERIM_SUPPORT+=($i) + fi + done case "${OS}" in - kubuntu|lubuntu|ubuntukylin|\ - ubuntu-mate|ubuntustudio|xubuntu) + edubuntu|ubuntu-unity|ubuntucinnamon) + echo ${INTERIM_SUPPORT[@]} daily-live + ;; + kubuntu|lubuntu|ubuntukylin|ubuntu-mate|ubuntustudio|xubuntu) ## after 14.04 - LTS_SUPPORT="${LTS_SUPPORT/14.04 /}" + echo ${LTS_SUPPORT[@]:1} ${INTERIM_SUPPORT[@]} daily-live jammy-daily ${EOL_VERSIONS[@]/#/eol-} ;; ubuntu-budgie) #after 16.04 - LTS_SUPPORT="${LTS_SUPPORT/14.04 16.04 /}" + echo ${LTS_SUPPORT[@]:2} ${INTERIM_SUPPORT[@]} daily-live jammy-daily ${EOL_VERSIONS[@]/#/eol-} ;; - ubuntu-unity) - INTERIM_SUPPORT="${INTERIM_SUPPORT}" - ;; - ubuntucinnamon) - INTERIM_SUPPORT="${INTERIM_SUPPORT}" + ubuntu) + echo ${LTS_SUPPORT[@]} ${INTERIM_SUPPORT[@]} daily-live ${EOL_VERSIONS[@]/#/eol-} ;; esac - - - if [ "${OS}" == "ubuntu-unity" ] || [ "${OS}" == "ubuntucinnamon" ]; then - echo ${INTERIM_SUPPORT} \ - daily-live \ - daily-canary \ - ; - elif [ "${OS}" == "edubuntu" ]; then - echo "23.04" - else - echo ${LTS_SUPPORT} \ - ${INTERIM_SUPPORT} \ - jammy-daily \ - daily-live \ - daily-canary \ - daily-legacy \ - 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 \ - eol-22.10 \ - ; - fi } function releases_ubuntu-server() { - local LTS_SUPPORT="18.04 20.04 22.04" - local INTERIM_SUPPORT="23.04" - echo ${LTS_SUPPORT} \ - ${INTERIM_SUPPORT} \ - daily-live + local ALL_VERSIONS=($(IFS=$'\n' wget -qO- http://releases.ubuntu.com/streams/v1/com.ubuntu.releases:ubuntu-server.json | jq -r '.products[] | select(.arch=="amd64") | .version')) + + local LTS_SUPPORT=() + local INTERIM_SUPPORT=() + + for i in "${!ALL_VERSIONS[@]}"; do + if [[ $i == 0 || ${ALL_VERSIONS[$i]} > ${ALL_VERSIONS[$(expr $i - 1)]} ]]; then + if [[ $(expr ${ALL_VERSIONS[${i}]%.*} % 2) == 0 && ${ALL_VERSIONS[${i}]#*.} == "04" ]]; then + LTS_SUPPORT+=(${ALL_VERSIONS[$i]}) + else + INTERIM_SUPPORT+=(${ALL_VERSIONS[$i]}) + fi + else + break + fi + done + + echo ${LTS_SUPPORT[@]} ${INTERIM_SUPPORT[@]} daily-live } function releases_vanillaos() { @@ -859,15 +1013,18 @@ function releases_voidpup() { echo latest } -function releases_vx() { - wget -q https://github.com/VX-Linux/main/releases/latest -O- |grep -o -e 'releases/tag/[[:digit:]]\+\.[[:digit:]]\+'|head -1|cut -d/ -f3 +function releases_vxlinux() { + wget -q https://github.com/VX-Linux/main/releases/latest -O- | grep -o -e 'releases/tag/[[:digit:]]\+\.[[:digit:]]\+\.[[:digit:]]' | head -1 | cut -d/ -f3 + #wget -q https://github.com/VX-Linux/main/tags.atom -O- | grep 'tag/' | cut -d'/' -f9 | cut -d'"' -f1 | sed ':a;N;$!ba;s/\n/ /g' + #wget -q https://github.com/VX-Linux/main/tags -O- |grep -o -e 'releases/tag/[[:digit:]]\+\.[[:digit:]]\+\.[[:digit:]]\+'|cut -d/ -f3 + #wget -q https://github.com/VX-Linux/main/releases/latest -O- |grep -o -e 'releases/tag/[[:digit:]]\+\.[[:digit:]]\+'|head -1|cut -d/ -f3 } function releases_windows() { - echo 10 11 + echo 8 10 11 } -function releases_xero() { +function releases_xerolinux() { echo kde } @@ -922,18 +1079,23 @@ function web_get() { exit 1 fi - if command -v aria2c &>/dev/null; then + # Test mode for ISO + if [ "${show_iso_url}" == 'on' ]; then + echo "${URL}" + exit 0 + elif [ "${test_iso_url}" == 'on' ]; then + wget --spider "${URL}" + exit 0 + elif command -v aria2c &>/dev/null; then if ! aria2c --stderr -x16 --continue=true --summary-interval=0 --download-result=hide --console-log-level=error "${URL}" --dir "${DIR}" -o "${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 + elif ! wget --quiet --continue --tries=3 --read-timeout=10 --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 } @@ -943,7 +1105,14 @@ function zsync_get() { local OUT="" local URL="${1}" - if command -v zsync &>/dev/null; then + # Test mode for ISO + if [ "${show_iso_url}" == 'on' ]; then + echo "${URL}" + exit 0 + elif [ "${test_iso_url}" == 'on' ]; then + wget --spider "${URL}" + exit 0 + elif command -v zsync &>/dev/null; then if [ -n "${3}" ]; then OUT="${3}" else @@ -1051,7 +1220,7 @@ EOF # OS specific tweaks case ${OS} in - alma|centos-stream|endless|garuda|nixos|oracle|popos|rocky) + alma|centos-stream|endless|garuda|nixos|oraclelinux|popos|rockylinux) echo "disk_size=\"32G\"" >> "${CONF_FILE}";; openindiana) echo "boot=\"legacy\"" >> "${CONF_FILE}" @@ -1131,13 +1300,7 @@ EOF # Enable TPM for Windows 11 if [ "${OS}" == "windows" ] && [ "${RELEASE}" -ge 11 ]; then echo "tpm=\"on\"" >> "${CONF_FILE}" - # Only force SecureBoot on for non-Debian/Ubuntu distros. - if [ -e "/usr/share/OVMF/OVMF_CODE_4M.fd" ] && [ -e "/usr/share/OVMF/OVMF_VARS_4M.fd" ]; then - SEC_BOOT="off" - else - SEC_BOOT="on" - fi - echo "secureboot=\"${SEC_BOOT}\"" >> "${CONF_FILE}" + echo "secureboot=\"off\"" >> "${CONF_FILE}" fi fi echo @@ -1222,7 +1385,41 @@ function get_android() { echo "${URL}/${ISO} ${HASH}" } -function get_arch() { +function get_antix() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="https://sourceforge.net/projects/antix-linux/files/Final/antiX-${RELEASE}" + + case ${RELEASE} in + 21) URL_runit="${URL}/runit-bullseye";; + *) URL_runit="${URL}/runit-antiX-${RELEASE}";; + esac + + case ${EDITION} in + net-sysv) ISO="antiX-${RELEASE}-net_x64-net.iso";; + core-sysv) ISO="antiX-${RELEASE}_x64-core.iso";; + base-sysv) ISO="antiX-${RELEASE}_x64-base.iso";; + full-sysv) ISO="antiX-${RELEASE}_x64-full.iso";; + net-runit) ISO="antiX-${RELEASE}-runit-net_x64-net.iso" + URL="${URL_runit}" + ;; + core-runit) ISO="antiX-${RELEASE}-runit_x64-core.iso" + URL="${URL_runit}" + ;; + base-runit) ISO="antiX-${RELEASE}-runit_x64-base.iso" + URL="${URL_runit}" + ;; + full-runit) ISO="antiX-${RELEASE}-runit_x64-full.iso" + URL="${URL_runit}" + ;; + esac + + HASH=$(wget -q -O- ${URL}/README.txt | grep "${ISO}" | cut -d' ' -f1 | head -1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_archlinux() { local HASH="" local ISO="" local URL="https://mirror.rackspace.com/archlinux" @@ -1241,7 +1438,7 @@ function get_archcraft() { echo "${URL} ${HASH}" } -function get_arco() { +function get_arcolinux() { local EDITION="${1:-}" local HASH="" local ISO="arcolinux${EDITION:0:1}-${RELEASE}-x86_64.iso" @@ -1251,7 +1448,7 @@ function get_arco() { } -function get_artix() { +function get_artixlinux() { local EDITION="${1:-}" local HASH="" local ISO="" @@ -1276,18 +1473,16 @@ 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) + echo "${URL}/${ISO} ${HASH}" +} - 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 +function get_bazzite() { + local HASH="" + local ISO="" + local URL="https://github.com/ublue-os/bazzite/releases/download/v${RELEASE}" + ISO=$(wget -q -O- "https://api.github.com/repos/ublue-os/bazzite/releases" | grep 'download_url' | grep 'sum' | cut -d '"' -f4 | cut -d'.' -f1-5 | grep "${RELEASE}" | cut -d'/' -f9) + HASH=$(wget -q -O- "${URL}/${ISO}.sha256sum" | grep 'SHA256' | cut -d' ' -f4) echo "${URL}/${ISO} ${HASH}" } @@ -1301,16 +1496,21 @@ function get_biglinux() { } function get_blendos() { - local EDITION="${1:-}" local HASH="" local URL="" # BlendOS has more editions and releases but there's a tracker indirect and other issues # so easier to use the rss feed # # We have to provide edition/release as RELEASE or have a major refactor - # But this works for now ... + # But this works for now ... or does it .... URL=$(grep ${RELEASE} /tmp/blendos-isos.rss | grep -E -o 'https://.*blendOS\.iso') HASH=$(grep ${RELEASE} /tmp/blendos-isos.rss | grep -E -o '[[:alnum:]]{32}') + # ## fix up variables for path naming + EDITION=${RELEASE%%/*} + RELEASE=${RELEASE##*/} + # For UX maybe show the date of the release + #echo ${RELEASE##*/} "(" $(date -d @${RELEASE##*/}) ")" + # maybe $(date -d @${RELEASE##*/} '+%Y%m%d') echo "${URL} ${HASH}" } @@ -1318,7 +1518,7 @@ function get_bodhi() { local EDITION="${1:-}" local HASH="" local ISO="" - local URL="https://sourceforge.net/projects/bodhilinux/files/${release}/" + local URL="https://sourceforge.net/projects/bodhilinux/files/${RELEASE}" case ${EDITION} in standard) ISO="bodhi-${RELEASE}-64.iso";; @@ -1328,6 +1528,14 @@ function get_bodhi() { echo "${URL}/${ISO} ${HASH}" } +function get_bunsenlabs() { + local HASH="" + local ISO="beryllium-1-amd64.hybrid.iso" + local URL="https://ddl.bunsenlabs.org/ddl" + HASH=$(wget -q -O- "${URL}/release.sha256.txt" | head -1 | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + function get_cachyos() { local HASH="" local ISO="cachyos-${EDITION}-linux-${RELEASE}.iso" @@ -1356,25 +1564,17 @@ function get_centos-stream() { } function get_cereus() { + local EDITION="${1:-}" local HASH="" + local DATE="" local ISO="" - local URL="" + local URL="https://sourceforge.net/projects/cereus-linux/files/isos/beta/latest/${EDITION}" + + DATE=$(wget -q -O- https://sourceforge.net/projects/cereus-linux/files/isos/beta/latest/base/SHA256SUM | grep 'x86_64-base' | rev | cut -d'-' -f1 | rev | cut -d'.' -f1-3) + ISO="cereus-beta-live-x86_64-${EDITION}-${DATE}.iso" 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) - ;; + base) HASH=$(wget -q -O- "${URL}/SHA256SUM" | grep "${ISO}" | cut -d' ' -f1);; + *) HASH=$(wget -q -O- "${URL}/SHA256" | grep "${ISO}" | cut -d' ' -f1);; esac echo "${URL}/${ISO} ${HASH}" } @@ -1446,7 +1646,7 @@ function get_devuan() { 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";; - daedalus) ISO="devuan_${RELEASE}_5.0.0_amd64_desktop-live.iso" + daedalus) ISO="devuan_${RELEASE}_5.0.0_amd64_desktop-live.iso";; esac HASH=$(wget -q -O- "${URL}/SHASUMS.txt" | grep "${ISO}" | cut -d' ' -f1) echo "${URL}/${ISO} ${HASH}" @@ -1497,24 +1697,16 @@ function get_dragonflybsd() { echo "${URL}/${ISO} ${HASH}" } -function get_edubuntu() { - local HASH="" - local ISO="edubuntu-${RELEASE}-desktop-amd64.iso" - local URL="https://cdimages.ubuntu.com/edubuntu/releases/${RELEASE}/release" - - HASH=$(wget -q -O- "${URL}/SHA512SUMS" | grep "${ISO}" | cut -d' ' -f1) - 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" ;; + 7.1) + local ISO="elementaryos-${RELEASE}-stable.20230926rc.iso" + HASH="5c7f6b388e5787c366587985301ea05ab16e4cc0de3be2b3d6a559ce81a2f102" + ;; esac local URL="https://ams3.dl.elementary.io/download" echo "${URL}/$(date +%s | base64)/${ISO} ${HASH}" @@ -1567,7 +1759,7 @@ function get_fedora() { local VARIANT="" case ${EDITION} in - Server|Kinoite|Silverblue|Sericea|Workstation) VARIANT="${EDITION}";; + Server|Kinoite|Onyx|Silverblue|Sericea|Workstation) VARIANT="${EDITION}";; *) VARIANT="Spins";; esac @@ -1688,12 +1880,12 @@ function get_haiku() { } function get_holoiso() { - local HASH="" - local ISO="HoloISO_${RELEASE}_ux_changes-20230626_66f7c74061_bootchoice_fixes-1-x86-64.iso.iso" - local URL="http://holoiso.itsvixano.me" - - HASH=$(wget -q -O- "${URL}/${ISO}.sha256sum" | cut -d' ' -f1) - echo "${URL}/${ISO} ${HASH}" + #local HASH="" + local ISO=$(wget -q -O- "https://api.github.com/repos/HoloISO/holoiso/releases" | sed 's/ /\n/g' | grep "HoloISO_${RELEASES}" | cut -d'\' -f1 | cut -d'/' -f4) + local URL="https://cd2.holoiso.ru.eu.org" + # Can't find hash + #HASH=$(wget -q -O- "${URL}/${ISO}.sha256sum" | cut -d' ' -f1) + echo "${URL}/${ISO} #${HASH}" } function get_kali() { @@ -1723,7 +1915,7 @@ function get_kolibrios() { echo "${URL}/${ISO} ${HASH}" } -function get_lite() { +function get_linuxlite() { local HASH="" local ISO="linux-lite-${RELEASE}-64bit.iso" local URL="https://sourceforge.net/projects/linux-lite/files/${RELEASE}" @@ -1732,6 +1924,16 @@ function get_lite() { 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="" @@ -1781,7 +1983,7 @@ function get_macos() { monterey) #12 BOARD_ID="Mac-E43C1C25D4880AD6";; ventura) #13 - BOARD_ID="Mac-7BA5B2D9E42DDD94";; + BOARD_ID="Mac-BE088AF8C5EB4FA2";; *) echo "ERROR! Unknown release: ${RELEASE}" releases_macos exit 1;; @@ -1857,24 +2059,14 @@ function get_manjaro() { if [[ ${RELEASE} != "sway" ]]; then URL="$(echo ${MANIFEST} | jq -r .${TYPE}.${RELEASE}${EDITION}.image)" else - URL="echo ${MANIFEST} | jq -r '.[] | select(.name|test("^manjaro-sway-.*[.]iso$")) | select(.name|contains("unstable")|not) | .url'" + URL=$(echo ${MANIFEST} | jq -r '.[] | select(.name|test("^manjaro-sway-.*[.]iso$")) | select(.name|contains("unstable")|not) | .url') fi HASH=$(wget -qO- "${URL}.sha512" | cut -d' ' -f1) echo "${URL} ${HASH}" } -function get_mint() { - 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_miyo() { +function get_miyolinux() { local EDITION="${1:-}" local HASH="" local URL="https://sourceforge.net/projects/miyolinux/files/${RELEASE}-Release/${EDITION}" @@ -1891,7 +2083,7 @@ function get_miyo() { echo "${URL}/${ISO} ${HASH}" } -function get_mx() { +function get_mxlinux() { local EDITION="${1:-}" local HASH="" local ISO="" @@ -1971,7 +2163,7 @@ function get_opensuse() { echo "${URL}/${ISO} ${HASH}" } -function get_oracle() { +function get_oraclelinux() { local HASH="" local ISO="" local VER_MAJ=${RELEASE::1} @@ -1986,6 +2178,31 @@ function get_oracle() { echo "${URL}/${ISO} ${HASH}" } +function get_peppermint() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="https://sourceforge.net/projects/peppermintos/files/isos" + + case ${EDITION} in + devuan-xfce) ISO="PeppermintOS-devuan_64_xfce.iso" + URL="${URL}/XFCE" + ;; + debian-xfce) ISO="PeppermintOS-Debian-64.iso" + URL="${URL}/XFCE" + ;; + devuan-gnome) ISO="PeppermintOS-devuan_64_gfb.iso" + URL="${URL}/Gnome_FlashBack" + ;; + debian-gnome) ISO="PeppermintOS-Debian_64_gfb.iso" + URL="${URL}/Gnome_FlashBack" + ;; + esac + + HASH=$(wget -q -O- "${URL}/${ISO}-sha512.checksum" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + function get_popos() { local EDITION="${1:-}" local HASH="" @@ -1996,6 +2213,38 @@ function get_popos() { echo "${URL} ${HASH}" } +function get_porteus() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="" + + edition="${EDITION~~}" + ISO="Porteus-${edition}-v${RELEASE}-x86_64.iso" + URL="https://mirrors.dotsrc.org/porteus/x86_64/Porteus-v${RELEASE}" + HASH=$(wget -q -O- "${URL}/sha256sums.txt" | grep "${ISO}" | cut -d' ' -f1) + echo "${URL}/${ISO} ${HASH}" +} + +function get_pureos() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="" + + case ${RELEASE} in + 9) + URL="https://downloads.puri.sm/9/live/${EDITION}/2020-08-06" + ISO="pureos-${RELEASE}-${EDITION}-live_20200806-amd64.hybrid.iso" + HASH=$(wget -q -O- "${URL}/checksums.sha256sum" | grep "${ISO}" | cut -d' ' -f1) + ;; + 10) + URL="https://downloads.puri.sm/10/${EDITION}/2023-06-14" + ISO="pureos-${RELEASE}-${EDITION}-live-20230614_amd64.iso" + HASH=$(wget -q -O- "${URL}/pureos-${RELEASE}-${EDITION}-live-20230614_amd64.checksums_sha256.txt" | head -1 | cut -d' ' -f1) + esac + echo "${URL}/${ISO} ${HASH}" +} function get_reactos() { local HASH="" local URL="" @@ -2012,7 +2261,7 @@ function get_rebornos() { echo "${ISO} ${HASH}" } -function get_rocky() { +function get_rockylinux() { local EDITION="${1:-}" if [[ "${RELEASE}" =~ ^8. ]] && [[ "${EDITION}" == "dvd" ]] then @@ -2090,6 +2339,33 @@ function get_solus() { echo "${URL}/${ISO} ${HASH}" } +function get_sparkylinux() { + local EDITION="${1:-}" + local HASH="" + local ISO="" + local URL="" + + ISO="sparkylinux-${RELEASE}-x86_64-${EDITION}.iso" + case ${EDITION} in + minimalcli) URL="https://sourceforge.net/projects/sparkylinux/files/cli";; + minimalgui) URL="https://sourceforge.net/projects/sparkylinux/files/base";; + *) URL="https://sourceforge.net/projects/sparkylinux/files/${EDITION}";; + esac + + HASH=$(wget -q -O- ${URL}/${ISO}.allsums.txt | head -2 | grep 'iso' | cut -d' ' -f1) + echo "${URL}/${ISO}" "${HASH}" +} + +function get_spiral() { + local EDITION="${1:-}" + local HASH="" + local ISO="SpiralLinux_${EDITION}_12.231005_x86-64.iso" + local URL="https://sourceforge.net/projects/spirallinux/files/12.231005" + + HASH=$(wget -q -O- 'https://sourceforge.net/projects/spirallinux/rss?path=/' | grep "${ISO}" | grep 'md5' | cut -d'<' -f3 | cut -d'>' -f2) + echo "${URL}/${ISO}" "${HASH}" +} + function get_tails() { local ISO="" local JSON="" @@ -2170,20 +2446,32 @@ function get_ubuntu-server() { local HASH="" local ISO="" - local URL="https://releases.ubuntu.com/${RELEASE}" + local URL="" + + [[ $RELEASE = daily ]] && RELEASE=daily-live + + if [[ "${RELEASE}" == "daily"* ]]; then + URL="https://cdimage.ubuntu.com/${OS}/${RELEASE}/current" + else + URL="https://releases.ubuntu.com/${RELEASE}" + fi if wget -q --spider "${URL}/SHA256SUMS"; then - ISO=$(wget -q -O- "${URL}/SHA256SUMS" | grep 'live-server' | grep amd64 | grep iso | cut -d'*' -f2) - HASH=$(wget -q -O- "${URL}/SHA256SUMS" | grep 'live-server' | grep amd64 | grep iso |cut -d' ' -f1) + DATA=$(wget -qO- "${URL}/SHA256SUMS" | grep 'live-server' | grep amd64 | grep iso) + ISO=$(cut -d'*' -f2 <<<${DATA}) + HASH=$(cut -d' ' -f1 <<<${DATA}) else - ISO=$(wget -q -O- "${URL}/MD5SUMS" | grep 'live-server' | grep amd64 | grep iso | cut -d' ' -f3) - HASH=$(wget -q -O- "${URL}/MD5SUMS" | grep 'live-server' | grep amd64 | grep iso | cut -d' ' -f1) + DATA=$(wget -qO- "${URL}/MD5SUMS" | grep 'live-server' | grep amd64 | grep iso) + ISO=$(cut -d' ' -f3 <<<${DATA}) + HASH=$(cut -d' ' -f1 <<<${DATA}) fi - if [[ "${RELEASE}" == *"daily"* ]] || [ "${RELEASE}" == "dvd" ]; then - URL="https://cdimage.ubuntu.com/${OS}/${RELEASE}/current" - ISO=$(wget -q -O- "${URL}/SHA256SUMS" | grep 'live-server' | grep amd64 | grep iso | cut -d'*' -f2) - HASH=$(wget -q -O- "${URL}/SHA256SUMS" | grep 'live-server' | grep amd64 | grep iso |cut -d' ' -f1) + if [ -z $ISO ] || [ -z $HASH ]; then + echo "$(pretty_name $OS) ${RELEASE} is currently unavailable. Please select other OS/Release combination" + exit 1 + fi + + if [[ "${RELEASE}" == "daily"* ]] || [ "${RELEASE}" == "dvd" ]; then zsync_get "${URL}/${ISO}" "${VM_PATH}" "${OS}-devel.iso" make_vm_config "${OS}-devel.iso" else @@ -2197,27 +2485,25 @@ function get_ubuntu() { local ISO="" local HASH="" local URL="" + local DATA="" - if [[ "${RELEASE}" == *"daily"* ]] && [ "${OS}" == "ubuntustudio" ]; then + [[ $RELEASE = daily ]] && RELEASE=daily-live + + 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" - elif [ "${RELEASE}" == "daily-legacy" ] && [ "${OS}" != "ubuntu" ]; then - # daily-legacy 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 + if [[ "${OS}" == "ubuntustudio" ]]; then + URL="https://cdimage.ubuntu.com/${OS}/jammy/dvd/current" + else URL="https://cdimage.ubuntu.com/${OS}/jammy/daily-live/current" + fi VM_PATH="${OS}-jammy-live" - elif [[ "${RELEASE}" == "daily-legacy" ]]; then - URL="https://cdimage.ubuntu.com/${RELEASE}/current" - VM_PATH="${OS}-${RELEASE}" - elif [[ "${RELEASE}" == *"daily"* ]] || [ "${RELEASE}" == "dvd" ]; then + elif [[ "${RELEASE}" == "daily"* ]] || [ "${RELEASE}" == "dvd" ]; then URL="https://cdimage.ubuntu.com/${OS}/${RELEASE}/current" VM_PATH="${OS}-${RELEASE}" elif [ "${OS}" == "ubuntu" ]; then @@ -2227,16 +2513,26 @@ function get_ubuntu() { 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) + DATA=$(wget -qO- "${URL}/SHA256SUMS" | grep 'desktop\|dvd\|install' | grep amd64 | grep iso | grep -v "+mac") + ISO=$(cut -d'*' -f2 <<<${DATA} | sed '1q;d') + HASH=$(cut -d' ' -f1 <<<${DATA} | sed '1q;d') 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) + DATA=$(wget -qO- "${URL}/MD5SUMS" | grep 'desktop\|dvd\|install' | grep amd64 | grep iso | grep -v "+mac") + ISO=$(cut -d'*' -f2 <<<${DATA}) + HASH=$(cut -d' ' -f1 <<<${DATA}) fi - if [[ "${RELEASE}" == *"daily"* ]] || [ "${RELEASE}" == "dvd" ]; then + if [ -z $ISO ] || [ -z $HASH ]; then + echo "$(pretty_name $OS) ${RELEASE} is currently unavailable. Please select other OS/Release combination" + exit 1 + fi + + if [[ "${RELEASE}" == "daily"* ]] || [ "${RELEASE}" == "dvd" ]; then zsync_get "${URL}/${ISO}" "${VM_PATH}" "${OS}-devel.iso" make_vm_config "${OS}-devel.iso" + elif [[ "${RELEASE}" == "jammy-daily" ]]; then + zsync_get "${URL}/${ISO}" "${VM_PATH}" "${OS}-jammy-live.iso" + make_vm_config "${OS}-jammy-live.iso" else web_get "${URL}/${ISO}" "${VM_PATH}" check_hash "${ISO}" "${HASH}" @@ -2269,7 +2565,7 @@ function get_void() { local EDITION="${1:-}" local HASH="" local ISO="" - local URL="https://alpha.de.repo.voidlinux.org/live/current" + local URL="https://repo-default.voidlinux.org/live/current" DATE=$(wget -q -O- "${URL}/sha256sum.txt" | head -n1 | cut -d'.' -f1 | cut -d'-' -f4) case ${EDITION} in @@ -2292,7 +2588,7 @@ function get_voidpup() { echo "${URL} ${HASH}" } -function get_vx() { +function get_vxlinux() { local HASH="" local ISO="vx-${RELEASE}.iso" local URL="https://github.com/VX-Linux/main/releases/download/${RELEASE}" @@ -2301,7 +2597,7 @@ function get_vx() { echo "${URL}/${ISO} ${HASH}" } -function get_xero() { +function get_xerolinux() { local HASH="" local URL="" local ISO="xerolinux-2022.12-x86_64.iso" @@ -2607,48 +2903,190 @@ function unattended_windows() { EOF } +handle_curl_error() { + local error_code="$1" -function get_windows() { - # Use the iTechtics CDN to download the ISOs. - # - https://www.itechtics.com/windows-10-download-iso/ - # - https://www.itechtics.com/windows-11-download-iso/ - # 0 : Prompt for a manual ISO download - # 1 : Download automatically - local AUTO_DOWNLOAD=1 - local DOWNLOAD_URL="" + local fatal_error_action=2 - if [ ${AUTO_DOWNLOAD} -eq 1 ]; then - # Ignore the most recent Windows 10 release for now. - case ${RELEASE} in - 10) DOWNLOAD_URL="https://www.itechtics.com/?dl_id=173" - EDITION="22H2" - FILE_NAME="Win${RELEASE}_${EDITION}_EnglishInternational_x64v1.iso" - FILE_HASH="dc3982ad27e2d4e03b680630c28f824cb78bcd47" + case "$error_code" in + 6) + echo "Failed to resolve Microsoft servers! Is there an Internet connection? Exiting..." + return "$fatal_error_action" ;; - 11) DOWNLOAD_URL="https://www.itechtics.com/?dl_id=168" - EDITION="22H2" - FILE_NAME="Win${RELEASE}_${EDITION}_English_x64v1.iso" - FILE_HASH="c5341ba26e420684468fa4d4ab434823c9d1b61f" + 7) + echo "Failed to contact Microsoft servers! Is there an Internet connection or is the server down?" ;; + 23) + echo "Failed at writing Windows media to disk! Out of disk space or permission error? Exiting..." + return "$fatal_error_action" + ;; + 26) + echo "Ran out of memory during download! Exiting..." + return "$fatal_error_action" + ;; + 36) + echo "Failed to continue earlier download!" + ;; + 22) + echo "Microsoft servers returned failing HTTP status code!" + ;; + # POSIX defines exit statuses 1-125 as usable by us + # https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_08_02 + $((error_code <= 125))) + # Must be some other server error (possibly with this specific request/file) + # This is when accounting for all possible errors in the curl manual assuming a correctly formed curl command and HTTP(S) request, using only the curl features we're using, and a sane build + echo "Server returned an error status!" + ;; + 126 | 127) + echo "Curl command not found! Please install curl and try again. Exiting..." + return "$fatal_error_action" + ;; + # Exit statuses are undefined by POSIX beyond this point + *) + case "$(kill -l "$error_code")" in + # Signals defined to exist by POSIX: + # https://pubs.opengroup.org/onlinepubs/009695399/basedefs/signal.h.html + INT) + echo "Curl was interrupted!" + ;; + # There could be other signals but these are most common + SEGV | ABRT) + echo "Curl crashed! Failed exploitation attempt? Please report any core dumps to curl developers. Exiting..." + return "$fatal_error_action" + ;; + *) + echo "Curl terminated due to a fatal signal!" + ;; + esac esac - echo "Downloading Windows ${RELEASE} ${EDITION}..." - web_get "${DOWNLOAD_URL}" "${VM_PATH}" "${FILE_NAME}" + return 1 +} - check_hash "${FILE_NAME}" "${FILE_HASH}" - else - case ${RELEASE} in - 10) WINDOWS_ISO_URL="https://www.microsoft.com/software-download/windows10";; - 11) WINDOWS_ISO_URL="https://www.microsoft.com/software-download/windows11";; +function download_windows() { + # Download newer consumer Windows versions from behind gated Microsoft API + # This function aims to precisely emulate what Fido does down to the URL requests and HTTP headers (exceptions: updated user agent and referer adapts to Windows version instead of always being "windows11") but written in POSIX sh (with coreutils) and curl instead of PowerShell (also simplified to greatly reduce attack surface) + # However, differences such as the order of HTTP headers and TLS stacks (could be used to do TLS fingerprinting) still exist + # + # Command translated: ./Fido -Win 10 -Lang English -Verbose + # "English" = "English (United States)" (as opposed to the default "English (International)") + # For testing Fido, replace all "https://" with "http://" and remove all instances of "-MaximumRedirection 0" (to allow redirection of HTTP traffic to HTTPS) so HTTP requests can easily be inspected in Wireshark + # Fido (command-line only) works under PowerShell for Linux if that makes it easier for you + # UPDATE: Fido v1.4.2+ no longer works without being edited on Linux due to these issues on the Fido GitHub repo (and possibly others after these): #56 and #58 + # + # If this function in Mido fails to work for you then please test with the Fido script before creating an issue because we basically just copy what Fido does exactly: + # https://github.com/pbatard/Fido + + # Either 8, 10, or 11 + local windows_version="$1" + + local url="https://www.microsoft.com/en-us/software-download/windows$windows_version" + case "$windows_version" in + 8 | 10) url="${url}ISO";; esac - echo "######################################################################" - echo "# Download a Windows ${RELEASE} .iso image from:" - echo "# - ${WINDOWS_ISO_URL}" - echo "# Put the .iso image in the ${VM_PATH} directory and rename" - echo "# it to windows-${RELEASE}.iso." - echo "######################################################################" + local user_agent="Mozilla/5.0 (X11; Linux x86_64; rv:100.0) Gecko/20100101 Firefox/100.0" + # uuidgen: For MacOS (installed by default) and other systems (e.g. with no /proc) that don't have a kernel interface for generating random UUIDs + local session_id="$(cat /proc/sys/kernel/random/uuid 2> /dev/null || uuidgen --random)" + + # Get product edition ID for latest release of given Windows version + # Product edition ID: This specifies both the Windows release (e.g. 22H2) and edition ("multi-edition" is default, either Home/Pro/Edu/etc., we select "Pro" in the answer files) in one number + # This is the *only* request we make that Fido doesn't. Fido manually maintains a list of all the Windows release/edition product edition IDs in its script (see: $WindowsVersions array). This is helpful for downloading older releases (e.g. Windows 10 1909, 21H1, etc.) but we always want to get the newest release which is why we get this value dynamically + # Also, keeping a "$WindowsVersions" array like Fido does would be way too much of a maintenance burden + # Remove "Accept" header that curl sends by default + local iso_download_page_html="$(curl --silent --user-agent "$user_agent" --header "Accept:" --fail --proto =https --tlsv1.2 --http1.1 -- "$url")" || { + handle_curl_error $? + return $? + } + + # Limit untrusted size for input validation + iso_download_page_html="$(echo "$iso_download_page_html" | head -c 102400)" + # tr: Filter for only numerics to prevent HTTP parameter injection + # head -c was recently added to POSIX: https://austingroupbugs.net/view.php?id=407 + local product_edition_id="$(echo "$iso_download_page_html" | grep -Eo '