docs: document WSL

Closes #1837
puppeteer · Dec 9, 2022 · a9b4f1c · a9b4f1c
1 parent 5a17bee
commit a9b4f1c
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -281,6 +281,19 @@ script:
   - npm test
 ```
 
+## Running Puppeteer on WSL (Windows subsystem for Linux)
+
+See [this thread](https://github.com/puppeteer/puppeteer/issues/1837) with some tips specific to WSL. In a nutshell, you need to install missing dependencies by either:
+
+1. [Installing Chrome on WSL to install all dependencies](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps#install-google-chrome-for-linux)
+2. Installing required dependencies manually: `sudo apt install libgtk-3-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2`.
+
+:::caution
+
+The list of required dependencies might get outdated and depend on what you already have installed.
+
+:::
+
 ## Running Puppeteer on CircleCI
 
 Running Puppeteer smoothly on CircleCI requires the following steps: