Skip to content

Commit 66d5c41

Browse files
authored
docs: Readme (#274)
1 parent e1a59df commit 66d5c41

File tree

1 file changed

+43
-45
lines changed

1 file changed

+43
-45
lines changed

readme.md

+43-45
Original file line numberDiff line numberDiff line change
@@ -135,15 +135,13 @@ kubectl apply -f https://raw.githubusercontent.com/dockur/windows/refs/heads/mas
135135

136136
The display output is a simple framebuffer, just so that the screen can be visible during installation as it doesn't require any drivers.
137137

138-
After Windows is fully installed, you can add the following to your compose file:
138+
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:
139139

140140
```yaml
141141
environment:
142142
VGA: "virtio-gpu"
143143
```
144144

145-
to add a virtual graphics cards to your machine that allows for higher resolutions.
146-
147145
### How do I share files with the host?
148146

149147
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`.
160158
> [!TIP]
161159
> You can map this path to a drive letter in Windows, for easier access.
162160

163-
### How do I install a custom image?
164-
165-
In order to download an unsupported ISO image, specify its URL in the `VERSION` environment variable:
166-
167-
```yaml
168-
environment:
169-
VERSION: "https://example.com/win.iso"
170-
```
171-
172-
Alternatively, you can also skip the download and use a local file instead, by binding it in your compose file in this way:
173-
174-
```yaml
175-
volumes:
176-
- ./example.iso:/custom.iso
177-
```
178-
179-
Replace the example path `./example.iso` with the filename of your desired ISO file. The value of `VERSION` will be ignored in this case.
180-
181-
### How do I run a script after installation?
182-
183-
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).
184-
185-
Then bind that folder in your compose file like this:
186-
187-
```yaml
188-
volumes:
189-
- ./example:/oem
190-
```
191-
192-
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.
193-
194-
### How do I perform a manual installation?
195-
196-
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.
197-
198-
However, if you insist on performing the installation manually, add the following environment variable to your compose file:
199-
200-
```yaml
201-
environment:
202-
MANUAL: "Y"
203-
```
204-
205161
### How do I change the amount of CPU or RAM?
206162

207163
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`.
249205
KEYBOARD: "en-US"
250206
```
251207

208+
### How do I install a custom image?
209+
210+
In order to download an unsupported ISO image, specify its URL in the `VERSION` environment variable:
211+
212+
```yaml
213+
environment:
214+
VERSION: "https://example.com/win.iso"
215+
```
216+
217+
Alternatively, you can also skip the download and use a local file instead, by binding it in your compose file in this way:
218+
219+
```yaml
220+
volumes:
221+
- ./example.iso:/custom.iso
222+
```
223+
224+
Replace the example path `./example.iso` with the filename of your desired ISO file. The value of `VERSION` will be ignored in this case.
225+
226+
### How do I run a script after installation?
227+
228+
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).
229+
230+
Then bind that folder in your compose file like this:
231+
232+
```yaml
233+
volumes:
234+
- ./example:/oem
235+
```
236+
237+
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.
238+
239+
### How do I perform a manual installation?
240+
241+
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.
242+
243+
However, if you insist on performing the installation manually on your own risk, add the following environment variable to your compose file:
244+
245+
```yaml
246+
environment:
247+
MANUAL: "Y"
248+
```
249+
252250
### How do I connect using RDP?
253251

254252
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.

0 commit comments

Comments
 (0)