marcel/winapps
1
0
Fork 0
mirror of https://github.com/winapps-org/winapps.git synced 2025-06-03 21:57:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

Encourage sensible placement of 'compose.yaml'

Browse Source
This commit is contained in:
Rohan Barar 2024-07-22 13:13:51 +10:00
parent e48e6ae8a9
commit b8a0c14757
1 changed files with 37 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
docs/docker.md
View File

@ -2,7 +2,7 @@
Although WinApps supports using `QEMU+KVM+libvirt` as a backend for running Windows virtual machines, it is recommended to use `Docker` or `Podman`. These backends automate the setup process, eliminating the need for manual configuration and optimisation of the Windows virtual machine. Although WinApps supports using `QEMU+KVM+libvirt` as a backend for running Windows virtual machines, it is recommended to use `Docker` or `Podman`. These backends automate the setup process, eliminating the need for manual configuration and optimisation of the Windows virtual machine.
> [!IMPORTANT] > [!IMPORTANT]
Running a Windows virtual machine using `Docker` or `Podman` as a backend is only possible on GNU/Linux systems. This is due to the necessity of kernel interfaces, such as the KVM hypervisor, for achieving acceptable performance. The performance of the virtual machine can vary based on the version of the Linux kernel, with newer releases generally offering better performance. > Running a Windows virtual machine using `Docker` or `Podman` as a backend is only possible on GNU/Linux systems. This is due to the necessity of kernel interfaces, such as the KVM hypervisor, for achieving acceptable performance. The performance of the virtual machine can vary based on the version of the Linux kernel, with newer releases generally offering better performance.
> [!IMPORTANT] > [!IMPORTANT]
> WinApps does NOT officially support versions of Windows prior to Windows 10. Despite this, it may be possible to achieve a successful installation with some additional experimentation. If you find a way to achieve this, please share your solution through a pull request for the benefit of other users. > WinApps does NOT officially support versions of Windows prior to Windows 10. Despite this, it may be possible to achieve a successful installation with some additional experimentation. If you find a way to achieve this, please share your solution through a pull request for the benefit of other users.
@ -12,9 +12,12 @@ Running a Windows virtual machine using `Docker` or `Podman` as a backend is onl
You can find a guide for installing `Docker Engine` [here](https://docs.docker.com/engine/install/). You can find a guide for installing `Docker Engine` [here](https://docs.docker.com/engine/install/).
### Setup `Docker` Container ### Setup `Docker` Container
WinApps utilises `docker compose` to configure Windows VMs. A suitable [`compose.yaml`](https://github.com/winapps-org/winapps/blob/main/compose.yaml) file is included in the root directory of the WinApps repository. WinApps utilises `docker compose` to configure Windows VMs.
Prior to initiating the installation, you can modify the RAM and number of CPU cores available to the Windows VM by changing `RAM_SIZE` and `CPU_CORES` within `compose.yaml`. > [!IMPORTANT]
> The [`compose.yaml`](https://github.com/winapps-org/winapps/blob/main/compose.yaml) file located within the root directory of the WinApps repository must be manually copied to `~/.config/winapps/compose.yaml`.
Prior to installing Windows, you can modify the RAM and number of CPU cores available to the Windows VM by changing `RAM_SIZE` and `CPU_CORES` within `compose.yaml`.
It is also possible to specify the version of Windows you wish to install within `compose.yaml` by modifying `VERSION`. It is also possible to specify the version of Windows you wish to install within `compose.yaml` by modifying `VERSION`.
@ -24,9 +27,9 @@ It is also possible to specify the version of Windows you wish to install within
Please refer to the [original GitHub repository](https://github.com/dockur/windows) for more information on additional configuration options. Please refer to the [original GitHub repository](https://github.com/dockur/windows) for more information on additional configuration options.
### Installing Windows ### Installing Windows
After navigating into the cloned WinApps repository, you can initiate the Windows installation using `docker compose`. You can initiate the Windows installation using `docker compose`.
```bash ```bash
docker compose up docker compose --file ~/.config/winapps/compose.yaml up
``` ```
You can then access the Windows virtual machine via a VNC connection to complete the Windows setup by navigating to http://127.0.0.1:8006 in your web browser. You can then access the Windows virtual machine via a VNC connection to complete the Windows setup by navigating to http://127.0.0.1:8006 in your web browser.
@ -34,22 +37,31 @@ You can then access the Windows virtual machine via a VNC connection to complete
### Installing WinApps ### Installing WinApps
`Docker` simplifies the WinApps installation process by eliminating the need for any additional configuration of the Windows virtual machine. Once the Windows virtual machine is up and running, you can directly launch the WinApps installer, which should automatically detect and interface with Windows. `Docker` simplifies the WinApps installation process by eliminating the need for any additional configuration of the Windows virtual machine. Once the Windows virtual machine is up and running, you can directly launch the WinApps installer, which should automatically detect and interface with Windows.
> [!NOTE]
> Since no Windows user password is set by default, Windows may automatically log in, which may cause the WinApps installation to fail due to complications establishing an RDP connection. To avoid this issue, please use the VNC connection to ensure that the Windows user is logged out before starting the WinApps installation.
```bash ```bash
./installer.sh ./installer.sh
``` ```
### Subsequent Use ### Changing `compose.yaml`
Changes require the Windows virtual machine to be removed and re-created using the updated `compose.yaml`. This should __NOT__ affect your data.
```bash ```bash
docker compose start # Power on the Windows VM docker compose --file ~/.config/winapps/compose.yaml down # Stop and remove the existing Windows virtual machine.
docker compose pause # Pause the Windows VM rm ~/.config/freerdp/server/127.0.0.1_3389.pem # Remove the existing FreeRDP certificate (a new certificate will be created automatically when connecting to the new virtual machine for the first time).
docker compose unpause # Resume the Windows VM docker compose --file ~/.config/winapps/compose.yaml up # Re-create the virtual machine with the updated configuration.
docker compose restart # Restart the Windows VM
docker compose stop # Gracefully shut down the Windows VM
docker compose kill # Force shut down the Windows VM
``` ```
> [!NOTE] ### Subsequent Use
> The above `docker compose` commands must be run within the same directory containing `compose.yaml`. ```bash
docker compose --file ~/.config/winapps/compose.yaml start # Power on the Windows VM
docker compose --file ~/.config/winapps/compose.yaml pause # Pause the Windows VM
docker compose --file ~/.config/winapps/compose.yaml unpause # Resume the Windows VM
docker compose --file ~/.config/winapps/compose.yaml restart # Restart the Windows VM
docker compose --file ~/.config/winapps/compose.yaml stop # Gracefully shut down the Windows VM
docker compose --file ~/.config/winapps/compose.yaml kill # Force shut down the Windows VM
```
## `Podman` ## `Podman`
### Installation ### Installation
@ -63,9 +75,9 @@ Please follow the [`docker` instructions](#setup-docker-container).
> Ensure `WAFLAVOR` is set to `"podman"` in `~/.config/winapps/winapps.conf`. > Ensure `WAFLAVOR` is set to `"podman"` in `~/.config/winapps/winapps.conf`.
### Installing Windows ### Installing Windows
After navigating into the cloned WinApps repository, you can initiate the Windows installation using `podman-compose`. You can initiate the Windows installation using `podman-compose`.
```bash ```bash
podman-compose up podman-compose --file ~/.config/winapps/compose.yaml up
``` ```
You can then access the Windows virtual machine via a VNC connection to complete the Windows setup by navigating to http://127.0.0.1:8006 in your web browser. You can then access the Windows virtual machine via a VNC connection to complete the Windows setup by navigating to http://127.0.0.1:8006 in your web browser.
@ -73,15 +85,15 @@ You can then access the Windows virtual machine via a VNC connection to complete
### Installing WinApps ### Installing WinApps
Please follow the [`docker` instructions](#installing-winapps). Please follow the [`docker` instructions](#installing-winapps).
### Changing `compose.yaml`
Please follow the [`docker` instructions](#changing-composeyaml).
### Subsequent Use ### Subsequent Use
```bash ```bash
podman-compose start # Power on the Windows VM podman-compose --file ~/.config/winapps/compose.yaml start # Power on the Windows VM
podman-compose pause # Pause the Windows VM podman-compose --file ~/.config/winapps/compose.yaml pause # Pause the Windows VM
podman-compose unpause # Resume the Windows VM podman-compose --file ~/.config/winapps/compose.yaml unpause # Resume the Windows VM
podman-compose restart # Restart the Windows VM podman-compose --file ~/.config/winapps/compose.yaml restart # Restart the Windows VM
podman-compose stop # Gracefully shut down the Windows VM podman-compose --file ~/.config/winapps/compose.yaml stop # Gracefully shut down the Windows VM
podman-compose kill # Force shut down the Windows VM podman-compose --file ~/.config/winapps/compose.yaml kill # Force shut down the Windows VM
``` ```
> [!NOTE]
> The above `podman-compose` commands must be run within the same directory containing `compose.yaml`.