sebarocks/docker-windows
1
0
Fork 0
mirror of https://github.com/dockur/windows.git synced 2025-10-28 19:55:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme.md

Browse source 
Changes following:

- Installs Windows 11 Enterprise by default.
- Updates default machine specs, to following and adds /dev/net/tun:
  - RAM: 8GB
  - CPU Cores: 8
  - Disk size: 512GB
- Prettify reading in README.
This commit is contained in:
Alice King Tai Poon 潘景泰 2024-07-17 16:05:20 +08:00 • committed by GitHub
parent addeb4a944
commit 8829d9b901
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

80
readme.md
View file

@ -110,7 +110,7 @@ kubectl apply -f kubernetes.yml
| `tiny10` | Tiny 10 | 3.6 GB | | `tiny10` | Tiny 10 | 3.6 GB |
> [!TIP] > [!TIP]
> To install ARM64 versions of Windows use [dockur/windows-arm](https://github.com/dockur/windows-arm/). > Installing ARM64 versions of Windows? Heads to [dockur/windows-arm](https://github.com/dockur/windows-arm/)!
### How do I select the Windows language? ### How do I select the Windows language?
@ -134,7 +134,7 @@ kubectl apply -f kubernetes.yml
``` ```
> [!NOTE] > [!NOTE]
> Changing these values will have no effect after the installation has been performed already. Use the control panel inside Windows in that case. > Changing these values has no effect after the installation has been performed already. Use settings inside Windows in case.
### How do I change the storage location? ### How do I change the storage location?
@ -149,7 +149,7 @@ kubectl apply -f kubernetes.yml
### How do I change the size of the disk? ### How do I change the size of the disk?
To expand the default size of 512GB, add the `DISK_SIZE` setting to your compose file and set it to your preferred capacity: To expand the default size of 512 GB, add the `DISK_SIZE` setting to your compose file and set it to your preferred capacity:
```yaml ```yaml
environment: environment:
@ -157,50 +157,50 @@ kubectl apply -f kubernetes.yml
``` ```
> [!TIP] > [!TIP]
> This can also be used to resize the existing disk to a larger capacity without any data loss. > This also used resizing the existing disk to a larger capacity without any data loss.
### How do I share files with the host? ### How do I share files with the host?
Open 'File Explorer' and click on the 'Network' section, you will see a computer called `host.lan`. Double-click it and it will show a folder called `Data`, which can be binded to any folder on your host via the compose file: Open 'File Explorer', click the 'Network' section, seeing a computer called `host.lan`. Double-click and shows a folder called `Data`, which binds to any folder on your host via the compose file:
```yaml ```yaml
volumes: volumes:
- /home/user/example:/shared - /home/user/example:/shared
``` ```
The example folder `/home/user/example` will be available as ` \\host.lan\Data`. Your example folder `/home/user/example` availables ` \\host.lan\Data`.
> [!TIP] > [!TIP]
> You can map this path to a drive letter in Windows, for easier access. > You may map this path to a drive letter in Windows, for easier access.
### How do I install a custom image? ### How do I install a custom image?
In order to download an unsupported ISO image that is not selectable from the list above, specify the URL of that ISO in the `VERSION` environment variable, for example: In order to download an unsupported ISO image that is not selectable from the list above, specify one of your URL to ISO in the `VERSION` environment variable, for example:
```yaml ```yaml
environment: environment:
VERSION: "https://example.com/win.iso" VERSION: "https://example.com/win.iso"
``` ```
Alternatively, you can also skip the download and use a local file instead, by binding it in your compose file in this way: Alternatively, you skip downloading and use a local file instead, by binding it in your compose file in this way:
```yaml ```yaml
volumes: volumes:
- /home/user/example.iso:/custom.iso - /home/user/example.iso:/custom.iso
``` ```
Replace the example path `/home/user/example.iso` with the filename of your desired ISO file, the value of `VERSION` will be ignored in this case. Replace the example path `/home/user/example.iso` with the filename of your desired ISO file, the value of `VERSION` will be ignored in your case.
### How do I run a script after installation? ### How do I run a script after installation?
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: To run your own script after installation, create your file called `install.bat` and place 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 ```yaml
volumes: volumes:
- /home/user/example:/oem - /home/user/example:/oem
``` ```
The example folder `/home/user/example` will be copied to `C:\OEM` during installation and the containing `install.bat` will be executed during the last step. Your example folder `/home/user/example` copied to `C:\OEM` during installation and the containing `install.bat` will be executed during the last step.
### How do I perform a manual installation? ### How do I perform a manual installation?
@ -215,9 +215,9 @@ kubectl apply -f kubernetes.yml
### How do I change the amount of CPU or RAM? ### How do I change the amount of CPU or RAM?
By default, the container will be allowed to use a maximum of 8 CPU cores and 8 GB of RAM. By default, container allows using 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: Want to adjust this? Specify the desired amount using the following environment variables:
```yaml ```yaml
environment: environment:
@ -225,11 +225,11 @@ kubectl apply -f kubernetes.yml
CPU_CORES: "32" CPU_CORES: "32"
``` ```
### How do I configure the username and password? ### How do I configure my username and password?
By default, a user called `Docker` is created during the installation, with an empty password. By default, you called `Docker`, created during the installation, with empty password.
If you want to use different credentials, you can change them in your compose file: Want to use different credentials? Change them in your compose file:
```yaml ```yaml
environment: environment:
@ -239,17 +239,17 @@ kubectl apply -f kubernetes.yml
### How do I connect using RDP? ### How do I connect using RDP?
The web-viewer is mainly meant to be used during installation, as its picture quality is low, and it has no audio or clipboard for example. Our web-viewer's mainly meant to be used during installation, as our picture quality are low, and has no audio or clipboard for example.
So for a better experience you can connect using any Microsoft Remote Desktop client to the IP of the container, using the username `Docker` and by leaving the password empty. For better experience, please connect using any Microsoft Remote Desktop app client to the IP of your container, using username `Docker` and leaving password empty.
There is a RDP client for [Android](https://play.google.com/store/apps/details?id=com.microsoft.rdc.androidx) available from the Play Store and one for [iOS](https://apps.apple.com/nl/app/microsoft-remote-desktop/id714464092?l=en-GB) in the Apple Store. For Linux you can use [FreeRDP](https://www.freerdp.com/) and on Windows just type `mstsc` in the search box. There is a RDP client for [Android](https://play.google.com/store/apps/details?id=com.microsoft.rdc.androidx) available from the Play Store and one for [iOS](https://apps.apple.com/app/microsoft-remote-desktop/id714464092) in the Apple App Store. For Linux feel free using [FreeRDP](https://www.freerdp.com/) and on Windows just type `mstsc` in the search box.
### 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, you use bridged networking, shares your IP address with your host.
If you want to assign an individual IP address to the container, you can create a macvlan network as follows: Want assigning an individual IP address to the container? Create macvlan network as follows:
```bash ```bash
docker network create -d macvlan \ docker network create -d macvlan \
@ -259,9 +259,9 @@ kubectl apply -f kubernetes.yml
-o parent=eth0 vlan -o parent=eth0 vlan
``` ```
Be sure to modify these values to match your local subnet. Be sure modifying these values, matching your local subnet.
Once you have created the network, change your compose file to look as follows: Once you created your network, change your compose file looking as follows:
```yaml ```yaml
services: services:
@ -277,14 +277,14 @@ kubectl apply -f kubernetes.yml
external: true 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. An adds benefit to approaches is won't have performing any port mapping anymore, since all ports are exposed by default.
> [!IMPORTANT] > [!IMPORTANT]
> 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. > 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 current workaround.
### How can Windows acquire an IP address from my router? ### How my Windows acquiring an IP address from my router?
After configuring the container for [macvlan](#how-do-i-assign-an-individual-ip-address-to-the-container), it is possible for Windows to become part of your home network by requesting an IP from your router, just like a real PC. After configuring your container for [macvlan](#how-do-i-assign-an-individual-ip-address-to-the-container), possibles for Windows becoming part of your home network by requesting an IP from your router, just like a real PC.
To enable this mode, add the following lines to your compose file: To enable this mode, add the following lines to your compose file:
@ -302,7 +302,7 @@ kubectl apply -f kubernetes.yml
### How do I add multiple disks? ### How do I add multiple disks?
To create additional disks, modify your compose file like this: Really to create your additional disks? Modify compose file like this:
```yaml ```yaml
environment: environment:
@ -317,7 +317,7 @@ kubectl apply -f kubernetes.yml
### 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: Possibles passing-through disk devices directly by adding them in your compose file this way:
```yaml ```yaml
devices: devices:
@ -326,11 +326,11 @@ kubectl apply -f kubernetes.yml
... ...
``` ```
Use `/disk1` if you want it to become your main drive, and use `/disk2` and higher to add them as secondary drives. Use `/disk1` if you want it to become your main drive, and use `/disk2` and higher to add them as futher drives.
### How do I pass-through a USB device? ### How do I pass-through a USB device?
To pass-through a USB device, first lookup its vendor and product id via the `lsusb` command, then add them to your compose file like this: Passing-through some USB device? First, lookup its vendor and product id via the `lsusb` command, then add them to your compose file like this:
```yaml ```yaml
environment: environment:
@ -340,20 +340,20 @@ kubectl apply -f kubernetes.yml
``` ```
> [!IMPORTANT] > [!IMPORTANT]
> If the device is a USB disk drive, please wait until after the installation is completed before connecting it. Otherwise the installation may fail, as the order of the disks can get rearranged. > If your device is USB disk drive, please wait until after the installation is completed before connecting it. Or installation fails, as ordering the disks can get rearranged.
### How do I verify if my system supports KVM? ### How do I verify if my system supports KVM?
To verify that your system supports KVM, run the following commands: To verify that your system supports KVM, run followings:
```bash ```bash
sudo apt install cpu-checker sudo apt install cpu-checker
sudo kvm-ok sudo kvm-ok
``` ```
If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, please check whether: You may receive errors from `kvm-ok` indicating KVM acceleration can't be used, please check whether:
- the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your UEFI BIOS. - the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your UEFI.
- you are running an operating system that supports them, like Linux or Windows 11 (macOS and Windows 10 do not unfortunately). - you are running an operating system that supports them, like Linux or Windows 11 (macOS and Windows 10 do not unfortunately).
@ -361,22 +361,22 @@ kubectl apply -f kubernetes.yml
- you are not using a cloud provider, as most of them do not allow nested virtualization for their VPS's. - you are not using a cloud provider, as most of them do not allow nested virtualization for their VPS's.
If you didn't receive any error from `kvm-ok` at all, but the container still complains that `/dev/kvm` is missing, it might help to add `privileged: true` to your compose file (or `--privileged` to your `run` command), to rule out any permission issue. If you didn't receive any error from `kvm-ok` at all, but the container still complains that `/dev/kvm` is missing, it might helped by adding `privileged: true` in your compose file (or `--privileged` in your `run` command), ruling out any permission issue.
### How do I run macOS in a container? ### How do I run macOS in a container?
You can use [dockur/macos](https://github.com/dockur/macos) for that. It shares many of the same features, except for the automatic installation. Feel free using [dockur/macos](https://github.com/dockur/macos) for that shares many of same features, except automatic installation.
### Is this project legal? ### Is this project legal?
Yes, this project contains only open-source code and does not distribute any copyrighted material. Any product keys found in the code are just generic placeholders provided by Microsoft for trial purposes. So under all applicable laws, this project will be considered legal. Yes, our project contains only open-source code and does not distribute any copyrighted material. Any product keys found in the code are just generic placeholders provided by Microsoft for trial purposes. So under all applicable laws, we considered legal.
## Stars 🌟 ## Stars 🌟
[![Stars](https://starchart.cc/dockur/windows.svg?variant=adaptive)](https://starchart.cc/dockur/windows) [![Stars](https://starchart.cc/dockur/windows.svg?variant=adaptive)](https://starchart.cc/dockur/windows)
## Disclaimer ⚖️ ## Disclaimer ⚖️
*The product names, logos, brands, and other trademarks referred to within this project are the property of their respective trademark holders. This project is not affiliated, sponsored, or endorsed by Microsoft Corporation.* *The product names, logos, brands, and other trademarks referred to within us are the property of their respective trademark holders. This project not affiliated, sponsored, or endorsed by Microsoft Corporation.*
[build_url]: https://github.com/dockur/windows/ [build_url]: https://github.com/dockur/windows/
[hub_url]: https://hub.docker.com/r/dockurr/windows/ [hub_url]: https://hub.docker.com/r/dockurr/windows/