diff --git a/docs/docker.md b/docs/docker.md index 1b752fd..54a19e6 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -2,19 +2,22 @@ Although WinApps supports using `QEMU+KVM+libvirt` as a backend for running Windows virtual machines, it is recommended to use `Docker` or `Podman`. These backends automate the setup process, eliminating the need for manual configuration and optimisation of the Windows virtual machine. > [!IMPORTANT] -Running a Windows virtual machine using `Docker` or `Podman` as a backend is only possible on GNU/Linux systems. This is due to the necessity of kernel interfaces, such as the KVM hypervisor, for achieving acceptable performance. The performance of the virtual machine can vary based on the version of the Linux kernel, with newer releases generally offering better performance. +> Running a Windows virtual machine using `Docker` or `Podman` as a backend is only possible on GNU/Linux systems. This is due to the necessity of kernel interfaces, such as the KVM hypervisor, for achieving acceptable performance. The performance of the virtual machine can vary based on the version of the Linux kernel, with newer releases generally offering better performance. > [!IMPORTANT] -> WinApps does NOT officially support versions of Windows prior to Windows 10. Despite this, it may be possible to achieve a successful installation with some additional experimentation. If you find a way to achieve this, please share your solution through a pull request for the benefit of other users. +> WinApps does __NOT__ officially support versions of Windows prior to Windows 10. Despite this, it may be possible to achieve a successful installation with some additional experimentation. If you find a way to achieve this, please share your solution through a pull request for the benefit of other users. ## `Docker` ### Installation You can find a guide for installing `Docker Engine` [here](https://docs.docker.com/engine/install/). ### Setup `Docker` Container -WinApps utilises `docker compose` to configure Windows VMs. A suitable [`compose.yaml`](https://github.com/winapps-org/winapps/blob/main/compose.yaml) file is included in the root directory of the WinApps repository. +WinApps utilises `docker compose` to configure Windows VMs. -Prior to initiating the installation, you can modify the RAM and number of CPU cores available to the Windows VM by changing `RAM_SIZE` and `CPU_CORES` within `compose.yaml`. +> [!IMPORTANT] +> The [`compose.yaml`](https://github.com/winapps-org/winapps/blob/main/compose.yaml) file located within the root directory of the WinApps repository must be manually copied to `~/.config/winapps/compose.yaml`. + +Prior to installing Windows, you can modify the RAM and number of CPU cores available to the Windows VM by changing `RAM_SIZE` and `CPU_CORES` within `compose.yaml`. It is also possible to specify the version of Windows you wish to install within `compose.yaml` by modifying `VERSION`. @@ -24,9 +27,9 @@ It is also possible to specify the version of Windows you wish to install within Please refer to the [original GitHub repository](https://github.com/dockur/windows) for more information on additional configuration options. ### Installing Windows -After navigating into the cloned WinApps repository, you can initiate the Windows installation using `docker compose`. +You can initiate the Windows installation using `docker compose`. ```bash -docker compose up +docker compose --file ~/.config/winapps/compose.yaml up ``` You can then access the Windows virtual machine via a VNC connection to complete the Windows setup by navigating to http://127.0.0.1:8006 in your web browser. @@ -34,22 +37,31 @@ You can then access the Windows virtual machine via a VNC connection to complete ### Installing WinApps `Docker` simplifies the WinApps installation process by eliminating the need for any additional configuration of the Windows virtual machine. Once the Windows virtual machine is up and running, you can directly launch the WinApps installer, which should automatically detect and interface with Windows. +> [!NOTE] +> Since no Windows user password is set by default, Windows may automatically log in, which may cause the WinApps installation to fail due to complications establishing an RDP connection. To avoid this issue, please use the VNC connection to ensure that the Windows user is logged out before starting the WinApps installation. + ```bash ./installer.sh ``` -### Subsequent Use +### Changing `compose.yaml` +Changes require the Windows virtual machine to be removed and re-created using the updated `compose.yaml`. This should __NOT__ affect your data. + ```bash -docker compose start # Power on the Windows VM -docker compose pause # Pause the Windows VM -docker compose unpause # Resume the Windows VM -docker compose restart # Restart the Windows VM -docker compose stop # Gracefully shut down the Windows VM -docker compose kill # Force shut down the Windows VM +docker compose --file ~/.config/winapps/compose.yaml down # Stop and remove the existing Windows virtual machine. +rm ~/.config/freerdp/server/127.0.0.1_3389.pem # Remove the existing FreeRDP certificate (a new certificate will be created automatically when connecting to the new virtual machine for the first time). +docker compose --file ~/.config/winapps/compose.yaml up # Re-create the virtual machine with the updated configuration. ``` -> [!NOTE] -> The above `docker compose` commands must be run within the same directory containing `compose.yaml`. +### Subsequent Use +```bash +docker compose --file ~/.config/winapps/compose.yaml start # Power on the Windows VM +docker compose --file ~/.config/winapps/compose.yaml pause # Pause the Windows VM +docker compose --file ~/.config/winapps/compose.yaml unpause # Resume the Windows VM +docker compose --file ~/.config/winapps/compose.yaml restart # Restart the Windows VM +docker compose --file ~/.config/winapps/compose.yaml stop # Gracefully shut down the Windows VM +docker compose --file ~/.config/winapps/compose.yaml kill # Force shut down the Windows VM +``` ## `Podman` ### Installation @@ -63,9 +75,9 @@ Please follow the [`docker` instructions](#setup-docker-container). > Ensure `WAFLAVOR` is set to `"podman"` in `~/.config/winapps/winapps.conf`. ### Installing Windows -After navigating into the cloned WinApps repository, you can initiate the Windows installation using `podman-compose`. +You can initiate the Windows installation using `podman-compose`. ```bash -podman-compose up +podman-compose --file ~/.config/winapps/compose.yaml up ``` You can then access the Windows virtual machine via a VNC connection to complete the Windows setup by navigating to http://127.0.0.1:8006 in your web browser. @@ -73,15 +85,15 @@ You can then access the Windows virtual machine via a VNC connection to complete ### Installing WinApps Please follow the [`docker` instructions](#installing-winapps). +### Changing `compose.yaml` +Please follow the [`docker` instructions](#changing-composeyaml). + ### Subsequent Use ```bash -podman-compose start # Power on the Windows VM -podman-compose pause # Pause the Windows VM -podman-compose unpause # Resume the Windows VM -podman-compose restart # Restart the Windows VM -podman-compose stop # Gracefully shut down the Windows VM -podman-compose kill # Force shut down the Windows VM +podman-compose --file ~/.config/winapps/compose.yaml start # Power on the Windows VM +podman-compose --file ~/.config/winapps/compose.yaml pause # Pause the Windows VM +podman-compose --file ~/.config/winapps/compose.yaml unpause # Resume the Windows VM +podman-compose --file ~/.config/winapps/compose.yaml restart # Restart the Windows VM +podman-compose --file ~/.config/winapps/compose.yaml stop # Gracefully shut down the Windows VM +podman-compose --file ~/.config/winapps/compose.yaml kill # Force shut down the Windows VM ``` - -> [!NOTE] -> The above `podman-compose` commands must be run within the same directory containing `compose.yaml`. diff --git a/docs/libvirt.md b/docs/libvirt.md index c489960..27d2fae 100644 --- a/docs/libvirt.md +++ b/docs/libvirt.md @@ -26,20 +26,40 @@ Together, these components form a powerful and flexible virtualization stack, wi sudo emerge app-emulation/virt-manager # Gentoo Linux ``` -3. Download a [Windows 10](https://www.microsoft.com/software-download/windows10ISO) or [Windows 11](https://www.microsoft.com/software-download/windows11) installation `.ISO` image. +3. Configure `libvirt` to use the 'system' URI by adding the line `LIBVIRT_DEFAULT_URI="qemu:///system"` to your preferred shell profile file. + ```bash + echo "export LIBVIRT_DEFAULT_URI=\"qemu:///system\"" >> ~/.bashrc + ``` + +4. Install `QEMU Guest Agent`. + ```bash + sudo apt install qemu-guest-agent # Debian/Ubuntu + sudo dnf install qemu-guest-agent # Fedora/RHEL + sudo pacman -S qemu-guest-agent # Arch Linux + sudo emerge app-emulation/qemu-guest-agent # Gentoo Linux + sudo systemctl enable qemu-guest-agent + sudo systemctl start qemu-guest-agent + ``` + +> [!NOTE] +> `QEMU Guest Agent` is a helper daemon used to exchange information and commands between host and guest operating systems. +> You can read more about `QEMU Guest Agent` [here](https://pve.proxmox.com/wiki/Qemu-guest-agent). + +5. Download a [Windows 10](https://www.microsoft.com/software-download/windows10ISO) or [Windows 11](https://www.microsoft.com/software-download/windows11) installation `.ISO` image. > [!IMPORTANT] > 'Professional', 'Enterprise' or 'Server' editions of Windows are required to run RDP applications. Windows 'Home' will NOT suffice. -4. Download [VirtIO drivers](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso) for the Windows virtual machine. +6. Download [VirtIO drivers](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/latest-virtio/virtio-win.iso) for the Windows virtual machine. > [!NOTE] > VirtIO drivers enhance system performance and minimize overhead by enabling the Windows virtual machine to use specialised network and disk device drivers. These drivers are aware that they are operating inside a virtual machine, and cooperate with the hypervisor. This approach eliminates the need for the hypervisor to emulate physical hardware devices, which is a computationally expensive process. This setup allows guests to achieve high-performance network and disk operations, leveraging the benefits of paravirtualisation. -> You can read more about `VirtIO` [here](https://wiki.libvirt.org/Virtio.html). +> The above link contains the latest release of the `VirtIO` drivers for Windows, compiled and signed by Red Hat. Older versions of the `VirtIO` drivers can be downloaded [here](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/?C=M;O=D). +> You can read more about `VirtIO` [here](https://wiki.libvirt.org/Virtio.html) and [here](https://developer.ibm.com/articles/l-virtio/). ## Creating a Windows VM - -> [!NOTE] If you are an expert user, you may wish to: +> [!NOTE] +> If you are an expert user, you may wish to: > - [Define a Windows virtual machine from an existing `.XML` file](#defining-windows-vm-from-xml) > - [Configure Rootless `libvirt`](#configuring-rootless-libvirt) @@ -104,10 +124,111 @@ Together, these components form a powerful and flexible virtualization stack, wi

