QEMU

Docker container for running virtual machines using QEMU.

Features ✨

• Web-based viewer to control the machine directly from your browser

• Supports .iso, .img, .qcow2, .vhd, .vhdx, .vdi, .vmdk and .raw disk formats

• High-performance options (like KVM acceleration, kernel-mode networking, IO threading, etc.) to achieve near-native speed

Usage 🐳

Via Docker Compose:

yaml
services:
  qemu:
    image: qemux/qemu
    container_name: qemu
    environment:
      BOOT: "mint"
    devices:
      - /dev/kvm
      - /dev/net/tun
    cap_add:
      - NET_ADMIN
    ports:
      - 8006:8006
    volumes:
      - ./qemu:/storage
    restart: always
    stop_grace_period: 2m

Via Docker CLI:

bash
docker run -it --rm --name qemu -e "BOOT=mint" -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v "${PWD:-.}/qemu:/storage" --stop-timeout 120 docker.io/qemux/qemu

Via Kubernetes:

shell
kubectl apply -f [***]

Via Github Codespaces:

![Open in GitHub Codespaces]([***]

FAQ 💬

How do I use it?

Very simple! These are the steps:

• Set the BOOT variable to the operating system you want to install.

• Start the container and connect to port 8006 using your web browser.

• You will see the screen and can now install the OS of your choice using your keyboard and mouse.

Enjoy your brand new machine, and don't forget to star this repo!

How do I select the operating system?

You can use the BOOT environment variable in order to specify the operating system that will be downloaded:

yaml
environment:
  BOOT: "mint"

Select from the values below:

How can I use my own image?

If you want to download an operating system that is not in the list above, you can set the BOOT variable to the URL of the image:

yaml
environment:
  BOOT: "[***]"

The BOOT URL accepts files in any of the following formats:

It will also accept files such as .img.gz, .qcow2.xz, .iso.zip and many more, because it will automatically extract compressed files.

Alternatively you can use a local image file directly, by binding it in your compose file:

yaml
volumes:
  - ./example.iso:/boot.iso

This way you can supply either a /boot.iso, /boot.img or a /boot.qcow2 file. The value of BOOT will be ignored in this case.

How do I change the storage location?

To change the storage location, include the following bind mount in your compose file:

yaml
volumes:
  - ./qemu:/storage

Replace the example path ./qemu with the desired storage folder or named volume.

How do I change the size of the disk?

To expand the default size of 64 GB, add the DISK_SIZE setting to your compose file and set it to your preferred capacity:

yaml
environment:
  DISK_SIZE: "128G"

[!TIP] This can also be used to resize the existing disk to a larger capacity without any data loss.

How do I change the amount of CPU or RAM?

By default, the VM will be allowed to use 2 CPU cores and 2 GB of RAM.

If you want to adjust this, you can specify the desired amount using the following environment variables:

yaml
environment:
  RAM_SIZE: "8G"
  CPU_CORES: "4"

How do I boot ARM64 images?

You can use the qemu-arm container to run ARM64-based images.

How do I boot Windows?

Use dockur/windows instead, as it includes all the drivers required during installation, amongst many other features.

How do I boot macOS?

Use dockur/macos instead, as it uses all the right settings and automatically downloads the installation files.

How do I boot without UEFI?

By default, the machine will boot with UEFI enabled. If your OS does not support that, you can boot with a legacy BIOS:

yaml
environment:
  BOOT_MODE: "legacy"

How do I boot without VirtIO drivers?

By default, the machine makes use of virtio-scsi drives for performance reasons, and even though most Linux kernels bundle the necessary driver for this device, that may not always be the case for other operating systems.

If your machine fails to detect the hard drive, you can modify your compose file to use virtio-blk instead:

yaml
environment:
  DISK_TYPE: "blk"

If it still fails to boot, you can set the value to ide to emulate a IDE drive, which is relatively slow but requires no drivers and is compatible with almost every system.

How do I verify if my system supports KVM?

First check if your software is compatible using this chart:

After that you can run the following commands in Linux to check your system:

bash
sudo apt install cpu-checker
sudo kvm-ok

If you receive an error from kvm-ok indicating that KVM cannot be used, please check whether:

• the virtualization extensions (Intel VT-x or AMD SVM) are enabled in your BIOS.

• you enabled "nested virtualization" if you are running the container inside a virtual machine.

• you are not using a cloud provider, as most of them do not allow nested virtualization for their VPS's.

If you did not receive any error from kvm-ok but the container still complains about a missing KVM device, it could help to add privileged: true to your compose file (or sudo to your docker command) to rule out any permission issue.

How do I expose network ports?

When using bridge networking, you can expose ports by adding them to your compose file. If you want to be able to connect to the SSH service of the machine for example, you would add it like this:

yaml
ports:
  - 2222:22

This will make port 2222 on your host redirect to port 22 of the virtual machine.

When using user-mode networking (for example when running under Podman), you will also need to add those ports to the USER_PORTS variable like this:

yaml
environment:
  USER_PORTS: "22,80,443"

How do I assign an individual IP address to the container?

By default, the container uses bridge networking, which shares the IP address with the host.

If you want to assign an individual IP address to the container, you can create a macvlan network as follows:

bash
docker network create -d macvlan \
    --subnet=192.168.0.0/24 \
    --gateway=192.168.0.1 \
    --ip-range=192.168.0.100/28 \
    -o parent=eth0 vlan

Be sure to modify these values to match your local subnet.

Once you have created the network, change your compose file to look as follows:

yaml
services:
  qemu:
    container_name: qemu
    ..<snip>..
    networks:
      vlan:
        ipv4_address: 192.168.0.100

networks:
  vlan:
    external: true

An added benefit of this approach is that you won't have to perform any port mapping anymore, since all ports will be exposed by default.

[!IMPORTANT] This IP address won't be accessible from the Docker host due to the design of macvlan, which doesn't permit communication between the two. If this is a concern, you need to create a second macvlan as a workaround.

How can the VM acquire an IP address from my router?

After configuring the container for macvlan, it is possible for the VM to become part of your home network by requesting an IP from your router, just like a real PC.

To enable this mode, in which the container and the VM will have separate IP addresses, add the following lines to your compose file:

yaml
environment:
  DHCP: "Y"
devices:
  - /dev/vhost-net
device_cgroup_rules:
  - 'c *:* rwm'

How do I add multiple disks?

To create additional disks, modify your compose file like this:

yaml
environment:
  DISK2_SIZE: "32G"
  DISK3_SIZE: "64G"
volumes:
  - ./example2:/storage2
  - ./example3:/storage3

How do I pass-through a disk?

It is possible to pass-through disk devices or partitions directly by adding them to your compose file in this way:

yaml
devices:
  - /dev/sdb:/disk1
  - /dev/sdc1:/disk2

Use /disk1 if you want it to become your main drive, and use /disk2 and higher to add them as secondary drives.

How do I pass-through a USB device?

To pass-through a USB device, first lookup its vendor and product id via the lsusb command, then add them to your compose file like this:

yaml
environment:
  ARGUMENTS: "-device usb-host,vendorid=0x1234,productid=0x1234"
devices:
  - /dev/bus/usb

How do I share files with the host?

To share files with the host, first ensure that your guest OS has 9pfs support compiled in or available as a kernel module. If so, add the following volume to your compose file:

yaml
volumes:
  - ./example:/shared

Then start the container and execute the following command in the guest:

shell
mount -t 9p -o trans=virtio shared /mnt/example

Now the ./example directory on the host will be available as /mnt/example in the guest.

How can I provide custom arguments to QEMU?

You can create the ARGUMENTS environment variable to provide additional arguments to QEMU at runtime:

yaml
environment:
  ARGUMENTS: "-device usb-tablet"

If you want to see the full command-line arguments used, you can set:

yaml
environment:
  DEBUG: "Y"

Stars 🌟

![Stars]([***]