artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 19:51:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document troubleshooting steps for running sg on WSL2 (#28169)

Browse Source 
* sg: document troubleshooting steps for WSL2

* sg: Move WSL troubleshooting

Move the WSL2 troubleshooting document into `setup/troubleshooting`
along with other useful information

* sg: Update wsl doc with permalink
This commit is contained in:
Daniel Dides 2021-12-15 11:26:47 -06:00 committed by GitHub
parent 379369e3d9
commit e7ab5a441c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/dev/setup/troubleshooting.md
View File

@ -179,3 +179,9 @@ If files do not normally have group permissions in your environment
```sh
(umask 027; sg start monitoring)
```
## Installing `sg` with Windows Subsystem for Linux (WSL2)
When trying to install `sg` with the pre-built binaries on WSL2 you may run into this error message: `failed to set max open files: invalid argument`. The default configuration of WSL2 does not allow the user to modify the number of open files by default [which `sg` requires](https://github.com/sourcegraph/sourcegraph/blob/379369e3d92c9b28d5891d3251922c7737ed810b/dev/sg/main.go#L75:L90) to start. To work around this you can modify the file limits for your given session with `sudo prlimit --nofile=20000 --pid $$; ulimit -n 20000` then re-run the installation script.
Note: this change will be reverted when your session ends. You will need to reset these limits every time you open a new session and want to use `sg`.