-10. (Optional) Configure 'CPU pinning' by following [this excellent guide](https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF#CPU_pinning). +10. (Optional) Assign specific physical CPU cores to the virtual machine. This can improve performance by reducing context switching and ensuring that the virtual machine's workload consistently uses the same cores, leading to better CPU cache utilisation. + 1. Run `lscpu -e` to determine which L1, L2 and L3 caches are associated with which CPU cores. + + Example 1 (Intel 11th Gen Core i7-1185G7): + ``` + CPU NODE SOCKET CORE L1d:L1i:L2:L3 ONLINE MAXMHZ MINMHZ + 0 0 0 0 0:0:0:0 yes 4800.0000 400.0000 + 1 0 0 1 1:1:1:0 yes 4800.0000 400.0000 + 2 0 0 2 2:2:2:0 yes 4800.0000 400.0000 + 3 0 0 3 3:3:3:0 yes 4800.0000 400.0000 + 4 0 0 0 0:0:0:0 yes 4800.0000 400.0000 + 5 0 0 1 1:1:1:0 yes 4800.0000 400.0000 + 6 0 0 2 2:2:2:0 yes 4800.0000 400.0000 + 7 0 0 3 3:3:3:0 yes 4800.0000 400.0000 + ``` + + - C0 = T0+T4 → L10+L20+L30 + - C1 = T1+T5 → L11+L21+L30 + - C2 = T2+T6 → L12+L22+L30 + - C3 = T3+T7 → L13+L23+L30 + + Example 2 (AMD Ryzen 5 1600): + ``` + CPU NODE SOCKET CORE L1d:L1i:L2:L3 ONLINE MAXMHZ MINMHZ + 0 0 0 0 0:0:0:0 yes 3800.0000 1550.0000 + 1 0 0 0 0:0:0:0 yes 3800.0000 1550.0000 + 2 0 0 1 1:1:1:0 yes 3800.0000 1550.0000 + 3 0 0 1 1:1:1:0 yes 3800.0000 1550.0000 + 4 0 0 2 2:2:2:0 yes 3800.0000 1550.0000 + 5 0 0 2 2:2:2:0 yes 3800.0000 1550.0000 + 6 0 0 3 3:3:3:1 yes 3800.0000 1550.0000 + 7 0 0 3 3:3:3:1 yes 3800.0000 1550.0000 + 8 0 0 4 4:4:4:1 yes 3800.0000 1550.0000 + 9 0 0 4 4:4:4:1 yes 3800.0000 1550.0000 + 10 0 0 5 5:5:5:1 yes 3800.0000 1550.0000 + 11 0 0 5 5:5:5:1 yes 3800.0000 1550.0000 + ``` + + - C0 = T0+T1 → L10+L20+L30 + - C1 = T2+T3 → L11+L21+L30 + - C2 = T4+T5 → L12+L22+L30 + - C3 = T6+T7 → L13+L23+L31 + - C4 = T8+T9 → L14+L24+L31 + - C5 = T10+T11 → L15+L25+L31 + + 2. Select which CPU cores to 'pin'. You should aim to select a combination of CPU cores that minimises sharing of caches between Windows and GNU/Linux. + + Example 1: + - CPU cores share the same singular L3 cache, so this cannot be optimised. + - CPU cores utilise different L1 and L2 caches, so isolatng corresponding thread pairs will help improve performance. + - Thus, if limiting the virtual machine to a maximum of 4 threads, there are 10 possible optimal configurations: + - T0+T4 + - T1+T5 + - T2+T6 + - T3+T7 + - T0+T4+T1+T5 + - T0+T4+T2+T6 + - T0+T4+T3+T7 + - T1+T5+T2+T6 + - T1+T5+T3+T7 + - T2+T6+T3+T7 + + Example 2: + - Threads 0-5 utilise one L3 cache whereas threads 6-11 utilise a different L3 cache. Thus, one of these two sets of threads should be pinned to the virtual machine. + - Pinning and isolating fewer than these (e.g. threads 8-11) would result in the host system making use of the L3 cache in threads 6 and 7, resulting in cache evictions and therefore bad performance. + - Thus, there are only two possible optimal configurations: + - T0+T1+T2+T3+T4+T5 + - T6+T7+T8+T9+T10+T11 + + 3. Prepare and add/modify the following to the ``, `` and `` sections, adjusting the values to match your selected threads. + + Example 1: The following selects 'T2+T6+T3+T7'. + + ```xml + 4 + + + + + + + + + + ``` + + Example 2: The following selects 'T6+T7+T8+T9+T10+T11'. + + ```xml + 6 + + + + + + + + + + + + ``` > [!NOTE] -> CPU pinning involves assigning specific physical CPU cores to a virtual machine. This can improve performance by reducing context switching and ensuring that the VM's workload consistently uses the same cores, leading to better CPU cache utilisation. +> More information on configuring CPU pinning can be found in [this excellent guide](https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF#CPU_pinning). 11. Navigate to the `XML` tab, and edit the `` section to disable all timers except for the hypervclock, thereby drastically reducing idle CPU usage. Once changed, click `Apply`. ```xml @@ -147,31 +268,41 @@ Together, these components form a powerful and flexible virtualization stack, wi > [!NOTE] > Hyper-V enlightenments make Windows (and other Hyper-V guests) think they are running on top of a Hyper-V compatible hypervisor. This enables use of Hyper-V specific features, allowing `KVM` to implement paravirtualised interfaces for improved virtual machine performance. -13. In the 'Memory' section, set the `Current allocation` to the minimum amount of memory you want the virtual machine to use, with a recommended value of `1024MB`. +13. Add the following XML snippet within the `` section to enable the GNU/Linux host to communicate with Windows using `QEMU Guest Agent`. + + ```xml + + + +
+ + ``` + +14. In the 'Memory' section, set the `Current allocation` to the minimum amount of memory you want the virtual machine to use, with a recommended value of `1024MB`.

-14. (Optional) Under `Boot Options`, enable `Start virtual machine on host boot up`. +15. (Optional) Under `Boot Options`, enable `Start virtual machine on host boot up`.

-15. Navigate to 'SATA Disk 1' and set the `Disk bus` type to `VirtIO`. This allows disk access to be paravirtualised, improving virtual machine performance. +16. Navigate to 'SATA Disk 1' and set the `Disk bus` type to `VirtIO`. This allows disk access to be paravirtualised, improving virtual machine performance.

-16. Navigate to 'NIC' and set the `Device model` type to `virtio` to enable paravirtualised networking. +17. Navigate to 'NIC' and set the `Device model` type to `virtio` to enable paravirtualised networking.

-17. Click the `Add Hardware` button in the lower left, and choose `Storage`. For `Device type`, select `CDROM device` and choose the VirtIO driver `.ISO` you downloaded earlier. Click `Finish` to add the new CD-ROM device. +18. Click the `Add Hardware` button in the lower left, and choose `Storage`. For `Device type`, select `CDROM device` and choose the VirtIO driver `.ISO` you downloaded earlier. Click `Finish` to add the new CD-ROM device. > [!IMPORTANT] > If you skip this step, the Windows installer will fail to recognise and list the virtual hard drive you created earlier. @@ -180,7 +311,7 @@ Together, these components form a powerful and flexible virtualization stack, wi

-18. Click `Begin Installation` in the top left. +19. Click `Begin Installation` in the top left.

@@ -367,6 +498,11 @@ Below is an example `.XML` file that describes a Windows 11 virtual machine.

+ + + +
+
@@ -458,7 +594,7 @@ Following the above, choose to `Continue with limited setup`.

## Final Configuration Steps -Open `File Explorer` and navigate to the drive where the `VirtIO` driver `.ISO` is mounted. Run `virt-win-gt-64.exe` to launch the `VirtIO` driver installer. +Open `File Explorer` and navigate to the drive where the `VirtIO` driver `.ISO` is mounted. Run `virtio-win-gt-x64.exe` to launch the `VirtIO` driver installer.

@@ -470,7 +606,21 @@ Leave everything as default and click `Next` through the installer. This will in

-Once you finish the `VirtIO` driver installation, you will need to make some registry changes to enable RDP Applications to run on the system. Start by downloading the [RDPApps.reg](/install/RDPApps.reg) file, right-clicking on the `Raw` button, and clicking on `Save target as`. +Next, install the `QEMU Guest Agent` within Windows. This agent allows the GNU/Linux host to request a graceful shutdown of the Windows system. To do this, either run `virtio-win-guest-tools.exe` or `guest-agent\qemu-ga-x86_64.msi`. You can confirm the guest agent was successfully installed by running `Get-Service QEMU-GA` within a PowerShell window. The output should resemble: + +``` +Status Name DisplayName +------ ---- ----------- +Running QEMU-GA QEMU Guest Agent +``` + +You can then test whether the host GNU/Linux system can communicate with Windows via `QEMU Guest Agent` by running `virsh qemu-agent-command RDPWindows '{"execute":"guest-info"}'`. The output should resemble: + +``` +{"return":{"version":"107.0.1","supported_commands":[{"enabled":true,"name":"guest-get-cpustats","success-response":true},{"enabled":true,"name":"guest-get-diskstats","success-response":true},{"enabled":true,"name":"guest-get-devices","success-response":true},{"enabled":true,"name":"guest-get-osinfo","success-response":true},{"enabled":true,"name":"guest-get-timezone","success-response":true},{"enabled":true,"name":"guest-get-users","success-response":true},{"enabled":true,"name":"guest-get-host-name","success-response":true},{"enabled":true,"name":"guest-exec","success-response":true},{"enabled":true,"name":"guest-exec-status","success-response":true},{"enabled":false,"name":"guest-get-memory-block-info","success-response":true},{"enabled":false,"name":"guest-set-memory-blocks","success-response":true},{"enabled":false,"name":"guest-get-memory-blocks","success-response":true},{"enabled":true,"name":"guest-set-user-password","success-response":true},{"enabled":true,"name":"guest-get-fsinfo","success-response":true},{"enabled":true,"name":"guest-get-disks","success-response":true},{"enabled":false,"name":"guest-set-vcpus","success-response":true},{"enabled":true,"name":"guest-get-vcpus","success-response":true},{"enabled":true,"name":"guest-network-get-interfaces","success-response":true},{"enabled":false,"name":"guest-suspend-hybrid","success-response":false},{"enabled":true,"name":"guest-suspend-ram","success-response":false},{"enabled":true,"name":"guest-suspend-disk","success-response":false},{"enabled":true,"name":"guest-fstrim","success-response":true},{"enabled":true,"name":"guest-fsfreeze-thaw","success-response":true},{"enabled":true,"name":"guest-fsfreeze-freeze-list","success-response":true},{"enabled":true,"name":"guest-fsfreeze-freeze","success-response":true},{"enabled":true,"name":"guest-fsfreeze-status","success-response":true},{"enabled":true,"name":"guest-file-flush","success-response":true},{"enabled":true,"name":"guest-file-seek","success-response":true},{"enabled":true,"name":"guest-file-write","success-response":true},{"enabled":true,"name":"guest-file-read","success-response":true},{"enabled":true,"name":"guest-file-close","success-response":true},{"enabled":true,"name":"guest-file-open","success-response":true},{"enabled":true,"name":"guest-shutdown","success-response":false},{"enabled":true,"name":"guest-info","success-response":true},{"enabled":true,"name":"guest-set-time","success-response":true},{"enabled":true,"name":"guest-get-time","success-response":true},{"enabled":true,"name":"guest-ping","success-response":true},{"enabled":true,"name":"guest-sync","success-response":true},{"enabled":true,"name":"guest-sync-delimited","success-response":true}]}} +``` + +Next, you will need to make some registry changes to enable RDP Applications to run on the system. Start by downloading the [RDPApps.reg](/install/RDPApps.reg) file, right-clicking on the `Raw` button, and clicking on `Save target as`.

diff --git a/install/ExtractPrograms.ps1 b/install/ExtractPrograms.ps1 index eff0a08..16284fd 100644 --- a/install/ExtractPrograms.ps1 +++ b/install/ExtractPrograms.ps1 @@ -212,7 +212,12 @@ Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\*" | Where-Object {$_."(default)" -ne $null} | ForEach-Object { $Exe = $_."(default)".Trim('"') - $Name = (Get-Item $Exe).VersionInfo.FileDescription.Trim() -replace " "," " + $Item = Get-Item $Exe + if ($Item.VersionInfo.FileDescription) { + $Name = $Item.VersionInfo.FileDescription.Trim() -replace " ", " " + } else { + $Name = [System.IO.Path]::GetFileNameWithoutExtension($Exe) + } $Icon = Get-Icon -Path $Exe -ToBase64 #Get-ItemProperty $Exe -Name VersionInfo "NAMES+=(""$Name"")" diff --git a/installer.sh b/installer.sh index 842fba1..98468ad 100755 --- a/installer.sh +++ b/installer.sh @@ -1543,9 +1543,9 @@ function waUninstall() { done # Print caveats. - echo -e "\n${INFO_TEXT}Please note your WinApps configuration file was not removed.${CLEAR_TEXT}" + echo -e "\n${INFO_TEXT}Please note your WinApps configuration folder was not removed.${CLEAR_TEXT}" echo -e "${INFO_TEXT}You can remove this manually by running:${CLEAR_TEXT}" - echo -e "${COMMAND_TEXT}rm ${CONFIG_PATH}${CLEAR_TEXT}\n" + echo -e "${COMMAND_TEXT}rm $(dirname "$CONFIG_PATH")${CLEAR_TEXT}\n" # Print feedback. echo -e "${SUCCESS_TEXT}UNINSTALLATION COMPLETE.${CLEAR_TEXT}"