docs: Readme (#394)

This commit is contained in:
Kroese 2024-01-27 19:48:13 +01:00 committed by GitHub
parent 26ccc83eab
commit 7a1ecea324
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -51,7 +51,7 @@ 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:
@ -63,7 +63,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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.
@ -75,7 +75,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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:
@ -86,7 +86,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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?
* ### How do I change the storage location?
To change the storage location, include the following bind mount in your compose file:
@ -97,7 +97,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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:
@ -108,7 +108,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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:
@ -119,7 +119,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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.
@ -155,7 +155,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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.
@ -170,7 +170,7 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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:
@ -183,9 +183,9 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
- /dev/sdb
```
Use ```DEVICE``` if you want it to become your main drive, and use ```DEVICE2``` and higher to add them as secondary drives.
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?
* ### How do I boot with UEFI?
To enable UEFI booting, add the following line to your compose file:
@ -194,11 +194,11 @@ docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device
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.
* ### 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: