Merge pull request #312 from winapps-org/doc-install-bat-on-libvirt

doc: run install.bat on libvirt
winapps-org · Dec 15, 2024 · af238bd · af238bd
2 parents 564d28b + 8e3a3bf
commit af238bd
Show file tree

Hide file tree

Showing 37 changed files with 59 additions and 314 deletions.
diff --git a/.github/workflows/lictool.yaml b/.github/workflows/lictool.yaml
diff --git a/.license-tools-config.json b/.license-tools-config.json
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,5 @@
 ci:
   autoupdate_branch: "rewrite"
-  skip: [license-tools]
 
 exclude: ^(.+)\.patch$
 
@@ -51,8 +50,3 @@ repos:
     rev: v0.10.0.1
     hooks:
       - id: shellcheck
-
-  - repo: https://github.com/emzeat/mz-lictools
-    rev: v2.7.0
-    hooks:
-      - id: license-tools
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,9 +3,6 @@
 Thank you for contributing to winapps! Before you can contribute, we ask some things of you:
 
 - Please follow our Code of Conduct, the Contributor Covenant. You can find a copy in this repository or under https://www.contributor-covenant.org/
-- All Contributors have to sign [a CLA](https://gist.github.com/oskardotglobal/35f0a72eb45fcc7087e535561383dbc5) for legal reasons. When opening a PR, @cla-assitant will prompt you and guide you through the process. However, if you contribute on behalf of a legal entity, we ask of you to sign [a different CLA](https://gist.github.com/oskardotglobal/75a8cc056e56a439fa6a1551129ae47f). In that case, please contact us.
+- All Contributors have to sign [a CLA](https://gist.github.com/oskardotglobal/35f0a72eb45fcc7087e535561383dbc5) for legal reasons. When opening a PR, @cla-assistant will prompt you and guide you through the process. However, if you contribute on behalf of a legal entity, we ask of you to sign [a different CLA](https://gist.github.com/oskardotglobal/75a8cc056e56a439fa6a1551129ae47f). In that case, please contact us.
 - Please follow code conventions enforced by `pre-commit`. To keep down CI usage, please run it locally before committing too.
   See <https://pre-commit.com> for installation, then run `pre-commit install` inside the `winapps` repository you cloned.
-
-All source code files shall have a valid SPDX-Identifier. For more information, see <https://spdx.dev/learn/handling-license-info/>.
-This identifier will be generated by a pre-commit hook most of the time.
diff --git a/COPYRIGHT.md b/COPYRIGHT.md
@@ -0,0 +1,8 @@
+Some of the files are
+
+    Copyright (c) 2024 fmstrat
+
+Many files also contain contributions from third parties.
+In this case the original copyright of the contributions can be traced through the history of the source version control system.
+
+When that is not the case, the files contain a prominent notice stating the original copyright and applicable license, or come with their own dedicated COPYRIGHT and/or LICENSE file.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,3 +1,5 @@
+For copyright information, please see the [COPYRIGHT.md](./COPYRIGHT.md) file.
+
 This project has files licensed under different licenses.
 
 The original project by Fmstrat <https://github.com/Fmstrat/winapps/> is not free software.

diff --git a/README.md b/README.md
@@ -282,7 +282,7 @@ The following guides are available:
 - [Creating a Windows VM with `Docker` or `Podman`](docs/docker.md)
 - [Creating a Windows VM with `libvirt`](docs/libvirt.md)
 
-If you already have a Windows VM or server you wish to use with WinApps, you will need to merge `install/RDPApps.reg` into the Windows Registry manually.
+If you already have a Windows VM or server you wish to use with WinApps, you will still have to follow the [final steps described in the `libvirt` documentation](docs/libvirt.md#final-configuration-steps).
 
 ### Step 2: Install Dependencies
 Install the required dependencies.
@@ -376,10 +376,10 @@ RDP_SCALE="100"
 
 # [ADDITIONAL FREERDP FLAGS & ARGUMENTS]
 # NOTES:
-# - If you're facing issues, try removing the /network:lan flag.
-# DEFAULT VALUE: '/cert:tofu /sound /microphone /network:lan'
+# - You can try adding /network:lan to these flags in order to increase performance, however, some users have faced issues with this.
+# DEFAULT VALUE: '/cert:tofu /sound /microphone'
 # VALID VALUES: See https://github.com/awakecoding/FreeRDP-Manuals/blob/master/User/FreeRDP-User-Manual.markdown
-RDP_FLAGS="/cert:tofu /sound /microphone /network:lan"
+RDP_FLAGS="/cert:tofu /sound /microphone"
 
 # [MULTIPLE MONITORS]
 # NOTES:

diff --git a/apps/access-o365-x86/info b/apps/access-o365-x86/info
@@ -1,8 +1,3 @@
-# Copyright (c) 2024 winapps-org
-# All rights reserved.
-#
-# SPDX-License-Identifier: Unlicense
-
 # GNOME shortcut name
 NAME="Access"
 

diff --git a/apps/access-x86/info b/apps/access-x86/info
@@ -1,8 +1,3 @@
-# Copyright (c) 2024 winapps-org
-# All rights reserved.
-#
-# SPDX-License-Identifier: Unlicense
-
 # GNOME shortcut name
 NAME="Access"
 

diff --git a/apps/acrobat9/info b/apps/acrobat9/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Acrobat 9"
 

diff --git a/apps/excel-x86-2010/info b/apps/excel-x86-2010/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Excel"
 

diff --git a/apps/linqpad8/info b/apps/linqpad8/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="LINQPad8"
 

diff --git a/apps/mspaint/info b/apps/mspaint/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Paint"
 

diff --git a/apps/powershell-ide/info b/apps/powershell-ide/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Powershell"
 

diff --git a/apps/project-x86/info b/apps/project-x86/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-# GNOME shortcut name
 NAME="Project"
 
 # Used for descriptions and window class

diff --git a/apps/project/info b/apps/project/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Gordon Cheong
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Project"
 

diff --git a/apps/ssms20/info b/apps/ssms20/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-#
 # GNOME shortcut name
 NAME="SQL Server Management Studio"
 

diff --git a/apps/visio-x86/info b/apps/visio-x86/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Gordon Cheong
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Visio"
 

diff --git a/apps/visio/info b/apps/visio/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Gordon Cheong
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Visio"
 

diff --git a/apps/visual-studio-comm/info b/apps/visual-studio-comm/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Gordon Cheong
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Visual Studio Community"
 

diff --git a/apps/visual-studio-ent/info b/apps/visual-studio-ent/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Gordon Cheong
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Visual Studio Enterprise"
 

diff --git a/apps/visual-studio-pro/info b/apps/visual-studio-pro/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Gordon Cheong
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Visual Studio Professional"
 

diff --git a/apps/word-x86-2010/info b/apps/word-x86-2010/info
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Adam
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # GNOME shortcut name
 NAME="Word"
 

diff --git a/bin/winapps b/bin/winapps
@@ -1,12 +1,4 @@
 #!/usr/bin/env bash
-# Copyright (c) 2024 Felix Bartels
-# Copyright (c) 2024 Rhea Barar
-# Copyright (c) 2024 Rohan Barar
-# Copyright (c) 2024 Oskar Manhart
-# Copyright (c) 2024 escapefreeg
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
 
 ### GLOBAL CONSTANTS ###
 # ERROR CODES
@@ -42,7 +34,7 @@ readonly CONTAINER_NAME="WinApps" # FOR 'docker' AND 'podman' ONLY
 readonly RDP_PORT=3389
 readonly DOCKER_IP="127.0.0.1"
 # shellcheck disable=SC2155 # Silence warnings regarding masking return values through simultaneous declaration and assignment.
-readonly RUNID="${RANDOM}" #Set a random int for the run ID to assist with logging
+readonly RUNID="${RANDOM}"
 
 ### GLOBAL VARIABLES ###
 # WINAPPS CONFIGURATION FILE

diff --git a/compose.yaml b/compose.yaml
@@ -1,9 +1,3 @@
-# Copyright (c) 2024 Oskar Manhart
-# Copyright (c) 2024 Rohan Barar
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 # For documentation, FAQ, additional configuration options and technical help, visit: https://github.com/dockur/windows
 
 name: "winapps" # Docker Compose Project Name.

diff --git a/default.nix b/default.nix
@@ -1,8 +1,3 @@
-# Copyright (c) 2024 Oskar Manhart
-# All rights reserved.
-#
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
 (import (
   let
     lock = builtins.fromJSON (builtins.readFile ./flake.lock);

diff --git a/docs/docker.md b/docs/docker.md
@@ -12,7 +12,7 @@ Although WinApps supports using `QEMU+KVM+libvirt` as a backend for running Wind
 You can find a guide for installing `Docker Engine` [here](https://docs.docker.com/engine/install/).
 
 ### Setup `Docker` Container
-WinApps utilises `docker compose` to configure Windows VMs. A template [`compose.yaml`](https://github.com/winapps-org/winapps/blob/main/compose.yaml) is provided.
+WinApps utilises `docker compose` to configure Windows VMs. A template [`compose.yaml`](../compose.yaml) is provided.
 
 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`.