Merge branch 'release/0.1.0'

Author: jcchikikomori

.config/winapps/winapps.conf

@@ -67,10 +67,11 @@ REMOVABLE_MEDIA="/run/media"
 
 # [ADDITIONAL FREERDP FLAGS & ARGUMENTS]
 # NOTES:
+# - On Steam Deck, include /sec:tls to connect via TLS to the VM's default self-signed certificate (less secure; consider replacing with a trusted cert).
 # - 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"
+RDP_FLAGS="/sec:tls /cert:tofu /sound /microphone +home-drive"
 
 # [DEBUG WINAPPS]
 # NOTES:
@@ -104,9 +105,10 @@ AUTOPAUSE_TIME="300"
 # [FREERDP COMMAND]
 # NOTES:
 # - WinApps will attempt to automatically detect the correct command to use for your system.
+# - Steam Deck: FreeRDP v3 is required; set this to 'xfreerdp3' if auto-detection fails.
 # DEFAULT VALUE: '' (BLANK)
-# VALID VALUES: The command required to run FreeRDPv3 on your system (e.g., 'xfreerdp', 'xfreerdp3', etc.).
-FREERDP_COMMAND=""
+# VALID VALUES: The command required to run FreeRDPv3 on your system (e.g., 'xfreerdp', 'xfreerdp3', 'sdl-freerdp3', etc.).
+FREERDP_COMMAND="xfreerdp3"
 
 # [TIMEOUTS]
 # NOTES:

.gitignore

@@ -1,2 +1,3 @@
 oem/
 .env
+*.iso

README.md

@@ -81,3 +81,20 @@ docker compose --file ~/.config/winapps/compose.yaml restart # Restart the Windo
 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
 ```
+
+## Steam Deck Notes
+
+- Recommended backend: Prefer `Docker` (rootless/systemless) or `libvirt` on SteamOS. Traditional rootful Docker installs and mutable system changes can be fragile on Deck; rootless/systemless Docker or `libvirt` are more resilient across updates.
+- FreeRDP requirement: Install FreeRDP v3 so the `xfreerdp3` client is available on the system. WinApps uses FreeRDP v3; older clients are not supported.
+- RDP security flag: Ensure `RDP_FLAGS` includes `/sec:tls` to allow connecting to the VM using TLS with the default self-signed certificate. This reduces strict certificate validation and is less secure; consider replacing the certificate with a trusted one in production setups.
+- Command selection: If auto-detection fails, explicitly set `FREERDP_COMMAND` to `xfreerdp3` in your config.
+
+Example `~/.config/winapps/winapps.conf` entries:
+
+```ini
+# Use TLS and accept self-signed cert on first use
+RDP_FLAGS="/sec:tls /cert:tofu /sound /microphone +home-drive"
+
+# Force FreeRDP v3 client
+FREERDP_COMMAND="xfreerdp3"
+```