docs(dotnet): installation (#7877)

This commit is contained in:
Anže Vodovnik 2021-07-28 14:56:24 +02:00 committed by GitHub
parent be75291b1e
commit e4273368fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -7,6 +7,15 @@ This is a browser installation guide for Playwright Library. If you are using Pl
<!-- TOC --> <!-- TOC -->
### Prerequisites for .NET
* langs: csharp
All examples require the `Microsoft.Playwright.CLI` to be installed. You only have to do this once:
```bash
dotnet tool install -g Microsoft.Playwright.CLI
```
## Managing browser binaries ## Managing browser binaries
Each version of Playwright needs specific versions of browser binaries to operate. By default, Playwright downloads Chromium, WebKit and Firefox browsers into the OS-specific cache folders: Each version of Playwright needs specific versions of browser binaries to operate. By default, Playwright downloads Chromium, WebKit and Firefox browsers into the OS-specific cache folders:
@ -20,6 +29,11 @@ pip install playwright
playwright install playwright install
``` ```
```bash csharp
# In your solution/project folder...
playwright install
```
These browsers will take a few hundred megabytes of disk space when installed: These browsers will take a few hundred megabytes of disk space when installed:
```bash ```bash
@ -60,6 +74,20 @@ $env:PLAYWRIGHT_BROWSERS_PATH="$env:USERPROFILE\pw-browsers"
mvn test mvn test
``` ```
```bash csharp
# Linux/macOS
PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers
playwright install
# Windows with cmd.exe
set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
playwright install
# Windows with PowerShell
$env:PLAYWRIGHT_BROWSERS_PATH="$env:USERPROFILE\pw-browsers"
playwright install
```
When running Playwright scripts, ask it to search for browsers in a shared location. When running Playwright scripts, ask it to search for browsers in a shared location.
```bash python ```bash python
@ -85,6 +113,19 @@ $env:PLAYWRIGHT_BROWSERS_PATH="$env:USERPROFILE\pw-browsers"
mvn test mvn test
``` ```
```bash csharp
# Linux/macOS
PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers dotnet test
# Windows with cmd.exe
set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
dotnet test
# Windows with PowerShell
$env:PLAYWRIGHT_BROWSERS_PATH="$env:USERPROFILE\pw-browsers"
dotnet test
```
Playwright keeps track of packages that need those browsers and will garbage collect them as you update Playwright to the newer versions. Playwright keeps track of packages that need those browsers and will garbage collect them as you update Playwright to the newer versions.
:::note :::note
@ -127,6 +168,19 @@ $env:HTTPS_PROXY="https://192.0.2.1"
mvn test mvn test
``` ```
```bash csharp
# Linux/macOS
HTTPS_PROXY=https://192.0.2.1 playwright install
# Windows with cmd.exe
set HTTPS_PROXY=https://192.0.2.1
playwright install
# Windows with PowerShell
$env:HTTPS_PROXY="https://192.0.2.1"
playwright install
```
## Download from artifact repository ## Download from artifact repository
By default, Playwright downloads browsers from Microsoft CDN. By default, Playwright downloads browsers from Microsoft CDN.
@ -164,6 +218,19 @@ $env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1"
mvn test mvn test
``` ```
```bash csharp
# Linux/macOS
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 playwright install
# Windows with cmd.exe
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
playwright install
# Windows with PowerShell
$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1"
playwright install
```
It is also possible to use a per-browser download hosts using `PLAYWRIGHT_CHROMIUM_DOWNLOAD_HOST`, `PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST` and `PLAYWRIGHT_WEBKIT_DOWNLOAD_HOST` env variables that It is also possible to use a per-browser download hosts using `PLAYWRIGHT_CHROMIUM_DOWNLOAD_HOST`, `PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST` and `PLAYWRIGHT_WEBKIT_DOWNLOAD_HOST` env variables that
take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`. take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`.
@ -178,6 +245,11 @@ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 mvn test PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 mvn test
``` ```
```bash csharp
# Linux/macOS
PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 playwright install
```
## Skip browser downloads ## Skip browser downloads
In certain cases, it is desired to avoid browser downloads altogether because In certain cases, it is desired to avoid browser downloads altogether because
@ -214,6 +286,19 @@ $env:PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
mvn test mvn test
``` ```
```bash csharp
# Linux/macOS
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 playwright install
# Windows with cmd.exe
set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
playwright install
# Windows with PowerShell
$env:PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
playwright install
```
## Download single browser binary ## Download single browser binary
* langs: python * langs: python