winapps/docs/docker.md

Creating a Windows VM in Docker or Podman

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.

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. Possible setup instructions for Windows 10:

• 'Professional', 'Enterprise' or 'Server' editions of Windows are required to run RDP applications. Windows 'Home' will NOT suffice.
• It is recommended to edit the initial compose.yaml file to keep your required username and password from the beginning.
• It is recommended to not use sudo to force commands to run. Add your user to the relevant permissions group wherever possible.

Important

The iptables kernel module must be loaded for folder sharing with the host to work. Check that the output of lsmod | grep ip_tables and lsmod | grep iptable_nat is non empty. If the output of one of the previous command is empty, run echo -e "ip_tables\niptable_nat" | sudo tee /etc/modules-load.d/iptables.conf and reboot.

Docker

Installation

You can find a guide for installing Docker Engine here.

Setup Docker Container

WinApps utilises docker compose to configure Windows VMs. A template compose.yaml is provided.

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.

Please refer to the original GitHub repository for more information on additional configuration options.

Note

If you want to undo all your changes and start from scratch, run the following. For podman, replace docker compose with podman-compose.

docker compose down --rmi=all --volumes

Installing Windows

You can initiate the Windows installation using docker compose.

cd winapps
docker compose --file ./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.

Changing compose.yaml

Changes to compose.yaml require the container to be removed and re-created. This should NOT affect your data.

# Stop and remove the existing container.
docker compose --file ~/.config/winapps/compose.yaml down

# Remove the existing FreeRDP certificate (if required).
# Note: A new certificate will be created when connecting via RDP for the first time.
rm ~/.config/freerdp/server/127.0.0.1_3389.pem

# Re-create the container with the updated configuration.
# Add the -d flag at the end to run the container in the background.
docker compose --file ~/.config/winapps/compose.yaml up

Subsequent Use

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

1. Install Podman using this guide.
2. Install podman-compose using this guide.

Setup Podman Container

Please follow the docker instructions.

Note

Rootless podman containers

If you are invoking podman as a user, your container will be "rootless". This can be desirable as a security feature. However, you may encounter an error about missing permissions to /dev/kvm as a consequence.

For rootless podman to work, you need to add your user to the kvm group (depending on your distribution) to be able to access /dev/kvm. Make sure that you are using crun as your container runtime, not runc. Usually this is done by stopping all containers and (de-)installing the corresponding packages. Then either invoke podman-compose as podman-compose --file ./compose.yaml --podman-create-args '--group-add keep-groups' up. Or edit compose.yaml and uncomment the group_add: section at the end.

Important

Ensure WAFLAVOR is set to "podman" in ~/.config/winapps/winapps.conf.

Installing Windows

You can initiate the Windows installation using podman-compose.

cd winapps
podman-compose --file ./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.

Changing compose.yaml

Changes to compose.yaml require the container to be removed and re-created. This should NOT affect your data.

# Stop and remove the existing container.
podman-compose --file ~/.config/winapps/compose.yaml down

# Remove the existing FreeRDP certificate (if required).
# Note: A new certificate will be created when connecting via RDP for the first time.
rm ~/.config/freerdp/server/127.0.0.1_3389.pem

# Re-create the container with the updated configuration.
podman-compose --file ~/.config/winapps/compose.yaml up

Subsequent Use

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