You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: gitkraken-client/windows-subsystem-for-linux.md
+11-15Lines changed: 11 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,20 +7,21 @@ taxonomy:
7
7
8
8
---
9
9
10
-
## Working with WSL 2
10
+
## What is WSL/WSL 2?
11
11
12
12
<ahref="https://learn.microsoft.com/en-us/windows/wsl/about"target="_blank">Windows Subsystem for Linux (WSL)</a> lets developers install a Linux distribution and use Linux applications, utilities, and Bash command-line tools directly on Windows. <ahref="https://learn.microsoft.com/en-us/windows/wsl/compare-versions"target="_blank">WSL 2</a> utilizes an actual Linux kernel inside a managed virtual machine (VM) to provide improved performance and full system call capability, and is now the default WSL version. Microsoft notes that WSL 2 lacks performance across OS file systems however, and this issue can be addressed by storing your project files on the same operating system as the tools you are running to work on the project.
13
13
14
14
Microsoft also introduced <a href="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps"
15
15
target="_blank">Windows Subsystem for Linux GUI (WSLg)</a>, a feature aimed to provide the ability to run Linux GUI applications which work best, or exclusively, in a Linux/WSL 2 environment. Using WSLg also better enables Linux GUI applications like the Linux version of GitKraken Client to feel native and natural to use on Windows by integrating them closely into the Windows desktop experience when running within WSL 2.
GitKraken Client can work with repos stored on your WSL 2 file system when installed within the WSL 2 environment and using WSL’s built-in display server functionality, <ahref="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps"target="_blank">WSLg</a>, for GUI support. The Linux version of GitKraken client has been updated to fix common issues when operating GitKraken within WSL 2, and includes settings to [set preferences](#preferences_for_wsl) for where to open web links and files opened by GitKraken running within WSL 2.
21
22
22
23
<divclass='callout callout--warning'>
23
-
<p>Note: GitKraken Client does not currently support cross file system access for repos stored on both Windows and WSL 2 and should be installed on the operating system where your repos are stored for the best experience. Opening repos across file systems may severly degrade performance and features may not work as intended.</p>
24
+
<p>Note: GitKraken Client does not currently support cross file system access for repos stored on both Windows and WSL. GitKraken Client should be installed on the operating system where your repos are stored for the best experience. Opening repos across file systems may severly degrade performance and features may not work as intended.</p>
24
25
</div>
25
26
26
27
GitKraken Client will also detect where a repo is stored and allow you to open it in the proper version of GitKraken Client so you can better manage GitKraken when working with both Windows and WSL repos. For more information, see the section on [Working Across File Systems](#working_across_file_systems).
@@ -35,7 +36,7 @@ No Git tools are required to use GitKraken Client, but if you want to utilize ad
35
36
36
37
Below are instructions and minimum requirements to run GitKraken Client within WSL 2.
37
38
***
38
-
## Requirements
39
+
## WSL 2/WSLg Requirements
39
40
40
41
- Windows 11 or Windows 10 build 19044 or later
41
42
- WSL 2 distribution
@@ -57,7 +58,7 @@ After reboot the installation will continue. You'll be asked to enter a username
57
58
58
59
WSLg is automatically included as part of the update and initial WSL setup, so you are ready to install GitKraken Client.
59
60
***
60
-
## Download and Install GitKraken Client
61
+
## Download and Install GitKraken Client on WSL 2
61
62
62
63
To install GitKraken within WSL, please follow our instructions for <ahref="https://help.gitkraken.com/gitkraken-client/how-to-install/#linux-deb-rpm-and-tar-gz-files"target="_blank">installing GitKraken Client on Linux</a> and remember to open your Linux terminal from Windows as administrator.
63
64
@@ -77,9 +78,6 @@ gitkraken
77
78
```
78
79
Note: If you choose to install GitKraken Client from the .tar.gz file, gitkraken must be installed on `PATH` for this command to work
79
80
***
80
-
81
-
<divid="preferences_for_wsl"></div>
82
-
83
81
## Preferences for GitKraken on WSL 2
84
82
85
83
When running GitKraken Client within WSL 2, additional preferences are available to tell GitKraken where you'd like to open URLs and files opened by GitKraken. You'll see these settings in `Preferences` > `General` when running within WSL 2.
@@ -88,12 +86,12 @@ When running GitKraken Client within WSL 2, additional preferences are available
88
86
89
87
By default, URLs will open in your Windows default browser and other files opened by GitKraken will attempt to open on the host distribution.
90
88
91
-
## Known Issues
89
+
## Known Issues with WSL 2
92
90
93
91
- <ahref="https://github.com/microsoft/wslg/issues/388"target="_blank">HiDPI Displays cause WSLg to inconsistently scale the UI</a>
94
92
- <ahref="https://github.com/microsoft/wslg/issues/727"target="_blank">Window snapping does not work with WSLg</a>
95
93
96
-
## Troubleshooting
94
+
## Troubleshooting WSL 2
97
95
98
96
If GitKraken loads with a black screen, or other graphical errors persist, try reopening GitKraken Client as administrator or update your graphics card drivers.
99
97
@@ -103,11 +101,9 @@ wsl --shutdown
103
101
```
104
102
Then, reopen your Linux distribution or GitKraken Client as administrator.
105
103
***
104
+
## Working Across File Systems in WSL 2
106
105
107
-
<divid="working_across_file_systems"></div>
108
-
## Working Across File Systems
109
-
110
-
Microsoft recommends against working across operating systems when using WSL 2, and GitKraken does not currently support cross file system access of repos. To better manage multiple installations of GitKraken, GitKraken will notify you when opening a repo across operating systems and allow you to directly open the repo in the recommended installation of GitKraken. When attempting to open a new repo that is on WSL 2 from GitKraken installed on Windows, or Windows from GitKraken installed on WSL 2, the following message will appear:
106
+
Microsoft recommends against working across operating systems when using WSL 2, and GitKraken does not currently support cross file system access of repos. To get around this limitation, you can install a seperate GitKraken Client on both the Windows side and WSL Linux side. Then GitKraken will notify you when opening a repo across operating systems and allow you to directly open the repo in the recommended installation of GitKraken. When attempting to open a new repo that is on WSL 2 from GitKraken installed on Windows, or Windows from GitKraken installed on WSL 2, the following message will appear:
@@ -121,5 +117,5 @@ You will be asked to choose an option to proceed:
121
117
- Closing the message will cancel opening the repository
122
118
123
119
<divclass='callout callout--warning'>
124
-
<p>Note: If you open a repository in WSL through a mapped network drive from Windows, GitKraken Client will not detect that the repository is being accessed across file systems and attempt to open normally. </p>
120
+
<p>Note: If you open a repository in WSL through a mapped network drive from Windows, GitKraken Client will not detect that the repository is being accessed across file systems and attempt to open normally. This may lead to unintended behavior and is not recommended.</p>
0 commit comments