From 7a1ecea324e95218d37633b7e1d124a88407e0d9 Mon Sep 17 00:00:00 2001 From: Kroese Date: Sat, 27 Jan 2024 19:48:13 +0100 Subject: [PATCH] docs: Readme (#394) --- readme.md | 216 +++++++++++++++++++++++++++--------------------------- 1 file changed, 108 insertions(+), 108 deletions(-) diff --git a/readme.md b/readme.md index 17e909b..17cb06d 100644 --- a/readme.md +++ b/readme.md @@ -51,161 +51,161 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device ## FAQ - * ### How do I use it? +* ### How do I use it? - Very simple! These are the steps: + Very simple! These are the steps: - - Set the `BOOT` environment variable to the URL of an ISO image you want to install. + - Set the `BOOT` environment variable to the URL of an ISO image you want to install. - - Start the container and connect to [port 8006](http://localhost:8006) using your web browser. + - Start the container and connect to [port 8006](http://localhost:8006) using your web browser. - - You will see the screen and can now install the OS of your choice using your keyboard and mouse. + - 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! + Enjoy your brand new machine, and don't forget to star this repo! - * ### How do I increase the amount of CPU or RAM? +* ### How do I increase the amount of CPU or RAM? - By default, a single CPU core and 1 GB of RAM are allocated to the container. + By default, a single CPU core and 1 GB of RAM are allocated to the container. - To increase this, add the following environment variables: + To increase this, add the following environment variables: - ```yaml - environment: - RAM_SIZE: "4G" - CPU_CORES: "4" - ``` + ```yaml + environment: + RAM_SIZE: "4G" + CPU_CORES: "4" + ``` - * ### How do I change the size of the disk? +* ### How do I change the size of the disk? - To expand the default size of 16 GB, add the `DISK_SIZE` setting to your compose file and set it to your preferred capacity: + To expand the default size of 16 GB, add the `DISK_SIZE` setting to your compose file and set it to your preferred capacity: - ```yaml - environment: - DISK_SIZE: "128G" - ``` - - This can also be used to resize the existing disk to a larger capacity without any data loss. - - * ### How do I change the storage location? + ```yaml + environment: + DISK_SIZE: "128G" + ``` + + This can also be used to resize the existing disk to a larger capacity without any data loss. + +* ### How do I change the storage location? - To change the storage location, include the following bind mount in your compose file: + To change the storage location, include the following bind mount in your compose file: - ```yaml - volumes: - - /var/qemu:/storage - ``` + ```yaml + volumes: + - /var/qemu:/storage + ``` - Replace the example path `/var/qemu` with the desired storage folder. + Replace the example path `/var/qemu` with the desired storage folder. - * ### How do I boot Windows? +* ### How do I boot Windows? - To enable Windows booting, add the following line to your compose file: + To enable Windows booting, add the following line to your compose file: - ```yaml - environment: - BOOT_MODE: "windows" - ``` + ```yaml + environment: + BOOT_MODE: "windows" + ``` - But you might want to give [dockur/windows](https://github.com/dockur/windows) a try instead, as it includes all the drivers required during installation and many other features. + But you might want to give [dockur/windows](https://github.com/dockur/windows) a try instead, as it includes all the drivers required during installation and many other features. - * ### How do I verify if my system supports KVM? +* ### How do I verify if my system supports KVM? - To verify if your system supports KVM, run the following commands: + To verify if your system supports KVM, run the following commands: - ```bash - sudo apt install cpu-checker - sudo kvm-ok - ``` + ```bash + sudo apt install cpu-checker + sudo kvm-ok + ``` - If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check the virtualization settings in the BIOS. + If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check the virtualization settings in the BIOS. - * ### How do I assign an individual IP address to the container? +* ### 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. + 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: + 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. + ```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: + Once you have created the network, change your compose file to look as follows: - ```yaml - services: - qemu: - container_name: qemu - .... - networks: - vlan: - ipv4_address: 192.168.0.100 + ```yaml + services: + qemu: + container_name: qemu + .... + 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. + 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. - Please note that 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](https://blog.oddbit.com/post/2018-03-12-using-docker-macvlan-networks/#host-access) as a workaround. + Please note that 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](https://blog.oddbit.com/post/2018-03-12-using-docker-macvlan-networks/#host-access) as a workaround. - * ### How can the VM acquire an IP address from my router? +* ### How can the VM acquire an IP address from my router? - After configuring the container for macvlan (see above), it is possible for the VM to become part of your home network by requesting an IP from your router, just like your other devices. + After configuring the container for macvlan (see above), it is possible for the VM to become part of your home network by requesting an IP from your router, just like your other devices. - To enable this feature, add the following lines to your compose file: + To enable this feature, add the following lines to your compose file: - ```yaml - environment: - DHCP: "Y" - device_cgroup_rules: - - 'c *:* rwm' - ``` + ```yaml + environment: + DHCP: "Y" + device_cgroup_rules: + - 'c *:* rwm' + ``` - Please note that in this mode, the container and the VM will each have their own separate IPs. The container will keep the macvlan IP, and the VM will be reachable via the DHCP IP. + Please note that in this mode, the container and the VM will each have their own separate IPs. The container will keep the macvlan IP, and the VM will be reachable via the DHCP IP. - * ### How do I pass-through a disk? +* ### How do I pass-through a disk? - It is possible to pass-through disk devices directly by adding them to your compose file in this way: + It is possible to pass-through disk devices directly by adding them to your compose file in this way: - ```yaml - environment: - DEVICE: "/dev/sda" - DEVICE2: "/dev/sdb" - devices: - - /dev/sda - - /dev/sdb - ``` + ```yaml + environment: + DEVICE: "/dev/sda" + DEVICE2: "/dev/sdb" + devices: + - /dev/sda + - /dev/sdb + ``` - Use ```DEVICE``` if you want it to become your main drive, and use ```DEVICE2``` and higher to add them as secondary drives. - - * ### How do I boot with UEFI? + Use `DEVICE` if you want it to become your main drive, and use `DEVICE2` and higher to add them as secondary drives. + +* ### How do I boot with UEFI? - To enable UEFI booting, add the following line to your compose file: + To enable UEFI booting, add the following line to your compose file: - ```yaml - environment: - BOOT_MODE: "uefi" - ``` + ```yaml + environment: + BOOT_MODE: "uefi" + ``` - * ### How do I boot a local image? +* ### How do I boot a local image? - To skip the download, rename your image to `boot.iso` and place it in an empty `/storage` folder. + To skip the download, rename your image to `boot.iso` and place it in an empty `/storage` folder. - * ### How do I provide custom arguments to QEMU? +* ### How do I provide custom arguments to QEMU? - You can create the `ARGUMENTS` environment variable to provide additional arguments to QEMU at runtime: + You can create the `ARGUMENTS` environment variable to provide additional arguments to QEMU at runtime: - ```yaml - environment: - ARGUMENTS: "-device usb-tablet" - ``` + ```yaml + environment: + ARGUMENTS: "-device usb-tablet" + ``` [build_url]: https://github.com/qemus/qemu-docker/ [hub_url]: https://hub.docker.com/r/qemux/qemu-docker/