Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
Max Schmitt 2021-04-30 16:44:30 +02:00 committed by GitHub
parent 934bc672f7
commit 7405655c26
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 103 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/src/cli.md
View file

@ -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 $ 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 ## Known limitations
Opening WebKit Web Inspector will disconnect Playwright from the browser. In such cases, code generation will stop. Opening WebKit Web Inspector will disconnect Playwright from the browser. In such cases, code generation will stop.

27
docs/src/intro-csharp.md
View file

@ -50,10 +50,23 @@ Command Line Interface [CLI](./cli.md) can be used to record user interactions a
The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux): 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). ### Windows
* **macOS**: Requires 10.14 or above.
* **Linux**: Depending on your Linux distribution, you might need to install additional Works with Windows and Windows Subsystem for Linux (WSL).
dependencies to run the browsers.
* Firefox requires Ubuntu 18.04+ ### macOS
* 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. 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.

27
docs/src/intro-java.md
View file

@ -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, Playwright requires **Java 8** or newer. The browser binaries for Chromium,
Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux): Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL). ### Windows
* **macOS**: Requires 10.14 or above.
* **Linux**: Depending on your Linux distribution, you might need to install additional Works with Windows and Windows Subsystem for Linux (WSL).
dependencies to run the browsers.
* Firefox requires Ubuntu 18.04+ ### macOS
* 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. 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.

27
docs/src/intro-js.md
View file

@ -100,10 +100,23 @@ let page: import('playwright').Page;
Playwright requires Node.js version 10.17 or above. The browser binaries for Chromium, 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): Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL). ### Windows
* **macOS**: Requires 10.14 or above.
* **Linux**: Depending on your Linux distribution, you might need to install additional Works with Windows and Windows Subsystem for Linux (WSL).
dependencies to run the browsers.
* Firefox requires Ubuntu 18.04+ ### macOS
* 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. 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.

29
docs/src/intro-python.md
View file

@ -80,13 +80,26 @@ $ playwright codegen wikipedia.org
## System requirements ## 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): Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
* **Windows**: Works with Windows and Windows Subsystem for Linux (WSL). ### Windows
* **macOS**: Requires 10.14 or above.
* **Linux**: Depending on your Linux distribution, you might need to install additional Works with Windows and Windows Subsystem for Linux (WSL).
dependencies to run the browsers.
* Firefox requires Ubuntu 18.04+ ### macOS
* 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. 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.

4
docs/src/troubleshooting.md
View file

@ -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 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. 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 ## Code transpilation issues