yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: unfork installation docs (#5661)

Browse Source
This commit is contained in:
Pavel Feldman 2021-03-01 15:10:47 -08:00 committed by GitHub
parent cad763491e
commit cd2e976c98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 157 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
docs/src/installation-java.md
View File

@ -1,83 +0,0 @@
---
id: installation
title: "Installation"
---
<!-- TOC -->
## 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:
- `%USERPROFILE%\AppData\Local\ms-playwright` on Windows
- `~/Library/Caches/ms-playwright` on MacOS
- `~/.cache/ms-playwright` on Linux
Every time `Playwright.create()` is called it will check if the browsers are in the local cache and if not download them.
These browsers will take few hundreds of megabytes of the disk space when installed:
```sh
$ du -hs ./Library/Caches/ms-playwright/*
281M chromium-XXXXXX
187M firefox-XXXX
180M webkit-XXXX
```
You can override default behavior using environment variables. When running Playwright scripts, ask it to search for browsers in a shared location:
```sh
# Linux/macOS
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers mvn test
# Windows
$ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ mvn test
```
Playwright keeps track of packages that need those browsers and will garbage collect them as you update Playwright to the newer versions.
:::note
Developers can opt-in in this mode via exporting `PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers` in their `.bashrc`.
:::
## Download from artifact repository
By default, Playwright downloads browsers from Microsoft and Google public CDNs.
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.
```sh
# Linux/macOS
$ PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 mvn test
# Windows
$ set PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78
$ mvn test
```
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`.
```sh
# Linux/macOS
$ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=192.168.1.1 PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 mvn test
```
## 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.
```sh
# Linux/macOS
$ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 mvn test
# Windows
$ set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
$ mvn test
```

126
docs/src/installation-python.md
View File

@ -1,126 +0,0 @@
---
id: installation
title: "Installation"
---
<!-- TOC -->
## 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:
- `%USERPROFILE%\AppData\Local\ms-playwright` on Windows
- `~/Library/Caches/ms-playwright` on MacOS
- `~/.cache/ms-playwright` on Linux
```sh
$ pip install playwright
$ playwright install
```
These browsers will take few hundreds of megabytes of the disk space when installed:
```sh
$ du -hs ./Library/Caches/ms-playwright/*
281M chromium-XXXXXX
187M firefox-XXXX
180M webkit-XXXX
```
You can override default behavior using environment variables. When installing Playwright, ask it to download browsers into a specific location:
```sh
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers python -m playwright install
# Windows
$ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ pip install playwright
$ playwright install
```
When running Playwright scripts, ask it to search for browsers in a shared location:
```sh
# Linux/macOS
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers python playwright_script.js
# Windows
$ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ python playwright_script.py
```
Or you can opt into the hermetic install and place binaries under the `site-packages/playwright` folder:
```sh
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_BROWSERS_PATH=0 python -m playwright install
# Windows
$ set PLAYWRIGHT_BROWSERS_PATH=0
$ pip install playwright
$ playwright install
```
Playwright keeps track of packages that need those browsers and will garbage collect them as you update Playwright to the newer versions.
:::note
Developers can opt-in in this mode via exporting `PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers` in their `.bashrc`.
:::
## Download from artifact repository
By default, Playwright downloads browsers from Microsoft and Google public CDNs.
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.
```sh
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 python -m playwright install
# Windows
$ set PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78
$ pip install playwright
$ 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
take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`.
```sh
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=192.168.1.1 PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 python -m playwright install
```
## 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.
```sh
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 python -m playwright install
# Windows
$ set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
$ pip install playwright
$ playwright install
```
## Download single browser binary
Playwright downloads Chromium, Firefox and WebKit browsers by default. To install a specific browser, pass it as an argument during installation.
```sh
$ pip install playwright
$ playwright install firefox
```

167
docs/src/installation-js.md → docs/src/installation.md
View File

@ -13,10 +13,15 @@ Each version of Playwright needs specific versions of browser binaries to operat
- `~/Library/Caches/ms-playwright` on MacOS - `~/Library/Caches/ms-playwright` on MacOS
- `~/.cache/ms-playwright` on Linux - `~/.cache/ms-playwright` on Linux
```sh ```sh js
$ npm i -D playwright $ npm i -D playwright
``` ```
```sh python
$ pip install playwright
$ playwright install
```
These browsers will take few hundreds of megabytes of the disk space when installed: These browsers will take few hundreds of megabytes of the disk space when installed:
```sh ```sh
@ -28,7 +33,7 @@ $ du -hs ./Library/Caches/ms-playwright/*
You can override default behavior using environment variables. When installing Playwright, ask it to download browsers into a specific location: You can override default behavior using environment variables. When installing Playwright, ask it to download browsers into a specific location:
```sh ```sh js
# Linux/macOS # Linux/macOS
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers npm i -D playwright $ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers npm i -D playwright
@ -37,9 +42,25 @@ $ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ npm i -D playwright $ npm i -D playwright
``` ```
When running Playwright scripts, ask it to search for browsers in a shared location: ```sh python
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers python -m playwright install
```sh # Windows
$ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ pip install playwright
$ playwright install
```
```sh java
# Linux/macOS
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers mvn test
```
When running Playwright scripts, ask it to search for browsers in a shared location.
```sh js
# Linux/macOS # Linux/macOS
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers node playwright-script.js $ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers node playwright-script.js
@ -48,9 +69,24 @@ $ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ node playwright-script.js $ node playwright-script.js
``` ```
Or you can opt into the hermetic install and place binaries under the `node_modules/` folder: ```sh python
# Linux/macOS
$ PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers python playwright_script.js
```sh # Windows
$ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ python playwright_script.py
```
```sh java
# Windows
$ set PLAYWRIGHT_BROWSERS_PATH=%USERPROFILE%\pw-browsers
$ mvn test
```
Or you can opt into the hermetic install and place binaries in the local folder:
```sh js
# Linux/macOS # Linux/macOS
# Places binaries to node_modules/playwright # Places binaries to node_modules/playwright
$ PLAYWRIGHT_BROWSERS_PATH=0 npm i -D playwright $ PLAYWRIGHT_BROWSERS_PATH=0 npm i -D playwright
@ -61,21 +97,68 @@ $ set PLAYWRIGHT_BROWSERS_PATH=0
$ npm i -D playwright $ npm i -D playwright
``` ```
```sh python
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_BROWSERS_PATH=0 playwright install
# Windows
$ set PLAYWRIGHT_BROWSERS_PATH=0
$ pip install playwright
$ playwright install
```
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
Developers can opt-in in this mode via exporting `PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers` in their `.bashrc`. Developers can opt-in in this mode via exporting `PLAYWRIGHT_BROWSERS_PATH=$HOME/pw-browsers` in their `.bashrc`.
::: :::
## Install behind the firewall or 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.
```sh js
# Linux/macOS
$ HTTPS_PROXY=https://192.168.1.78 npm i -D playwright
# Windows
$ set HTTPS_PROXY=https://192.168.1.78
$ npm i -D playwright
```
```sh python
# Linux/macOS
$ pip install playwright
$ HTTPS_PROXY=https://192.168.1.78 playwright install
# Windows
$ set HTTPS_PROXY=https://192.168.1.78
$ pip install playwright
$ playwright install
```
```sh java
# Linux/macOS
$ HTTPS_PROXY=https://192.168.1.78 mvn test
# Windows
$ set HTTPS_PROXY=https://192.168.1.78
$ mvn test
```
## Download from artifact repository ## Download from artifact repository
By default, Playwright downloads browsers from Microsoft and Google public CDNs. By default, Playwright downloads browsers from Microsoft CDN.
Sometimes companies maintain an internal artifact repository to host browser Sometimes companies maintain an internal artifact repository to host browser
binaries. In this case, Playwright can be configured to download from a custom binaries. In this case, Playwright can be configured to download from a custom
location using the `PLAYWRIGHT_DOWNLOAD_HOST` env variable. location using the `PLAYWRIGHT_DOWNLOAD_HOST` env variable.
```sh ```sh js
# Linux/macOS # Linux/macOS
$ PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 npm i -D playwright $ PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 npm i -D playwright
@ -84,14 +167,47 @@ $ set PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78
$ npm i -D playwright $ npm i -D playwright
``` ```
```sh python
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 playwright install
# Windows
$ set PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78
$ pip install playwright
$ playwright install
```
```sh java
# Linux/macOS
$ PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 mvn test
# Windows
$ set PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78
$ mvn test
```
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`.
```sh 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`.
```sh js
# Linux/macOS # Linux/macOS
$ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=192.168.1.1 PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 npm i -D playwright $ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=192.168.1.1 PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 npm i -D playwright
``` ```
```sh python
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=192.168.1.1 PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 python -m playwright install
```
```sh java
# Linux/macOS
$ PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=192.168.1.1 PLAYWRIGHT_DOWNLOAD_HOST=192.168.1.78 mvn test
```
## 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
@ -99,7 +215,7 @@ browser binaries are managed separately.
This can be done by setting `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` variable before installation. This can be done by setting `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` variable before installation.
```sh ```sh js
# Linux/macOS # Linux/macOS
$ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright $ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
@ -108,7 +224,28 @@ $ set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
$ npm i -D playwright $ npm i -D playwright
``` ```
```sh python
# Linux/macOS
$ pip install playwright
$ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 python -m playwright install
# Windows
$ set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
$ pip install playwright
$ playwright install
```
```sh java
# Linux/macOS
$ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 mvn test
# Windows
$ set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
$ mvn test
```
## Download single browser binary ## Download single browser binary
* langs: js
Playwright ships three packages that bundle only a single browser: Playwright ships three packages that bundle only a single browser:
- [`playwright-chromium`](https://www.npmjs.com/package/playwright-chromium) - [`playwright-chromium`](https://www.npmjs.com/package/playwright-chromium)
@ -138,3 +275,13 @@ const { webkit } = require('playwright-webkit');
// ... // ...
})(); })();
``` ```
## Download single browser binary
* langs: python
Playwright downloads Chromium, Firefox and WebKit browsers by default. To install a specific browser, pass it as an argument during installation.
```sh
$ pip install playwright
$ playwright install firefox
```