diff --git a/install/winapps.conf b/install/winapps.conf new file mode 100644 index 0000000..10bde46 --- /dev/null +++ b/install/winapps.conf @@ -0,0 +1,134 @@ +################################## +# WINAPPS CONFIGURATION FILE # +################################## + +# INSTRUCTIONS +# - Leading and trailing whitespace are ignored. +# - Empty lines are ignored. +# - Lines starting with '#' are ignored. +# - All characters following a '#' are ignored. + +# [WINDOWS USERNAME] +RDP_USER="docker" + +# [WINDOWS PASSWORD] +# NOTES: +# - If using FreeRDP v3.9.0 or greater, you *have* to set a password +RDP_PASS="docker" + +# [WINDOWS DOMAIN] +# DEFAULT VALUE: '' (BLANK) +RDP_DOMAIN="" + +# [WINDOWS IPV4 ADDRESS] +# NOTES: +# - If using 'libvirt', 'RDP_IP' will be determined by WinApps at runtime if left unspecified. +# DEFAULT VALUE: +# - 'docker': '127.0.0.1' +# - 'podman': '127.0.0.1' +# - 'libvirt': '' (BLANK) +#RDP_IP="127.0.0.1" + +# [VM NAME] +# NOTES: +# - Only applicable when using 'libvirt' +# - The libvirt VM name must match so that WinApps can determine VM IP, start the VM, etc. +# DEFAULT VALUE: 'RDPWindows' +#VM_NAME="RDPWindows" + +# [WINAPPS BACKEND] +# DEFAULT VALUE: 'docker' +# VALID VALUES: +# - 'docker' +# - 'podman' +# - 'libvirt' +# - 'manual' +WAFLAVOR="docker" + +# [DISPLAY SCALING FACTOR] +# NOTES: +# - If an unsupported value is specified, a warning will be displayed. +# - If an unsupported value is specified, WinApps will use the closest supported value. +# DEFAULT VALUE: '100' +# VALID VALUES: +# - '100' +# - '140' +# - '180' +RDP_SCALE="100" + +# [MOUNTING REMOVABLE PATHS FOR FILES] +# NOTES: +# - By default, `udisks` (which you most likely have installed) uses /run/media for mounting removable devices. +# This improves compatibility with most desktop environments (DEs). +# ATTENTION: The Filesystem Hierarchy Standard (FHS) recommends /media instead. Verify your system's configuration. +# - To manually mount devices, you may optionally use /mnt. +# REFERRENCE: https://wiki.archlinux.org/title/Udisks#Mount_to_/media +REMOVABLE_MEDIA="/run/media" + +# [ADDITIONAL FREERDP FLAGS & ARGUMENTS] +# NOTES: +# - 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 +home-drive' +# VALID VALUES: See https://github.com/awakecoding/FreeRDP-Manuals/blob/master/User/FreeRDP-User-Manual.markdown +RDP_FLAGS="/cert:tofu /sound /microphone +home-drive" + +# [DEBUG WINAPPS] +# NOTES: +# - Creates and appends to ~/.local/share/winapps/winapps.log when running WinApps. +# DEFAULT VALUE: 'true' +# VALID VALUES: +# - 'true' +# - 'false' +DEBUG="true" + +# [AUTOMATICALLY PAUSE WINDOWS] +# NOTES: +# - This is currently INCOMPATIBLE with 'docker' and 'manual'. +# - See https://github.com/dockur/windows/issues/674 +# DEFAULT VALUE: 'off' +# VALID VALUES: +# - 'on' +# - 'off' +AUTOPAUSE="off" + +# [AUTOMATICALLY PAUSE WINDOWS TIMEOUT] +# NOTES: +# - This setting determines the duration of inactivity to tolerate before Windows is automatically paused. +# - This setting is ignored if 'AUTOPAUSE' is set to 'off'. +# - The value must be specified in seconds (to the nearest 10 seconds e.g., '30', '40', '50', etc.). +# - For RemoteApp RDP sessions, there is a mandatory 20-second delay, so the minimum value that can be specified here is '20'. +# - Source: https://techcommunity.microsoft.com/t5/security-compliance-and-identity/terminal-services-remoteapp-8482-session-termination-logic/ba-p/246566 +# DEFAULT VALUE: '300' +# VALID VALUES: >=20 +AUTOPAUSE_TIME="300" + +# [FREERDP COMMAND] +# NOTES: +# - WinApps will attempt to automatically detect the correct command to use for your system. +# DEFAULT VALUE: '' (BLANK) +# VALID VALUES: The command required to run FreeRDPv3 on your system (e.g., 'xfreerdp', 'xfreerdp3', etc.). +FREERDP_COMMAND="" + +# [TIMEOUTS] +# NOTES: +# - These settings control various timeout durations within the WinApps setup. +# - Increasing the timeouts is only necessary if the corresponding errors occur. +# - Ensure you have followed all the Troubleshooting Tips in the error message first. + +# PORT CHECK +# - The maximum time (in seconds) to wait when checking if the RDP port on Windows is open. +# - Corresponding error: "NETWORK CONFIGURATION ERROR" (exit status 13). +# DEFAULT VALUE: '5' +PORT_TIMEOUT="5" + +# RDP CONNECTION TEST +# - The maximum time (in seconds) to wait when testing the initial RDP connection to Windows. +# - Corresponding error: "REMOTE DESKTOP PROTOCOL FAILURE" (exit status 14). +# DEFAULT VALUE: '30' +RDP_TIMEOUT="30" + +# APPLICATION SCAN +# - The maximum time (in seconds) to wait for the script that scans for installed applications on Windows to complete. +# - Corresponding error: "APPLICATION QUERY FAILURE" (exit status 15). +# DEFAULT VALUE: '60' +APP_SCAN_TIMEOUT="60"