diff --git a/readme.md b/readme.md index 27db199..5b5e836 100644 --- a/readme.md +++ b/readme.md @@ -23,7 +23,7 @@ Windows inside a Docker container. ## Video 📺 -[![Youtube](https://img.youtube.com/vi/xhGYobuG508/0.jpg)](https://www.youtube.com/watch?v=xhGYobuG508) +[![Youtube](https://img.youtube.com/vi/xhGYobuG508/0.jpg)](https://youtu.be/xhGYobuG508) ## Usage 🐳 @@ -35,9 +35,10 @@ services: image: dockurr/windows container_name: windows environment: - VERSION: "win11" + VERSION: "win11e" devices: - /dev/kvm + - /dev/net/tun cap_add: - NET_ADMIN ports: @@ -50,7 +51,7 @@ services: Via Docker CLI: ```bash -docker run -it --rm -p 8006:8006 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 dockurr/windows +docker run -it --rm -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN --stop-timeout 120 dockurr/windows ``` Via Kubernetes: @@ -63,7 +64,7 @@ kubectl apply -f kubernetes.yml ### How do I use it? - Very simple! These are the steps: + Simple! Steps below: - Start the container and connect to [port 8006](http://localhost:8006) using your web browser. @@ -75,11 +76,11 @@ kubectl apply -f kubernetes.yml ### How do I select the Windows version? - By default, Windows 11 will be installed. But you can add the `VERSION` environment variable to your compose file, in order to specify an alternative Windows version to be downloaded: + By default, Windows 11 Enterprise will be installed. But you can add the `VERSION` environment variable to your compose file, in order to specify an alternative Windows version to be downloaded: ```yaml environment: - VERSION: "win11" + VERSION: "win11e" ``` Select from the values below: @@ -148,11 +149,11 @@ kubectl apply -f kubernetes.yml ### 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: + To expand the default size of 512GB, add the `DISK_SIZE` setting to your compose file and set it to your preferred capacity: ```yaml environment: - DISK_SIZE: "256G" + DISK_SIZE: "1T" ``` > [!TIP] @@ -168,7 +169,7 @@ kubectl apply -f kubernetes.yml ``` The example folder `/home/user/example` will be available as ` \\host.lan\Data`. - + > [!TIP] > You can map this path to a drive letter in Windows, for easier access. @@ -192,7 +193,7 @@ kubectl apply -f kubernetes.yml ### How do I run a script after installation? - To run your own script after installation, you can create a file called `install.bat` and place it in a folder together with any additional files it needs (software to be installed for example). Then bind that folder in your compose file like this: + To run your own script after installation, you create a file called `install.bat` and place it in a folder together with any additional files it needs (software to be installed for example). Then bind that folder in your compose file like this: ```yaml volumes: @@ -203,7 +204,7 @@ kubectl apply -f kubernetes.yml ### How do I perform a manual installation? - It's best to stick to the automatic installation, as it adjusts various settings to prevent common issues when running Windows inside a virtual environment. + It's best sticking to automatic installation, as adjusting various settings to prevent common issues when running Windows inside a virtual environment. However, if you insist on performing the installation manually, add the following environment variable to your compose file: @@ -214,14 +215,14 @@ kubectl apply -f kubernetes.yml ### How do I change the amount of CPU or RAM? - By default, the container will be allowed to use a maximum of 2 CPU cores and 4 GB of RAM. + By default, the container will be allowed to use a maximum of 8 CPU cores and 8 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" + RAM_SIZE: "16G" + CPU_CORES: "32" ``` ### How do I configure the username and password? @@ -307,9 +308,11 @@ kubectl apply -f kubernetes.yml environment: DISK2_SIZE: "32G" DISK3_SIZE: "64G" +... volumes: - /home/example:/storage2 - /mnt/data/example:/storage3 +... ``` ### How do I pass-through a disk? @@ -320,6 +323,7 @@ kubectl apply -f kubernetes.yml devices: - /dev/sdb:/disk1 - /dev/sdc:/disk2 +... ``` Use `/disk1` if you want it to become your main drive, and use `/disk2` and higher to add them as secondary drives. @@ -349,7 +353,7 @@ kubectl apply -f kubernetes.yml If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, please check whether: - - the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your BIOS. + - the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your UEFI BIOS. - you are running an operating system that supports them, like Linux or Windows 11 (macOS and Windows 10 do not unfortunately).