{"id":16162025,"url":"https://github.com/desktopecho/kwsl","last_synced_at":"2026-03-07T14:31:27.526Z","repository":{"id":40334970,"uuid":"282482342","full_name":"DesktopECHO/kWSL","owner":"DesktopECHO","description":"KDE Neon 6.0 installer for WSL1 or WSL2.","archived":false,"fork":false,"pushed_at":"2026-01-12T02:44:39.000Z","size":1288954,"stargazers_count":199,"open_issues_count":2,"forks_count":49,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-01-12T04:50:16.940Z","etag":null,"topics":["kde","kde-desktop","kde-neon","kde-plasma","ubuntu","windows","wsl","wsl1","wsl2","xrdp"],"latest_commit_sha":null,"homepage":"","language":"Batchfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DesktopECHO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-25T16:29:15.000Z","updated_at":"2026-01-05T06:48:28.000Z","dependencies_parsed_at":"2024-10-10T02:38:55.287Z","dependency_job_id":null,"html_url":"https://github.com/DesktopECHO/kWSL","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/DesktopECHO/kWSL","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FkWSL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FkWSL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FkWSL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FkWSL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DesktopECHO","download_url":"https://codeload.github.com/DesktopECHO/kWSL/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FkWSL/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30217428,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T14:02:48.375Z","status":"ssl_error","status_checked_at":"2026-03-07T14:02:43.192Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kde","kde-desktop","kde-neon","kde-plasma","ubuntu","windows","wsl","wsl1","wsl2","xrdp"],"created_at":"2024-10-10T02:28:50.062Z","updated_at":"2026-03-07T14:31:27.473Z","avatar_url":"https://github.com/DesktopECHO.png","language":"Batchfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kWSL.cmd • KDE Neon 6 Desktop for WSL\n\n  - Online install of KDE Neon in WSL, accessible via RDP.  If you prefer GTK, see [**xWSL**](https://github.com/DesktopECHO/xWSL) or [**Kali-xRDP**](https://github.com/DesktopECHO/Kali-xRDP)\n  - Runs on Windows 10 / Windows Server 2019 and newer, including Hyper-V Core.\n  - xRDP Display Server; no additional Xserver download/configuration required.\n  - High-quality RDP audio playback; video playback and YouTube work well and maintains audio sync.\n  - If you want to accesss kWSL remotely, Chrome Remote Desktop is pre-installed (Never expose RDP servers to the Internet.) Configuration steps are [**here**](https://github.com/DesktopECHO/kWSL/wiki/Enable-Chrome-Remote-Desktop)\n\n![image](https://user-images.githubusercontent.com/33142753/100149597-d3d57d80-2e74-11eb-899a-a7476b016e27.png)\n\n**IMPORTANT!** \n - Windows 11 requires 22H2 Update *(Sun Valley 2, September 2022)*\n - Windows Server / Windows 10 require latest updates from Windows Update.\n\n## INSTALL INSTRUCTIONS\nFrom an elevated CMD.EXE prompt change to your desired install directory and type/paste the following command:\n\n```\nPowerShell -executionpolicy bypass -command \"wget https://github.com/DesktopECHO/kWSL/raw/master/kWSL.cmd -UseBasicParsing -OutFile kWSL.cmd ; .\\kWSL.cmd\"\n```\n\nYou will be asked a few questions.  The install script will determine current DPI scaling, or set your own value if preferred:\n\n```\n[KDE Neon 6 Installer for WSL v.20240301]\n\nSet a name for this KDE Neon instance.  Hit Enter to use default.\nKeep this name simple, no space or underscore characters [Neon]:\nPort number for xRDP traffic or hit Enter to use default [3399]:\nPort number for SSHd traffic or hit Enter to use default [3322]:\nSet a custom DPI scale, or hit Enter for Windows default [1]: 1.25\n[Not recommended!] Type X to eXclude from Windows Defender:\n\nInstalling kWSL Distro [Neon] to \"C:\\Neon\"\nThis will take a few minutes, please wait...\n```\n\nThe installer will download all the necessary packages to transform the [Jammy base image](https://cloud-images.ubuntu.com/jammy/current/) into KDE Neon User Edition.  Reference times will vary depending on system performance and the presence of antivirus software.  A fast system/network can complete the install in about 10 minutes.\n\n```\n[19:19:01] Importing distro userspace (~0m30s)\n[19:19:14] Git clone and update repositories (~1m00s)\n[19:20:22] Prepare userspace (~1m00s)\n[19:20:45] Installing Prerequisites (~2m00s)\n[19:23:12] KDE Neon 6 (~7m00s)\n[19:31:12] Web Browser, CRD, VLC 4 (~1m00s)\n[19:32:10] Cleaning-up... (~0m15s)\n```\n\nNear the end of the script you will be prompted to create a non-root user.  This user will be automatically added to sudo'ers.\n\n```\nOpen Windows Firewall Ports for xRDP, SSH, mDNS...\nBuilding RDP Connection file, Console link, Init system...\nBuilding Scheduled Task...\nSUCCESS: The scheduled task \"Neon\" has successfully been created.\n\n      Start: Fri 03/01/2024 @ 19:18\n        End: Fri 03/01/2024 @ 19:32\n   Packages: 1434\n\n  - xRDP Server listening on port 3399 and SSHd on port 3322.\n\n  - Links for GUI and Console sessions have been placed on your desktop.\n\n  - (Re)launch init from the Task Scheduler or by running the following command:\n    schtasks /run /tn Neon\n\n Neon Installation Complete!  GUI will start in a few secon\n```\n\n**When the script completes you will be logged-in to your KDE Neon Desktop.** \n\n## Optional: Set KDE to start at boot (like a service) instead of starting at login (default setting)\n\n - Right-click the task in Task Scheduler, click properties\n - Click the checkbox for **Run whether user is logged on or not** and click **OK**\n - Click the Triggers tab and change the trigger from **At log on** to **At startup**\n - Enter your Windows credentials when prompted\n \n Reboot your PC when complete and kWSL will startup automatically.\n\n## Optional: Convert WSL Instance\n\nExample of conversion to WSL2:\n - Stop WSL instance (Using default instance name _NeonWSL_ in this example):\n ````wsl --terminate Neon````\n - Convert the instance to WSL2:\n ````wsl --set-version Neon 2````\n - Restart KDE Neon Instance under WSL2:\n ````schtasks /run /tn Neon````\n\nProcedure is the same for switching back to WSL1: ````wsl --set-version NeonWSL 1````\n\n## Make it your own\n\nIt's best to fork this project so you (and only you) control the packages and files in the deployment.\n\n- Sign into GitHub and fork this project\n- Edit ```kWSL.cmd```.  On line 2 you will see ```SET GITORG=DesktopECHO``` - Change ```DesktopECHO``` to the name of your own repository.\n- Customize the script any way you like.\n- Launch the script using your repository name:\n ```PowerShell -executionpolicy bypass -command \"wget https://github.com/YOUR-REPO-NAME/kWSL/raw/master/kWSL.cmd -UseBasicParsing -OutFile kWSL.cmd ; .\\kWSL.cmd\"```\n\n## Quirks / Limitations / Additional Info:\n\n- H.264 Enabled in XRDP\n- Kwin desktop composition is enabled by default \n- When you log out out of a KDE session the WSL instance is restarted.  This is the equivilent to having a freshly-booted desktop environment at every login, but the 'reboot' process only takes about 5 seconds.  \n- kWSL should work fine with an X Server instead of xRDP but this has not been thoroughly tested.  The file ```/etc/profile.d/kWSL.sh``` contains WSL-centric environment variables that may need adjustment such as LIBGL_ALWAYS_INDIRECT.\n- Plasma-discover doesn't work in Server 2019 / Win 10 v.1809 -- The installer will remove it if you're running an affected OS. \n- WSL1 Doesn't work with PolicyKit.  Enabled kdesu/gksu for apps needing elevated rights (plasma-discover, ksystemlog, muon, root console.)    \n- KDE Lockscreen is not implemented (due to policykit)  \n- Patched KDE Activity Manager to disable WAL in sqlite3. \n- Mozilla Seamonkey is included as a stable/maintained browser. \n- QtWebEngine (Chromium-based) browsers like Falkon and Konqueror now work. (July/21)\n- Installed image consumes approximately 3 GB of disk space.\n- Apt-fast added to improve download speed and reliability.\n- Default installation uses the Breeze theme and Windows fonts (Segoe UI / Cascadia Code)\n- This is a basic installation of KDE to save bandwidth.  If you want the **complete** KDE Desktop environment (+3GB Disk) run ```sudo pkcon -y install neon-all``` \n\n![image](https://user-images.githubusercontent.com/33142753/100148485-33cb2480-2e73-11eb-932b-54e34b445575.png)\n\n![image](https://user-images.githubusercontent.com/33142753/100385367-c21ce300-2ff8-11eb-9276-6f51b366839f.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesktopecho%2Fkwsl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdesktopecho%2Fkwsl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesktopecho%2Fkwsl/lists"}