From d0d1d144f1270b9125e3e8a80b306dc3863c5bfb Mon Sep 17 00:00:00 2001 From: Debbie O'Brien Date: Tue, 28 Feb 2023 18:09:44 +0100 Subject: [PATCH] docs: Browsers page rework (#21051) --- docs/src/browsers.md | 1116 +++++++++++++++++++++++++----------------- 1 file changed, 675 insertions(+), 441 deletions(-) diff --git a/docs/src/browsers.md b/docs/src/browsers.md index d920c47c7d..fd66307bc9 100644 --- a/docs/src/browsers.md +++ b/docs/src/browsers.md @@ -3,61 +3,331 @@ id: browsers title: "Browsers" --- -Each version of Playwright needs specific versions of browser binaries to operate. Depending on the language you use, Playwright will either download these browsers at package install time for you, or you will need to use [Playwright CLI](./cli.md) to install these browsers. +Each version of Playwright needs specific versions of browser binaries to operate. You will need to use the Playwright CLI to install these browsers. With every release, Playwright updates the versions of the browsers it supports, so that the latest Playwright would support the latest browsers at any moment. It means that every time you update playwright, you might need to re-run the `install` CLI command. -## Chromium +## Install browsers -For Google Chrome, Microsoft Edge and other Chromium-based browsers, by default, Playwright uses open source Chromium builds. -Since Chromium project is ahead of the branded browsers, when the world is on Google Chrome N, Playwright already supports -Chromium N+1 that will be released in Google Chrome and Microsoft Edge in a few weeks. +Playwright can install supported browsers. Running the command without arguments will install the default browsers. -There is also a way to opt into using Google Chrome's or Microsoft Edge's branded builds for testing. For details -on when to opt into stable channels, refer to the [Google Chrome & Microsoft Edge](#google-chrome--microsoft-edge) section below. - -## Firefox - -Playwright's Firefox version matches the recent [Firefox Stable](https://www.mozilla.org/en-US/firefox/new/) -build. - -## WebKit - -Playwright's WebKit version matches the recent WebKit trunk build, before it is used in Apple Safari and -other WebKit-based browsers. This gives a lot of lead time to react on the potential browser update issues. - -## Google Chrome & Microsoft Edge - -While Playwright can download and use the recent Chromium build, it can operate against the stock Google -Chrome and Microsoft Edge browsers available on the machine (note that Playwright doesn't install them by -default). In particular, current Playwright version will support Stable and Beta channels of these browsers. -Here is how you can opt into using the stock browser: - -```js tab=js-js -// @ts-check - -const { defineConfig } = require('@playwright/test'); - -module.exports = defineConfig({ - use: { - channel: 'chrome', - }, -}); +```bash js +npx playwright install ``` -```js tab=js-ts -import { defineConfig } from '@playwright/test'; +```bash java +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```bash python +playwright install +``` + +```bash csharp +pwsh bin/Debug/netX/playwright.ps1 install +``` + +You can also install specific browsers by providing an argument: + +```bash js +npx playwright install webkit +``` + +```bash java +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install webkit" +``` + +```bash python +playwright install webkit +``` + +```bash csharp +pwsh bin/Debug/netX/playwright.ps1 install webkit +``` + +See all supported browsers: + +```bash js +npx playwright install --help +``` + +```bash java +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --help" +``` + +```bash python +playwright install --help +``` + +```bash csharp +pwsh bin/Debug/netX/playwright.ps1 install --help +``` + +### Install browsers via API +* langs: csharp + +It's possible to run Command line tools commands via the .NET API: + +```csharp +var exitCode = Microsoft.Playwright.Program.Main(new[] {"install"}); +if (exitCode != 0) +{ + throw new Exception($"Playwright exited with code {exitCode}"); +} +``` + +### Install system dependencies + +System dependencies can get installed automatically. This is useful for CI environments. + +```bash js +npx playwright install-deps +``` + +```bash java +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install-deps" +``` + +```bash python +playwright install-deps +``` + +```bash csharp +pwsh bin/Debug/netX/playwright.ps1 install-deps +``` + +You can also install the dependencies for a single browser by passing it as an argument: + +```bash js +npx playwright install-deps chromium +``` + +```bash java +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install-deps chromium" +``` + +```bash python +playwright install-deps chromium +``` + +```bash csharp +pwsh bin/Debug/netX/playwright.ps1 install-deps chromium +``` + +It's also possible to combine `install-deps` with `install` so that the browsers and OS dependencies are installed with a single command. + +```bash js +npx playwright install --with-deps chromium +``` + +```bash java +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps chromium" +``` + +```bash python +playwright install --with-deps chromium +``` + +```bash csharp +pwsh bin/Debug/netX/playwright.ps1 install --with-deps chromium +``` + +## Update Playwright regulary + +By keeping your Playwright version up to date you will be able to use new features and test your app on the latest browser versions and catch failures before the latest browser version is released to the public. + +```bash js +# Update playwright +npm install -D @playwright/test@latest + +# Install new browsers +npx playwright install +``` +Check the [release notes](./release-notes.md) to see what the latest version is and what changes have been released. + +```bash js +# See what version of Playwright you have by running the following command +npx playwright --version +``` + +## Configure Browsers + +Playwright can run tests on chromium, webkit and firefox browsers as well as branded browsers such as Google Chrome and Microsoft Edge. It can also run on emulated tablet and mobile devices. See the [registry of device parameters](https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/server/deviceDescriptorsSource.json) for a complete list of selected desktop, tablet and mobile devices. + +### Run tests on different browsers +* langs: js + +Playwright can run your tests in multiple browsers and configurations by setting up **projects** in the config. You can also add [different options](./test-configuration) for each project. + +```js +import { defineConfig, devices } from '@playwright/test'; + export default defineConfig({ - use: { - channel: 'chrome', - }, + projects: [ + /* Test against desktop browsers */ + { + name: 'chromium', + use: { ...devices['Desktop Chrome'] }, + }, + { + name: 'firefox', + use: { ...devices['Desktop Firefox'] }, + }, + { + name: 'webkit', + use: { ...devices['Desktop Safari'] }, + }, + /* Test against mobile viewports. */ + { + name: 'Mobile Chrome', + use: { ...devices['Pixel 5'] }, + }, + { + name: 'Mobile Safari', + use: { ...devices['iPhone 12'] }, + }, + /* Test against branded browsers. */ + { + name: 'Google Chrome', + use: { ...devices['Desktop Chrome'], channel: 'chrome' }, // or 'chrome-beta' + }, + { + name: 'Microsoft Edge', + use: { ...devices['Desktop Edge'], channel: 'msedge' }, // or 'msedge-dev' + }, + ], }); ``` -```js tab=js-library -const { chromium } = require('playwright'); -const browser = await chromium.launch({ - channel: 'chrome' // or 'msedge', 'chrome-beta', 'msedge-beta', 'msedge-dev', etc. +Playwright will run all projects by default. + +```bash +npx playwright test + +Running 7 tests using 5 workers + + ✓ [chromium] › example.spec.ts:3:1 › basic test (2s) + ✓ [firefox] › example.spec.ts:3:1 › basic test (2s) + ✓ [webkit] › example.spec.ts:3:1 › basic test (2s) + ✓ [Mobile Chrome] › example.spec.ts:3:1 › basic test (2s) + ✓ [Mobile Safari] › example.spec.ts:3:1 › basic test (2s) + ✓ [Google Chrome] › example.spec.ts:3:1 › basic test (2s) + ✓ [Microsoft Edge] › example.spec.ts:3:1 › basic test (2s) +``` + +Use the `--project` command line option to run a single project. + +```bash +npx playwright test --project=firefox + +Running 1 test using 1 worker + + ✓ [firefox] › example.spec.ts:3:1 › basic test (2s) +``` + +The VS Code test runner runs your tests on the default browser of Chrome. To run on other/multiple browsers click the play button's dropdown from the testing sidebar and choose another profile or modify the default profile by clicking **Select Default Profile** and select the browsers you wish to run your tests on. + +selecting browsers + +Choose a specific profile, various profiles or all profiles to run tests on. + +choosing default profiles + +### Run tests on different browsers +* langs: python + +Run tests on a specific browser: + +```bash +pytest test_login.py --browser webkit +``` + +Run tests on multiple browsers: + +```bash +pytest test_login.py --browser webkit --browser firefox +``` + +Test against mobile viewports: + +```bash +pytest test_login.py --device iphone_13 +``` +Test against branded browsers: + +```bash +pytest test_login.py --browser-channel msedge +``` + +### Run tests on different browsers +* langs: java + +```java +import com.microsoft.playwright.*; + +public class Example { + public static void main(String[] args) { + try (Playwright playwright = Playwright.create()) { + // Launch chromium, firefox or webkit. + Browser browser = playwright.chromium().launch(); + Page page = browser.newPage(); + // ... + } + } +} +``` + +### Run tests on different browsers +* langs: csharp + +Run tests on a specific browser: + +```bash +dotnet test -- Playwright.BrowserName=webkit +``` + +To run your test on multiple browsers or configurations you need to invoke the `dotnet test` command multiple times. You can either specify the `BROWSER` environment variable or set the `Playwright.BrowserName` via the runsettings file: + +```bash +dotnet test --settings:chromium.runsettings +dotnet test --settings:firefox.runsettings +dotnet test --settings:webkit.runsettings +``` + +```xml + + + + chromium + + +``` + +### Chromium + +For Google Chrome, Microsoft Edge and other Chromium-based browsers, by default, Playwright uses open source Chromium builds. Since the Chromium project is ahead of the branded browsers, when the world is on Google Chrome N, Playwright already supports Chromium N+1 that will be released in Google Chrome and Microsoft Edge a few weeks later. + +### Google Chrome & Microsoft Edge + +While Playwright can download and use the recent Chromium build, it can operate against the branded Google Chrome and Microsoft Edge browsers available on the machine (note that Playwright doesn't install them by default). In particular, the current Playwright version will support Stable and Beta channels of these browsers. + +Available channels are `chrome`, `msedge`, `chrome-beta`, `msedge-beta` or `msedge-dev`. + +```js +import { defineConfig, devices } from '@playwright/test'; + +export default defineConfig({ + projects: [ + /* Test against branded browsers. */ + { + name: 'Google Chrome', + use: { ...devices['Desktop Chrome'], channel: 'chrome' }, // or 'chrome-beta' + }, + { + name: 'Microsoft Edge', + use: { ...devices['Desktop Edge'], channel: 'msedge' }, // or "msedge-beta" or 'msedge-dev' + }, + ], }); ``` @@ -67,37 +337,39 @@ import com.microsoft.playwright.*; public class Example { public static void main(String[] args) { try (Playwright playwright = Playwright.create()) { - BrowserType chromium = playwright.chromium(); - // Can be "msedge", "chrome-beta", "msedge-beta", "msedge-dev", etc. - Browser browser = chromium.launch(new BrowserType.LaunchOptions().setChannel("chrome")); + // Channel can be "chrome", "msedge", "chrome-beta", "msedge-beta" or "msedge-dev". + Browser browser = playwright.chromium().launch(new BrowserType.LaunchOptions().setChannel("chrome")); + Page page = browser.newPage(); + // ... } } } ``` -```python async -# Can be "msedge", "chrome-beta", "msedge-beta", "msedge-dev", etc. -browser = await playwright.chromium.launch(channel="chrome") +```bash python +pytest test_login.py --browser-channel msedge ``` -```python sync -# Can be "msedge", "chrome-beta", "msedge-beta", "msedge-dev", etc. -browser = playwright.chromium.launch(channel="chrome") +```xml csharp + + + + chromium + + msedge + + + ``` ```csharp -using Microsoft.Playwright; - -using var playwright = await Playwright.CreateAsync(); -var chromium = playwright.Chromium; -// Can be "msedge", "chrome-beta", "msedge-beta", "msedge-dev", etc. -var browser = await chromium.LaunchAsync(new BrowserTypeLaunchOptions { Channel = "chrome" }); +dotnet test -- Playwright.BrowserName=chromium Playwright.LaunchOptions.Channel=msedge ``` -### Installing Google Chrome & Microsoft Edge +#### Installing Google Chrome & Microsoft Edge -If stock Google Chrome or Microsoft Edge is not available on your machine, you can install -them using Playwright command line tool: +If Google Chrome or Microsoft Edge is not available on your machine, you can install +them using the Playwright command line tool: ```bash lang=js npx playwright install msedge @@ -115,84 +387,366 @@ pwsh bin/Debug/netX/playwright.ps1 install msedge mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install msedge" ``` -Run with `--help` option to see full list of the browsers that can be installed this way. - :::warning -Google Chrome or Microsoft Edge installations will not be isolated. They will be installed at the -default global location that depends on your operating system. +Google Chrome or Microsoft Edge installations will be installed at the +default global location of your operating system overriding your current browser installation. ::: -### When to use Google Chrome & Microsoft Edge and when not to? +Run with the `--help` option to see a full a list of browsers that can be installed. -**Defaults** +#### When to use Google Chrome & Microsoft Edge and when not to? -Using default Playwright configuration with the latest Chromium is a good idea most of the time. +##### Defaults + +Using the default Playwright configuration with the latest Chromium is a good idea most of the time. Since Playwright is ahead of Stable channels for the browsers, it gives peace of mind that the upcoming Google Chrome or Microsoft Edge releases won't break your site. You catch breakage early and have a lot of time to fix it before the official Chrome update. -**Regression testing** +##### Regression testing Having said that, testing policies often require regression testing to be performed against the current publicly available browsers. In this case, you can opt into one of the stable channels, `"chrome"` or `"msedge"`. -**Media codecs** +##### Media codecs Another reason for testing using official binaries is to test functionality related to media codecs. Chromium does not have all the codecs that Google Chrome or Microsoft Edge are bundling due to various licensing considerations and agreements. If your site relies on this kind of codecs (which is -rarely the case), you also want to use official channel. +rarely the case), you will also want to use the official channel. -**Enterprise policy** +##### Enterprise policy -Google Chrome and Microsoft Edge respect enterprise policies, which include limitations to the capabilities, -network proxy, mandatory extensions that stand in the way of testing. So if you are a part of the -organization that uses such policies, it is the easiest to use bundled Chromium for your local testing, -you can still opt into stable channels on the bots that are typically free of such restrictions. +Google Chrome and Microsoft Edge respect enterprise policies, which include limitations to the capabilities, network proxy, mandatory extensions that stand in the way of testing. So if you are part of the organization that uses such policies, it is easiest to use bundled Chromium for your local testing, you can still opt into stable channels on the bots that are typically free of such restrictions. -## Installing browsers -* langs: csharp +### Firefox -To invoke Playwright CLI commands, you need to invoke a PowerShell script: +Playwright's Firefox version matches the recent [Firefox Stable](https://www.mozilla.org/en-US/firefox/new/) build. Playwright doesn't work with the branded version of Firefox since it relies on patches. Instead you can test against the recent Firefox Stable build. +### WebKit -```bash -pwsh bin/Debug/netX/playwright.ps1 --help +Playwright's WebKit version matches the recent WebKit trunk build, before it is used in Apple Safari and other WebKit-based browsers. This gives a lot of lead time to react on the potential browser update issues. Playwright doesn't work with the branded version of Safari since it relies on patches. Instead you can test against the recent Webkit build. + +## Install behind a firewall or a proxy + +By default, Playwright downloads browsers from Microsoft's CDN. + +Sometimes companies maintain an internal proxy that blocks direct access to the public +resources. In this case, Playwright can be configured to download browsers via a proxy server. + +```bash tab=bash-bash lang=js +# For Playwright Test +HTTPS_PROXY=https://192.0.2.1 npx playwright install + +# For Playwright Library +HTTPS_PROXY=https://192.0.2.1 npm install playwright ``` -Playwright can install supported browsers by means of the CLI tool. +```batch tab=bash-batch lang=js +# For Playwright Test +set HTTPS_PROXY=https://192.0.2.1 +npx playwright install -```bash csharp -# Running without arguments will install all browsers +# For Playwright Library +set HTTPS_PROXY=https://192.0.2.1 +npm install playwright +``` + +```powershell tab=bash-powershell lang=js +# For Playwright Test +$env:HTTPS_PROXY="https://192.0.2.1" +npx playwright install + +# For Playwright Library +$env:HTTPS_PROXY="https://192.0.2.1" +npm install playwright +``` + +```bash tab=bash-bash lang=python +pip install playwright +HTTPS_PROXY=https://192.0.2.1 playwright install +``` + +```batch tab=bash-batch lang=python +set HTTPS_PROXY=https://192.0.2.1 +pip install playwright +playwright install +``` + +```powershell tab=bash-powershell lang=python +$env:HTTPS_PROXY="https://192.0.2.1" +pip install playwright +playwright install +``` + +```bash tab=bash-bash lang=java +HTTPS_PROXY=https://192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```batch tab=bash-batch lang=java +set HTTPS_PROXY=https://192.0.2.1 +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```powershell tab=bash-powershell lang=java +$env:HTTPS_PROXY="https://192.0.2.1" +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```bash tab=bash-bash lang=csharp +HTTPS_PROXY=https://192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install +``` + +```batch tab=bash-batch lang=csharp +set HTTPS_PROXY=https://192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install ``` -You can also install specific browsers by providing an argument: - -```bash csharp -# Install WebKit -pwsh bin/Debug/netX/playwright.ps1 install webkit +```powershell tab=bash-powershell lang=csharp +$env:HTTPS_PROXY="https://192.0.2.1" +pwsh bin/Debug/netX/playwright.ps1 install ``` -See all supported browsers: +If the requests of the proxy get intercepted with a custom untrusted certificate authority (CA) and it yields to `Error: self signed certificate in certificate chain` while downloading the browsers, you must set your custom root certificates via the [`NODE_EXTRA_CA_CERTS`](https://nodejs.org/api/cli.html#node_extra_ca_certsfile) environment variable before installing the browsers: -```bash csharp -pwsh bin/Debug/netX/playwright.ps1 install --help +```bash tab=bash-bash +export NODE_EXTRA_CA_CERTS="/path/to/cert.pem" ``` -## Install browsers via API -* langs: csharp - -It's possible to run [Command line tools](./cli.md) commands via the .NET API: - -```csharp -var exitCode = Microsoft.Playwright.Program.Main(new[] {"install"}); -if (exitCode != 0) -{ - throw new Exception($"Playwright exited with code {exitCode}"); -} +```batch tab=bash-batch +set NODE_EXTRA_CA_CERTS="C:\certs\root.crt" ``` +```powershell tab=bash-powershell +$env:NODE_EXTRA_CA_CERTS="C:\certs\root.crt" +``` + +If your network is slow to connect to Playwright browser archive, you can increase the connection timeout in milliseconds with `PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT` environment variable: + +```bash tab=bash-bash lang=js +PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 npx playwright install +``` + +```batch tab=bash-batch lang=js +set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 +npx playwright install +``` + +```powershell tab=bash-powershell lang=js +$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" +npx playwright install +``` + +```bash tab=bash-bash lang=python +pip install playwright +PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 playwright install +``` + +```batch tab=bash-batch lang=python +set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 +pip install playwright +playwright install +``` + +```powershell tab=bash-powershell lang=python +$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" +pip install playwright +playwright install +``` + +```bash tab=bash-bash lang=java +PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```batch tab=bash-batch lang=java +set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```powershell tab=bash-powershell lang=java +$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```bash tab=bash-bash lang=csharp +PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 pwsh bin/Debug/netX/playwright.ps1 install +``` + +```batch tab=bash-batch lang=csharp +set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 +pwsh bin/Debug/netX/playwright.ps1 install +``` + +```powershell tab=bash-powershell lang=csharp +$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" +pwsh bin/Debug/netX/playwright.ps1 install +``` +## Download from artifact repository + +By default, Playwright downloads browsers from Microsoft's CDN. + +Sometimes companies maintain an internal artifact repository to host browser +binaries. In this case, Playwright can be configured to download from a custom +location using the `PLAYWRIGHT_DOWNLOAD_HOST` env variable. + +```bash tab=bash-bash lang=js +# For Playwright Test +PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install + +# For Playwright Library +PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install playwright +``` + +```batch tab=bash-batch lang=js +# For Playwright Test +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +npx playwright install + +# For Playwright Library +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +npm install playwright +``` + +```powershell tab=bash-powershell lang=js +# For Playwright Test +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +npx playwright install + +# For Playwright Library +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +npm install playwright +``` + +```bash tab=bash-bash lang=python +pip install playwright +PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 playwright install +``` + +```batch tab=bash-batch lang=python +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +pip install playwright +playwright install +``` + +```powershell tab=bash-powershell lang=python +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +pip install playwright +playwright install +``` + +```bash tab=bash-bash lang=java +PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```batch tab=bash-batch lang=java +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```powershell tab=bash-powershell lang=java +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```bash tab=bash-bash lang=csharp +PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install +``` + +```batch tab=bash-batch lang=csharp +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +pwsh bin/Debug/netX/playwright.ps1 install +``` + +```powershell tab=bash-powershell lang=csharp +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +pwsh bin/Debug/netX/playwright.ps1 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 +take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`. + +```bash tab=bash-bash lang=js +# For Playwright Test +PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install + +# For Playwright Library +PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install playwright +``` + +```batch tab=bash-batch lang=js +# For Playwright Test +set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +npx playwright install + +# For Playwright Library +set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +npm install playwright +``` + +```powershell tab=bash-powershell lang=js +# For Playwright Test +$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +npx playwright install + +# For Playwright Library +$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +npm install playwright +``` + +```bash tab=bash-bash lang=python +pip install playwright +PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 playwright install +``` + +```batch tab=bash-batch lang=python +set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +pip install playwright +playwright install +``` + +```powershell tab=bash-powershell lang=python +$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +pip install playwright +playwright install +``` + +```bash tab=bash-bash lang=java +PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```batch tab=bash-batch lang=java +set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```powershell tab=bash-powershell lang=java +$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" +``` + +```bash tab=bash-bash lang=csharp +PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install +``` + +```batch tab=bash-batch lang=csharp +set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 +set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 +pwsh bin/Debug/netX/playwright.ps1 install +``` + +```powershell tab=bash-powershell lang=csharp +$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" +$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" +pwsh bin/Debug/netX/playwright.ps1 install +``` ## Managing browser binaries Playwright downloads Chromium, WebKit and Firefox browsers into the OS-specific cache folders: @@ -365,335 +919,27 @@ npx playwright install `PLAYWRIGHT_BROWSERS_PATH` does not change installation path for Google Chrome and Microsoft Edge. ::: -## Install behind a firewall or a proxy - -By default, Playwright downloads browsers from Microsoft CDN. - -Sometimes companies maintain an internal proxy that blocks direct access to the public -resources. In this case, Playwright can be configured to download browsers via a proxy server. - -```bash tab=bash-bash lang=js -# For Playwright Test -HTTPS_PROXY=https://192.0.2.1 npx playwright install - -# For Playwright Library -HTTPS_PROXY=https://192.0.2.1 npm install playwright -``` - -```batch tab=bash-batch lang=js -# For Playwright Test -set HTTPS_PROXY=https://192.0.2.1 -npx playwright install - -# For Playwright Library -set HTTPS_PROXY=https://192.0.2.1 -npm install playwright -``` - -```powershell tab=bash-powershell lang=js -# For Playwright Test -$env:HTTPS_PROXY="https://192.0.2.1" -npx playwright install - -# For Playwright Library -$env:HTTPS_PROXY="https://192.0.2.1" -npm install playwright -``` - -```bash tab=bash-bash lang=python -pip install playwright -HTTPS_PROXY=https://192.0.2.1 playwright install -``` - -```batch tab=bash-batch lang=python -set HTTPS_PROXY=https://192.0.2.1 -pip install playwright -playwright install -``` - -```powershell tab=bash-powershell lang=python -$env:HTTPS_PROXY="https://192.0.2.1" -pip install playwright -playwright install -``` - -```bash tab=bash-bash lang=java -HTTPS_PROXY=https://192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```batch tab=bash-batch lang=java -set HTTPS_PROXY=https://192.0.2.1 -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```powershell tab=bash-powershell lang=java -$env:HTTPS_PROXY="https://192.0.2.1" -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```bash tab=bash-bash lang=csharp -HTTPS_PROXY=https://192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install -``` - -```batch tab=bash-batch lang=csharp -set HTTPS_PROXY=https://192.0.2.1 -pwsh bin/Debug/netX/playwright.ps1 install -``` - -```powershell tab=bash-powershell lang=csharp -$env:HTTPS_PROXY="https://192.0.2.1" -pwsh bin/Debug/netX/playwright.ps1 install -``` - -If the requests of the proxy get intercepted with a custom untrusted certificate authority (CA) and it yields to `Error: self signed certificate in certificate chain` while downloading the browsers, you must set your custom root certificates via the [`NODE_EXTRA_CA_CERTS`](https://nodejs.org/api/cli.html#node_extra_ca_certsfile) environment variable before installing the browsers: - -```bash tab=bash-bash -export NODE_EXTRA_CA_CERTS="/path/to/cert.pem" -``` - -```batch tab=bash-batch -set NODE_EXTRA_CA_CERTS="C:\certs\root.crt" -``` - -```powershell tab=bash-powershell -$env:NODE_EXTRA_CA_CERTS="C:\certs\root.crt" -``` - -If your network is slow to connect to Playwright browser archive, you can increase the connection timeout in milliseconds with `PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT` environment variable: - -```bash tab=bash-bash lang=js -PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 npx playwright install -``` - -```batch tab=bash-batch lang=js -set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 -npx playwright install -``` - -```powershell tab=bash-powershell lang=js -$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" -npx playwright install -``` - -```bash tab=bash-bash lang=python -pip install playwright -PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 playwright install -``` - -```batch tab=bash-batch lang=python -set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 -pip install playwright -playwright install -``` - -```powershell tab=bash-powershell lang=python -$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" -pip install playwright -playwright install -``` - -```bash tab=bash-bash lang=java -PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```batch tab=bash-batch lang=java -set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```powershell tab=bash-powershell lang=java -$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```bash tab=bash-bash lang=csharp -PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 pwsh bin/Debug/netX/playwright.ps1 install -``` - -```batch tab=bash-batch lang=csharp -set PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT=120000 -pwsh bin/Debug/netX/playwright.ps1 install -``` - -```powershell tab=bash-powershell lang=csharp -$env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" -pwsh bin/Debug/netX/playwright.ps1 install -``` - -## Download from artifact repository - -By default, Playwright downloads browsers from Microsoft CDN. - -Sometimes companies maintain an internal artifact repository to host browser -binaries. In this case, Playwright can be configured to download from a custom -location using the `PLAYWRIGHT_DOWNLOAD_HOST` env variable. - -```bash tab=bash-bash lang=js -# For Playwright Test -PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install - -# For Playwright Library -PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install playwright -``` - -```batch tab=bash-batch lang=js -# For Playwright Test -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -npx playwright install - -# For Playwright Library -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -npm install playwright -``` - -```powershell tab=bash-powershell lang=js -# For Playwright Test -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -npx playwright install - -# For Playwright Library -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -npm install playwright -``` - -```bash tab=bash-bash lang=python -pip install playwright -PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 playwright install -``` - -```batch tab=bash-batch lang=python -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -pip install playwright -playwright install -``` - -```powershell tab=bash-powershell lang=python -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -pip install playwright -playwright install -``` - -```bash tab=bash-bash lang=java -PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```batch tab=bash-batch lang=java -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```powershell tab=bash-powershell lang=java -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```bash tab=bash-bash lang=csharp -PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install -``` - -```batch tab=bash-batch lang=csharp -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -pwsh bin/Debug/netX/playwright.ps1 install -``` - -```powershell tab=bash-powershell lang=csharp -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -pwsh bin/Debug/netX/playwright.ps1 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 -take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`. - -```bash tab=bash-bash lang=js -# For Playwright Test -PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install - -# For Playwright Library -PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install playwright -``` - -```batch tab=bash-batch lang=js -# For Playwright Test -set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -npx playwright install - -# For Playwright Library -set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -npm install playwright -``` - -```powershell tab=bash-powershell lang=js -# For Playwright Test -$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -npx playwright install - -# For Playwright Library -$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -npm install playwright -``` - -```bash tab=bash-bash lang=python -pip install playwright -PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 playwright install -``` - -```batch tab=bash-batch lang=python -set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -pip install playwright -playwright install -``` - -```powershell tab=bash-powershell lang=python -$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -pip install playwright -playwright install -``` - -```bash tab=bash-bash lang=java -PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```batch tab=bash-batch lang=java -set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```powershell tab=bash-powershell lang=java -$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install" -``` - -```bash tab=bash-bash lang=csharp -PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 pwsh bin/Debug/netX/playwright.ps1 install -``` - -```batch tab=bash-batch lang=csharp -set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 -set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 -pwsh bin/Debug/netX/playwright.ps1 install -``` - -```powershell tab=bash-powershell lang=csharp -$env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" -$env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" -pwsh bin/Debug/netX/playwright.ps1 install -``` - -## Skip browser downloads +### Skip browser downloads In certain cases, it is desired to avoid browser downloads altogether because browser binaries are managed separately. This can be done by setting `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` variable before installation. +```bash tab=bash-bash lang=js +PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npx playwright install +``` + +```batch tab=bash-batch lang=js +set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 +npx playwright install +``` + +```powershell tab=bash-powershell lang=js +$env:PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 +npx playwright install +``` + ```bash tab=bash-bash lang=python pip install playwright PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 python -m playwright install @@ -739,20 +985,8 @@ $env:PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 pwsh bin/Debug/netX/playwright.ps1 install ``` -## Download single browser binary -* langs: python +### Stale browser removal -Playwright downloads Chromium, Firefox and WebKit browsers by default. To install a specific browser, pass it as an argument during installation. - -```bash -pip install playwright -playwright install firefox -``` - -## Stale browser removal - -Playwright keeps track of the clients that use its browsers. When there are no more clients that require particular -version of the browser, that version is deleted from the system. That way you can safely use Playwright instances of -different versions and at the same time, you don't waste disk space for the browsers that are no longer in use. +Playwright keeps track of the clients that use its browsers. When there are no more clients that require a particular version of the browser, that version is deleted from the system. That way you can safely use Playwright instances of different versions and at the same time, you don't waste disk space for the browsers that are no longer in use. To opt-out from the unused browser removal, you can set the `PLAYWRIGHT_SKIP_BROWSER_GC=1` environment variable.