diff --git a/readme.md b/readme.md index bd9bd84..4e2ef2d 100644 --- a/readme.md +++ b/readme.md @@ -50,29 +50,21 @@ docker run -it --rm -e "VERSION=win11x64" -p 8006:8006 --device=/dev/kvm --cap-a ## FAQ - * ### How do I perform the installation? + * ### How does it work? - - Start the container and wait until the ISO download is completed. If needed, you can view this progress in the Docker log. Wait until you see the message ```BdsDxe: starting Boot```. + Very simple! These are the steps: + + - Start the container and get some coffee, it will start downloading the ISO. - - Connect to port 8006 of the container in your web browser. + - Connect to port 8006 of the container in your web browser and wait untill you see the screen. - - Start the installation by clicking ```Install now```. On the next screen, press 'OK' when prompted to ```Load driver``` and select the ```VirtIO SCSI``` driver from the list that matches your Windows version. So for Windows 11, select ```D:\amd64\w11\vioscsi.inf``` and click 'Next'. + - Sit back and relax while all the magic happens, the whole installation will be performed fully automatic. - - Accept the license agreement and select your preferred Windows edition, like Home or Pro. - - - Choose ```Custom: Install Windows only (advanced)```, and click ```Load driver``` on the next screen. Select 'Browse' and navigate to the ```D:\NetKVM\w11\amd64``` folder, and click 'OK'. Select the ```VirtIO Ethernet Adapter``` from the list and click 'Next'. - - - Select 'Drive 0' and click 'Next'. - - - Wait until Windows finishes copying files and completes the installation. - - - Once you see your desktop, open File Explorer and navigate to the CD-ROM drive (D:). Double-click on ```virtio-win-gt-x64``` and proceed to install the VirtIO drivers. - - - Now your Windows installation is ready for use. Enjoy it, and don't forget to star this repo! + - Once you see your desktop, your Windows installation is ready for use. Enjoy it, and don't forget to star this repo! * ### How do I specify the Windows version? - You can modify the `VERSION` environment variable to specify the version of Windows you want to download: + You can modify the `VERSION` environment variable in order to specify the version of Windows you want to download: ```yaml environment: @@ -88,11 +80,9 @@ docker run -it --rm -e "VERSION=win11x64" -p 8006:8006 --device=/dev/kvm --cap-a - ```win2019-eval``` (Windows Server 2019) - ```win2016-eval``` (Windows Server 2016) - * ### How can I view the screen? + * ### How can I use a custom ISO file? - The container includes a web-based viewer, so you can visit [http://localhost:8006/](http://localhost:8006/) using any web browser to view the screen and interact with Windows via the keyboard or mouse. - - This is mainly for use during installation, as afterwards you can use Remote Desktop, TeamViewer or any other software you prefer. + You can supply your own ISO file by naming it ```custom.iso``` and placing it in the ```/storage``` folder. * ### How do I increase the amount of CPU or RAM? @@ -139,6 +129,41 @@ docker run -it --rm -e "VERSION=win11x64" -p 8006:8006 --device=/dev/kvm --cap-a If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check the virtualization settings in the BIOS. + * ### How can I view the screen? + + The container includes a web-based viewer, so you can visit [http://localhost:8006/](http://localhost:8006/) using any web browser to view the screen and interact with Windows via the keyboard or mouse. + + This is mainly for use during installation, as afterwards you can use Remote Desktop, TeamViewer or any other software you prefer. + + * ### How do I perform a manual installation? + + If you prefer to perform the installation manually in order to customize some options, add the following environment variable: + + ```yaml + environment: + ATTENDED: "Y" + ``` + + Then follow these steps: + + - Start the container and wait until the ISO download is completed. If needed, you can view this progress in the Docker log. Wait until you see the message ```BdsDxe: starting Boot```. + + - Connect to port 8006 of the container in your web browser, you will see the Windows installation screen. + + - Start the installation by clicking ```Install now```. On the next screen, press 'OK' when prompted to ```Load driver``` and select the ```VirtIO SCSI``` driver from the list that matches your Windows version. So for Windows 11, select ```D:\amd64\w11\vioscsi.inf``` and click 'Next'. + + - Accept the license agreement and select your preferred Windows edition, like Home or Pro. + + - Choose ```Custom: Install Windows only (advanced)```, and click ```Load driver``` on the next screen. Select 'Browse' and navigate to the ```D:\NetKVM\w11\amd64``` folder, and click 'OK'. Select the ```VirtIO Ethernet Adapter``` from the list and click 'Next'. + + - Select 'Drive 0' and click 'Next'. + + - Wait until Windows finishes copying files and completes the installation. + + - Once you see your desktop, open File Explorer and navigate to the CD-ROM drive (D:). Double-click on ```virtio-win-gt-x64``` and proceed to install the VirtIO drivers. + + - Now your Windows installation is ready for use. Enjoy it, and don't forget to star this repo! + * ### Is this project legal? Yes, this project contains only open-source code and does not distribute any copyrighted material. Neither does it try to circumvent any copyright protection measures. So under all applicable laws, this project would be considered legal.