Fabio/windows-arm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Readme (#274)

Browse source
This commit is contained in:
Kroese 2025-03-13 02:07:03 +01:00 committed by GitHub
parent e1a59dfe48
commit 66d5c41083
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 43 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

88
readme.md
View file

@ -135,15 +135,13 @@ kubectl apply -f https://raw.githubusercontent.com/dockur/windows/refs/heads/mas
The display output is a simple framebuffer, just so that the screen can be visible during installation as it doesn't require any drivers. The display output is a simple framebuffer, just so that the screen can be visible during installation as it doesn't require any drivers.
After Windows is fully installed, you can add the following to your compose file: To add a virtual graphics cards to your machine that allows for higher resolutions, you can add the following to your compose file after Windows is fully installed:
```yaml ```yaml
environment: environment:
VGA: "virtio-gpu" VGA: "virtio-gpu"
``` ```
to add a virtual graphics cards to your machine that allows for higher resolutions.
### 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`. Open 'File Explorer' and click on the 'Network' section, you will see a computer called `host.lan`.
@ -160,48 +158,6 @@ The example folder `./example` will be available as ` \\host.lan\Data`.
> [!TIP] > [!TIP]
> You can map this path to a drive letter in Windows, for easier access. > You can map this path to a drive letter in Windows, for easier access.
### How do I install a custom image?
In order to download an unsupported ISO image, specify its URL in the `VERSION` environment variable:
```yaml
environment:
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:
```yaml
volumes:
- ./example.iso:/custom.iso
```
Replace the example path `./example.iso` with the filename of your desired ISO file. The value of `VERSION` will be ignored in this case.
### 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:
```yaml
volumes:
- ./example:/oem
```
The example folder `./example` will be copied to `C:\OEM` and the containing `install.bat` will be executed during the last step of the automatic installation.
### 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.
However, if you insist on performing the installation manually, add the following environment variable to your compose file:
```yaml
environment:
MANUAL: "Y"
```
### 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 2 CPU cores and 4 GB of RAM. By default, the container will be allowed to use a maximum of 2 CPU cores and 4 GB of RAM.
@ -249,6 +205,48 @@ The example folder `./example` will be available as ` \\host.lan\Data`.
KEYBOARD: "en-US" KEYBOARD: "en-US"
``` ```
### How do I install a custom image?
In order to download an unsupported ISO image, specify its URL in the `VERSION` environment variable:
```yaml
environment:
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:
```yaml
volumes:
- ./example.iso:/custom.iso
```
Replace the example path `./example.iso` with the filename of your desired ISO file. The value of `VERSION` will be ignored in this case.
### 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:
```yaml
volumes:
- ./example:/oem
```
The example folder `./example` will be copied to `C:\OEM` and the containing `install.bat` will be executed during the last step of the automatic installation.
### How do I perform a manual installation?
It's recommended to stick to the automatic installation, as it adjusts various settings to prevent common issues when running Windows inside a virtual environment.
However, if you insist on performing the installation manually on your own risk, add the following environment variable to your compose file:
```yaml
environment:
MANUAL: "Y"
```
### 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. 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.