Compare commits

...

3 commits

Author SHA1 Message Date
Kroese
2aace966c9
docs: Readme (#158)
Some checks are pending
Update / dockerHubDescription (push) Waiting to run
2024-06-11 21:45:48 +02:00
Kroese
42df9867a5
docs: Add icons (#157) 2024-06-11 20:56:29 +02:00
Kroese
b9ebcf90e5
docs: KVM information (#156) 2024-06-11 19:58:24 +02:00

View file

@ -13,20 +13,20 @@
Windows for ARM in a Docker container, for devices like the Raspberry Pi 5 and many others. Windows for ARM in a Docker container, for devices like the Raspberry Pi 5 and many others.
Note: for KVM acceleration you need a Linux-based operating system, as it's not available on MacOS unfortunately. *Note: for KVM acceleration you need a Linux-based operating system, as it's not available on MacOS unfortunately.*
## Features ## Features
- Multi-language - Multi-language
- ISO downloader - ISO downloader
- KVM acceleration - KVM acceleration
- Web-based viewer - Web-based viewer
## Video ## 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://www.youtube.com/watch?v=xhGYobuG508)
## Usage ## Usage 🐳
Via Docker Compose: Via Docker Compose:
@ -60,7 +60,7 @@ Via Kubernetes:
kubectl apply -f kubernetes.yml kubectl apply -f kubernetes.yml
``` ```
## FAQ ## FAQ 💬
* ### How do I use it? * ### How do I use it?
@ -101,10 +101,45 @@ kubectl apply -f kubernetes.yml
```yaml ```yaml
environment: environment:
LANGUAGE: "Chinese" LANGUAGE: "cn"
``` ```
You can choose between `Arabic`, `Bulgarian`, `Chinese`, `Croatian`, `Czech`, `Danish`, `Dutch`, `Estonian`, `Finnish`, `French`, `German`, `Greek`, `Hebrew`, `Hungarian`, `Italian`, `Japanese`, `Korean`, `Latvian`, `Lithuanian`, `Norwegian`, `Polish`, `Portuguese`, `Romanian`, `Russian`, `Serbian`, `Slovak`, `Slovenian`, `Spanish`, `Swedish`, `Turkish`, `Thai` and `Ukrainian`. You can choose between:
- 🇦🇪 **Arabic**: `ar`
- 🇧🇬 **Bulgarian**: `bg`
- 🇨🇳 **Chinese (simplified)**: `cn`
- 🇹🇼 **Chinese (traditional)**: `tw`
- 🇭🇷 **Croation**: `hr`
- 🇨🇿 **Czech**: `cs`
- 🇩🇰 **Danish**: `da`
- 🇳🇱 **Dutch**: `nl`
- 🇬🇧 **English**: `en`
- 🇪🇪 **Estionian**: `et`
- 🇫🇮 **Finnish**: `fi`
- 🇫🇷 **French**: `fr`
- 🇩🇪 **German**: `de`
- 🇬🇷 **Greek**: `el`
- 🇮🇱 **Hebrew**: `he`
- 🇭🇺 **Hungarian**: `hu`
- 🇮🇹 **Italian**: `it`
- 🇯🇵 **Japanese**: `ja`
- 🇰🇷 **Korean**: `ko`
- 🇱🇻 **Latvian**: `lv`
- 🇱🇹 **Lithuanian**: `lt`
- 🇳🇴 **Norwegian**: `nb`
- 🇵🇱 **Polish**: `pl`
- 🇵🇹 **Portuguese**: `pt`
- 🇷🇴 **Romanian**: `ro`
- 🇷🇺 **Russian**: `ru`
- 🇷🇸 **Serbian**: `sr`
- 🇸🇰 **Slovak**: `sk`
- 🇸🇮 **Slovenian**: `sl`
- 🇪🇸 **Spanish**: `es`
- 🇸🇪 **Swedish**: `sv`
- 🇹🇭 **Thai**: `th`
- 🇹🇷 **Turkish**: `tr`
- 🇺🇦 **Ukrainian**: `ua`
If you want to use a keyboard layout or locale that is not the default for your selected language, you can add the `KEYBOARD` and `REGION` variables with a culture code, like this: If you want to use a keyboard layout or locale that is not the default for your selected language, you can add the `KEYBOARD` and `REGION` variables with a culture code, like this:
@ -321,20 +356,28 @@ kubectl apply -f kubernetes.yml
sudo kvm-ok sudo kvm-ok
``` ```
If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, check whether virtualization extensions are enabled in your BIOS. If you are running the container inside a VM instead of directly on the host, you will also need to enable nested virtualization in its settings. If you are using a cloud provider, you may be out of luck as most of them do not allow nested virtualization for their VPS's. If you are using MacOS, you are also out of luck, as only Linux and Windows support KVM. If you receive an error from `kvm-ok` indicating that KVM acceleration can't be used, please check whether:
If you don'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. - the virtualization extensions (`Intel VT-x` or `AMD SVM`) are enabled in your BIOS.
- you are running an operating system that supports them, like Linux or Windows 11 (macOS and Windows 10 do not unfortunately).
- you enabled "nested virtualization" if you are running the container inside a virtual machine.
- 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.
* ### 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, 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.
## Stars ## Stars 🌟
[![Stars](https://starchart.cc/dockur/windows-arm.svg?variant=adaptive)](https://starchart.cc/dockur/windows-arm) [![Stars](https://starchart.cc/dockur/windows-arm.svg?variant=adaptive)](https://starchart.cc/dockur/windows-arm)
## 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 this project are the property of their respective trademark holders. This project is not affiliated, sponsored, or endorsed by Microsoft Corporation.*
[build_url]: https://github.com/dockur/windows-arm/ [build_url]: https://github.com/dockur/windows-arm/
[hub_url]: https://hub.docker.com/r/dockurr/windows-arm/ [hub_url]: https://hub.docker.com/r/dockurr/windows-arm/