docs: Readme

This commit is contained in:
Kroese 2024-05-02 00:22:07 +02:00 committed by GitHub
parent 53a6fbbb2f
commit 19bf027034
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -65,18 +65,17 @@ docker run -it --rm --name qemu -e "BOOT=http://example.com/image.iso" -p 8006:8
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 change the storage location?
By default, a single CPU core and 1 GB of RAM are allocated to the container. To change the storage location, include the following bind mount in your compose file:
To increase this, add the following environment variables:
```yaml ```yaml
environment: volumes:
RAM_SIZE: "4G" - /var/qemu:/storage
CPU_CORES: "4"
``` ```
Replace the example path `/var/qemu` with the desired storage folder.
* ### 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:
@ -88,24 +87,13 @@ docker run -it --rm --name qemu -e "BOOT=http://example.com/image.iso" -p 8006:8
This can also be used to resize the existing disk to a larger capacity without any data loss. 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:
```yaml
volumes:
- /var/qemu:/storage
```
Replace the example path `/var/qemu` with the desired storage folder.
* ### How do I boot a x86 image? * ### How do I boot a x86 image?
You can use [qemu-docker](https://github.com/qemus/qemu-docker/) to run x86 and x64 images on ARM. You can use [qemu-docker](https://github.com/qemus/qemu-docker/) to run x86 and x64 images on ARM.
* ### How do I boot a local image? * ### How do I boot a local image?
You can use a local file directly, and skip the download, by binding it in your compose file in this way: You can use a local file directly, and skip the download altogether, by binding it in your compose file in this way:
```yaml ```yaml
volumes: volumes:
@ -114,6 +102,29 @@ docker run -it --rm --name qemu -e "BOOT=http://example.com/image.iso" -p 8006:8
Replace the example path `/home/user/example.iso` with the filename of the desired ISO file. Replace the example path `/home/user/example.iso` with the filename of the desired ISO file.
* ### How do I verify if my system supports KVM?
To verify if your system supports KVM, run the following commands:
```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.
* ### 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.
If there arises a need to increase this, add the following environment variables:
```yaml
environment:
RAM_SIZE: "4G"
CPU_CORES: "4"
```
* ### 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.
@ -190,18 +201,7 @@ docker run -it --rm --name qemu -e "BOOT=http://example.com/image.iso" -p 8006:8
- /dev/bus/usb - /dev/bus/usb
``` ```
* ### How do I verify if my system supports KVM? * ### How can I provide custom arguments to QEMU?
To verify if your system supports KVM, run the following commands:
```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.
* ### 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: