docs(cli): add install-deps command and reference to it

microsoft · Apr 30, 2021 · e1b3b75 · e1b3b75
1 parent 9da718d
commit e1b3b75
Show file tree

Hide file tree

Showing 6 changed files with 106 additions and 32 deletions.
diff --git a/docs/src/cli.md b/docs/src/cli.md
@@ -369,5 +369,24 @@ $ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="pd
 $ playwright pdf https://en.wikipedia.org/wiki/PDF wiki.pdf
 ```
 
+## Install system dependencies
+
+Ubuntu 18.04 and Ubuntu 20.04 system dependencies can get installed automatically. This is useful for CI environments.
+
+```sh js
+# See command help
+$ npx playwright install-deps
+```
+
+```sh java
+# See command help
+$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="install-deps"
+```
+
+```sh python
+# See command help
+$ playwright install-deps
+```
+
 ## Known limitations
 Opening WebKit Web Inspector will disconnect Playwright from the browser. In such cases, code generation will stop.
diff --git a/docs/src/intro-csharp.md b/docs/src/intro-csharp.md
@@ -48,12 +48,26 @@ Command Line Interface [CLI](./cli.md) can be used to record user interactions a
 
 ## System requirements
 
-The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
-
-* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
-* **macOS**: Requires 10.14 or above.
-* **Linux**: Depending on your Linux distribution, you might need to install additional
-  dependencies to run the browsers.
-  * Firefox requires Ubuntu 18.04+
-  * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
-    which is based on Ubuntu.
+Playwright requires **.NET 5** or newer. The browser binaries for Chromium,
+Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
+
+### Windows
+
+Works with Windows and Windows Subsystem for Linux (WSL).
+
+### macOS
+
+Requires 10.14 (Mojave) or above.
+
+### Linux
+
+Depending on your Linux distribution, you might need to install additional
+dependencies to run the browsers.
+
+:::note
+Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
+:::
+
+See also in the [Command Line Interface](./cli.md#install-system-dependencies)
+which has a command to install all necessary dependencies automatically for Ubuntu
+LTS releases.
diff --git a/docs/src/intro-java.md b/docs/src/intro-java.md
@@ -128,10 +128,23 @@ $ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="co
 Playwright requires **Java 8** or newer. The browser binaries for Chromium,
 Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
 
-* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
-* **macOS**: Requires 10.14 or above.
-* **Linux**: Depending on your Linux distribution, you might need to install additional
-  dependencies to run the browsers.
-  * Firefox requires Ubuntu 18.04+
-  * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
-    which is based on Ubuntu.
+### Windows
+
+Works with Windows and Windows Subsystem for Linux (WSL).
+
+### macOS
+
+Requires 10.14 (Mojave) or above.
+
+### Linux
+
+Depending on your Linux distribution, you might need to install additional
+dependencies to run the browsers.
+
+:::note
+Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
+:::
+
+See also in the [Command Line Interface](./cli.md#install-system-dependencies)
+which has a command to install all necessary dependencies automatically for Ubuntu
+LTS releases.
diff --git a/docs/src/intro-js.md b/docs/src/intro-js.md
@@ -100,10 +100,23 @@ let page: import('playwright').Page;
 Playwright requires Node.js version 10.17 or above. The browser binaries for Chromium,
 Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
 
-* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
-* **macOS**: Requires 10.14 or above.
-* **Linux**: Depending on your Linux distribution, you might need to install additional
-  dependencies to run the browsers.
-  * Firefox requires Ubuntu 18.04+
-  * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
-    which is based on Ubuntu.
+### Windows
+
+Works with Windows and Windows Subsystem for Linux (WSL).
+
+### macOS
+
+Requires 10.14 (Mojave) or above.
+
+### Linux
+
+Depending on your Linux distribution, you might need to install additional
+dependencies to run the browsers.
+
+:::note
+Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
+:::
+
+See also in the [Command Line Interface](./cli.md#install-system-dependencies)
+which has a command to install all necessary dependencies automatically for Ubuntu
+LTS releases.
diff --git a/docs/src/intro-python.md b/docs/src/intro-python.md
@@ -80,13 +80,26 @@ $ playwright codegen wikipedia.org
 
 ## System requirements
 
-Playwright requires Python version 3.7 or above. The browser binaries for Chromium,
+Playwright requires Python 3.7 or above. The browser binaries for Chromium,
 Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
 
-* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL).
-* **macOS**: Requires 10.14 or above.
-* **Linux**: Depending on your Linux distribution, you might need to install additional
-  dependencies to run the browsers.
-  * Firefox requires Ubuntu 18.04+
-  * For Ubuntu 20.04, the additional dependencies are defined in [our Docker image](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal),
-    which is based on Ubuntu.
+### Windows
+
+Works with Windows and Windows Subsystem for Linux (WSL).
+
+### macOS
+
+Requires 10.14 (Mojave) or above.
+
+### Linux
+
+Depending on your Linux distribution, you might need to install additional
+dependencies to run the browsers.
+
+:::note
+Only Ubuntu 18.04 and Ubuntu 20.04 are officially supported.
+:::
+
+See also in the [Command Line Interface](./cli.md#install-system-dependencies)
+which has a command to install all necessary dependencies automatically for Ubuntu
+LTS releases.
diff --git a/docs/src/troubleshooting.md b/docs/src/troubleshooting.md
@@ -10,7 +10,9 @@ title: "Troubleshooting"
 Playwright does self-inspection every time it runs to make sure the browsers can be launched successfully. If there are missing
 dependencies, playwright will print instructions to acquire them.
 
-We also provide [Ubuntu 18.04 dockerfile](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.bionic) and [Ubuntu 20.04 dockerfile](https://github.com/microsoft/playwright/blob/master/utils/docker/Dockerfile.focal) with the list of Debian dependencies.
+See also in the [Command Line Interface](./cli.md#install-system-dependencies)
+which has a command to install all necessary dependencies automatically for Ubuntu
+LTS releases.
 
 ## Code transpilation issues