From b18a388cf434e8da54f0781126769391b8cd30d4 Mon Sep 17 00:00:00 2001 From: Kroese Date: Wed, 2 Apr 2025 12:37:58 +0200 Subject: [PATCH 1/4] docs: Correct readme --- docs/docker.md | 40 +--------------------------------------- 1 file changed, 1 insertion(+), 39 deletions(-) diff --git a/docs/docker.md b/docs/docker.md index 7f7a130..23aba7f 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -7,7 +7,7 @@ Although WinApps supports using `QEMU+KVM+libvirt` as a backend for running Wind > [!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. > Possible setup instructions for Windows 10: -> - 'Professional', 'Enterprise' or 'Server' editions of Windows are required to run RDP applications. Windows 'Home' will __NOT__ suffice. It is recommended to download the ISO from a reputed source, as the built in downloader from dockur (default set to `tiny11`) will take longer than it would to download from a browser/torrent. +> - 'Professional', 'Enterprise' or 'Server' editions of Windows are required to run RDP applications. Windows 'Home' will __NOT__ suffice. > - It is recommended to edit the initial `compose.yaml` file to keep your required username and password from the beginning. > - It is recommended to not use `sudo` to force commands to run. Add your user to the relevant permissions group wherever possible. @@ -27,9 +27,6 @@ Prior to installing Windows, you can modify the RAM and number of CPU cores avai It is also possible to specify the version of Windows you wish to install within `compose.yaml` by modifying `VERSION`. -> [!NOTE] -> WinApps uses a stripped-down Windows installation by default. Although this is recommended, you can request a stock Windows installation by changing `VERSION` to one of the versions listed in the README of the [original GitHub repository](https://github.com/dockur/windows). - Please refer to the [original GitHub repository](https://github.com/dockur/windows) for more information on additional configuration options. > [!NOTE] @@ -47,24 +44,6 @@ docker compose --file ./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. -After installing Windows, comment out the following lines in the `compose.yaml` file by prepending a '#': -- `- ./oem:/oem` -- `- /path/to/windows/install/media.iso:/custom.iso` (if relevant) - -Then, copy this modified `compose.yaml` file to `~/.config/winapps/compose.yaml`. - -```bash -cp ./compose.yaml ~/.config/winapps/compose.yaml -``` - -Finally, ensure the new configuration is applied by running the following: - -```bash -docker compose --file ./compose.yaml down -docker compose --file ~/.config/winapps/compose.yaml up -``` - - ### Changing `compose.yaml` Changes to `compose.yaml` require the Windows virtual machine to be removed and re-created. This should __NOT__ affect your data. @@ -110,23 +89,6 @@ podman-compose --file ./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. -After installing Windows, comment out the following lines in the `compose.yaml` file by prepending a '#': -- `- ./oem:/oem` -- `- /path/to/windows/install/media.iso:/custom.iso` (if relevant) - -Then, copy this modified `compose.yaml` file to `~/.config/winapps/compose.yaml`. - -```bash -cp ./compose.yaml ~/.config/winapps/compose.yaml -``` - -Finally, ensure the new configuration is applied by running the following: - -```bash -podman-compose --file ./compose.yaml down -podman-compose --file ~/.config/winapps/compose.yaml up -``` - ### Changing `compose.yaml` Changes to `compose.yaml` require the Windows virtual machine to be removed and re-created. This should __NOT__ affect your data. From 1887e5567f179083221356338c7b94a2ab690f64 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 2 Apr 2025 10:38:48 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/docker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docker.md b/docs/docker.md index 23aba7f..604671f 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -7,7 +7,7 @@ Although WinApps supports using `QEMU+KVM+libvirt` as a backend for running Wind > [!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. > Possible setup instructions for Windows 10: -> - 'Professional', 'Enterprise' or 'Server' editions of Windows are required to run RDP applications. Windows 'Home' will __NOT__ suffice. +> - 'Professional', 'Enterprise' or 'Server' editions of Windows are required to run RDP applications. Windows 'Home' will __NOT__ suffice. > - It is recommended to edit the initial `compose.yaml` file to keep your required username and password from the beginning. > - It is recommended to not use `sudo` to force commands to run. Add your user to the relevant permissions group wherever possible. From 12cf5ce3be37eccc2ce7e3ba489e27ee527cb9bf Mon Sep 17 00:00:00 2001 From: Kroese Date: Thu, 3 Apr 2025 01:51:17 +0200 Subject: [PATCH 3/4] Update docker.md --- docs/docker.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docker.md b/docs/docker.md index 604671f..afea1ec 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -45,17 +45,17 @@ docker compose --file ./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. ### Changing `compose.yaml` -Changes to `compose.yaml` require the Windows virtual machine to be removed and re-created. This should __NOT__ affect your data. +Changes to `compose.yaml` require the container to be removed and re-created. This should __NOT__ affect your data. ```bash -# Stop and remove the existing Windows virtual machine. +# Stop and remove the existing container. docker compose --file ~/.config/winapps/compose.yaml down # Remove the existing FreeRDP certificate (if required). # Note: A new certificate will be created when connecting via RDP for the first time. rm ~/.config/freerdp/server/127.0.0.1_3389.pem -# Re-create the virtual machine with the updated configuration. +# Re-create the container with the updated configuration. docker compose --file ~/.config/winapps/compose.yaml up ``` @@ -90,17 +90,17 @@ podman-compose --file ./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. ### Changing `compose.yaml` -Changes to `compose.yaml` require the Windows virtual machine to be removed and re-created. This should __NOT__ affect your data. +Changes to `compose.yaml` require the container to be removed and re-created. This should __NOT__ affect your data. ```bash -# Stop and remove the existing Windows virtual machine. +# Stop and remove the existing container. podman-compose --file ~/.config/winapps/compose.yaml down # Remove the existing FreeRDP certificate (if required). # Note: A new certificate will be created when connecting via RDP for the first time. rm ~/.config/freerdp/server/127.0.0.1_3389.pem -# Re-create the virtual machine with the updated configuration. +# Re-create the container with the updated configuration. podman-compose --file ~/.config/winapps/compose.yaml up ``` From 5004e4a5edd4e5a73aa6a1ec4b44b9bb766c6603 Mon Sep 17 00:00:00 2001 From: Kroese Date: Thu, 3 Apr 2025 11:16:35 +0200 Subject: [PATCH 4/4] Update docs/docker.md Co-authored-by: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com> --- docs/docker.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docker.md b/docs/docker.md index afea1ec..a890c01 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -56,6 +56,7 @@ docker compose --file ~/.config/winapps/compose.yaml down rm ~/.config/freerdp/server/127.0.0.1_3389.pem # Re-create the container with the updated configuration. +# Add the -d flag at the end to run the container in the background. docker compose --file ~/.config/winapps/compose.yaml up ```