mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
docs: update faq (#11441)
This commit is contained in:
parent
4676abaac5
commit
54b0bcbc46
@ -45,7 +45,7 @@ export const docsChromiumSupportTask = task({
|
|||||||
}
|
}
|
||||||
if (semver.gte(puppeteerVersion, '20.0.0')) {
|
if (semver.gte(puppeteerVersion, '20.0.0')) {
|
||||||
buffer.push(
|
buffer.push(
|
||||||
` * [Chrome for Testing](https://goo.gle/chrome-for-testing) ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](${getApiUrl(
|
` * [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) ${chromiumVersion} - [Puppeteer ${puppeteerVersion}](${getApiUrl(
|
||||||
puppeteerVersion
|
puppeteerVersion
|
||||||
)})`
|
)})`
|
||||||
);
|
);
|
||||||
|
@ -46,7 +46,7 @@ pnpm i puppeteer
|
|||||||
```
|
```
|
||||||
|
|
||||||
When you install Puppeteer, it automatically downloads a recent version of
|
When you install Puppeteer, it automatically downloads a recent version of
|
||||||
[Chrome for Testing](https://goo.gle/chrome-for-testing) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
|
[Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
|
||||||
work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
|
work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
|
||||||
with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
|
with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
|
||||||
by default (starting with Puppeteer v19.0.0).
|
by default (starting with Puppeteer v19.0.0).
|
||||||
|
@ -28,7 +28,7 @@ Promise<[Browser](./puppeteer.browser.md)>
|
|||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
|
||||||
Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chrome for Testing downloaded by default. There is no guarantee it will work with any other version. If Google Chrome (rather than Chrome for Testing) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users. See [this doc](https://goo.gle/chrome-for-testing) for the description of Chrome for Testing.
|
Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chrome for Testing downloaded by default. There is no guarantee it will work with any other version. If Google Chrome (rather than Chrome for Testing) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users. See [this doc](https://developer.chrome.com/blog/chrome-for-testing/) for the description of Chrome for Testing.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
|
@ -4,19 +4,19 @@ The following versions of Chromium are supported, mapped to Puppeteer version:
|
|||||||
|
|
||||||
<!-- version-start -->
|
<!-- version-start -->
|
||||||
|
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 119.0.6045.105 - [Puppeteer v21.5.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.5.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 119.0.6045.105 - [Puppeteer v21.5.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.5.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 118.0.5993.70 - [Puppeteer v21.4.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.4.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 118.0.5993.70 - [Puppeteer v21.4.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.4.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 117.0.5938.149 - [Puppeteer v21.3.7](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.7/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 117.0.5938.149 - [Puppeteer v21.3.7](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.7/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 117.0.5938.92 - [Puppeteer v21.3.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.2/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 117.0.5938.92 - [Puppeteer v21.3.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.2/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 117.0.5938.62 - [Puppeteer v21.3.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 117.0.5938.62 - [Puppeteer v21.3.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 116.0.5845.96 - [Puppeteer v21.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.1.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 116.0.5845.96 - [Puppeteer v21.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.1.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 115.0.5790.170 - [Puppeteer v21.0.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.2/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 115.0.5790.170 - [Puppeteer v21.0.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.2/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 115.0.5790.102 - [Puppeteer v21.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 115.0.5790.102 - [Puppeteer v21.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 115.0.5790.98 - [Puppeteer v20.9.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.9.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 115.0.5790.98 - [Puppeteer v20.9.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.9.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 114.0.5735.133 - [Puppeteer v20.7.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.7.2/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 114.0.5735.133 - [Puppeteer v20.7.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.7.2/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 114.0.5735.90 - [Puppeteer v20.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.6.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 114.0.5735.90 - [Puppeteer v20.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.6.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 113.0.5672.63 - [Puppeteer v20.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.1.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 113.0.5672.63 - [Puppeteer v20.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.1.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 112.0.5615.121 - [Puppeteer v20.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.0.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 112.0.5615.121 - [Puppeteer v20.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.0.0/docs/api/index.md)
|
||||||
- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.8.0/docs/api/index.md)
|
- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.8.0/docs/api/index.md)
|
||||||
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.7.0/docs/api/index.md)
|
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.7.0/docs/api/index.md)
|
||||||
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.6.0/docs/api/index.md)
|
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.6.0/docs/api/index.md)
|
||||||
|
72
docs/faq.md
72
docs/faq.md
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Q: Who maintains Puppeteer?
|
## Q: Who maintains Puppeteer?
|
||||||
|
|
||||||
The Chrome DevTools team maintains the library, but we'd love your help and
|
The Chrome Browser Automation team maintains the library, but we'd love your help and
|
||||||
expertise on the project! See our
|
expertise on the project! See our
|
||||||
[contributing guide](https://pptr.dev/contributing).
|
[contributing guide](https://pptr.dev/contributing).
|
||||||
|
|
||||||
@ -31,12 +31,11 @@ non-standard DevTools Protocol used by Chrome).
|
|||||||
|
|
||||||
The goals of the project are:
|
The goals of the project are:
|
||||||
|
|
||||||
- Provide a slim, canonical library that highlights the capabilities of the
|
- Provide a reference implementation that highlights the capabilities of the
|
||||||
[DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
|
[Chrome DevTools](https://chromedevtools.github.io/devtools-protocol/)
|
||||||
- Provide a reference implementation for similar testing libraries. Eventually,
|
and [WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) protocols.
|
||||||
these other frameworks could adopt Puppeteer as their foundational layer.
|
- Grow the adoption of automated cross-browser testing.
|
||||||
- Grow the adoption of headless/automated browser testing.
|
- Help dogfood new DevTools Protocol and WebDriver BiDi features...and catch bugs!
|
||||||
- Help dogfood new DevTools Protocol features...and catch bugs!
|
|
||||||
- Learn more about the pain points of automated browser testing and help fill
|
- Learn more about the pain points of automated browser testing and help fill
|
||||||
those gaps.
|
those gaps.
|
||||||
|
|
||||||
@ -46,36 +45,34 @@ help us drive product decisions:
|
|||||||
|
|
||||||
- **Speed**: Puppeteer has almost zero performance overhead over an automated
|
- **Speed**: Puppeteer has almost zero performance overhead over an automated
|
||||||
page.
|
page.
|
||||||
- **Security**: Puppeteer operates off-process with respect to Chromium, making
|
- **Security**: Puppeteer operates off-process with respect to the browser, making
|
||||||
it safe to automate potentially malicious pages.
|
it safe to automate potentially malicious pages.
|
||||||
- **Stability**: Puppeteer should not be flaky and should not leak memory.
|
- **Stability**: Puppeteer should not be flaky and should not leak memory.
|
||||||
- **Simplicity**: Puppeteer provides a high-level API that’s easy to use,
|
- **Simplicity**: Puppeteer provides a high-level API that’s easy to use,
|
||||||
understand, and debug.
|
understand, and debug.
|
||||||
|
|
||||||
## Q: Is Puppeteer replacing Selenium/WebDriver?
|
## Q: Is Puppeteer a replacement for Selenium WebDriver?
|
||||||
|
|
||||||
**No**. Both projects are valuable for very different reasons:
|
**No**. Both projects are valuable for very different reasons:
|
||||||
|
|
||||||
- Selenium/WebDriver focuses on cross-browser automation; its value proposition
|
- Selenium WebDriver focuses on cross-browser automation and provides bindings for
|
||||||
is a single standard API that works across all major browsers.
|
multiple languages; Puppeteer is only for JavaScript.
|
||||||
- Puppeteer focuses on Chromium; its value proposition is richer functionality
|
- Puppeteer focuses on Chromium; its value proposition is richer functionality
|
||||||
and higher reliability.
|
for Chromium-based browsers.
|
||||||
|
|
||||||
That said, you **can** use Puppeteer to run tests against Chromium, e.g. using
|
That said, you **can** use Puppeteer to run tests against Chromium, e.g. using
|
||||||
the community-driven
|
the community-driven
|
||||||
[jest-puppeteer](https://github.com/smooth-code/jest-puppeteer). While this
|
[jest-puppeteer](https://github.com/smooth-code/jest-puppeteer) or
|
||||||
|
[Puppeteer's Angular integration](https://pptr.dev/integrations/ng-schematics). While this
|
||||||
probably shouldn’t be your only testing solution, it does have a few good points
|
probably shouldn’t be your only testing solution, it does have a few good points
|
||||||
compared to WebDriver:
|
compared to WebDriver classic:
|
||||||
|
|
||||||
- Puppeteer requires zero setup and comes bundled with the Chromium version it
|
- Puppeteer requires zero setup and comes bundled with the Chrome version it
|
||||||
works best with, making it
|
works best with, making it
|
||||||
[very easy to start with](https://github.com/puppeteer/puppeteer/#getting-started).
|
[very easy to start with](https://github.com/puppeteer/puppeteer/#getting-started).
|
||||||
At the end of the day, it’s better to have a few tests running chromium-only,
|
|
||||||
than no tests at all.
|
|
||||||
- Puppeteer has event-driven architecture, which removes a lot of potential
|
- Puppeteer has event-driven architecture, which removes a lot of potential
|
||||||
flakiness. There’s no need for evil “sleep(1000)” calls in puppeteer scripts.
|
flakiness. There’s no need for “sleep(1000)” calls in puppeteer scripts.
|
||||||
- Puppeteer runs headless by default, which makes it fast to run. Puppeteer
|
- Puppeteer exposes browser contexts, making it possible to efficiently
|
||||||
v1.5.0 also exposes browser contexts, making it possible to efficiently
|
|
||||||
parallelize test execution.
|
parallelize test execution.
|
||||||
- Puppeteer shines when it comes to debugging: flip the “headless” bit to false,
|
- Puppeteer shines when it comes to debugging: flip the “headless” bit to false,
|
||||||
add “slowMo”, and you’ll see what the browser is doing. You can even open
|
add “slowMo”, and you’ll see what the browser is doing. You can even open
|
||||||
@ -123,7 +120,7 @@ To download Firefox Nightly into an existing Puppeteer project:
|
|||||||
npx puppeteer browsers install firefox
|
npx puppeteer browsers install firefox
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Q: What’s considered a “Navigation”?
|
## Q: What’s considered a “Navigation”?
|
||||||
|
|
||||||
From Puppeteer’s standpoint, **“navigation” is anything that changes a page’s
|
From Puppeteer’s standpoint, **“navigation” is anything that changes a page’s
|
||||||
URL**. Aside from regular navigation where the browser hits the network to fetch
|
URL**. Aside from regular navigation where the browser hits the network to fetch
|
||||||
@ -135,7 +132,7 @@ usage.
|
|||||||
With this definition of “navigation,” **Puppeteer works seamlessly with
|
With this definition of “navigation,” **Puppeteer works seamlessly with
|
||||||
single-page applications.**
|
single-page applications.**
|
||||||
|
|
||||||
#### Q: What’s the difference between a “trusted" and "untrusted" input event?
|
## Q: What’s the difference between a “trusted" and "untrusted" input event?
|
||||||
|
|
||||||
In browsers, input events could be divided into two big groups: trusted vs.
|
In browsers, input events could be divided into two big groups: trusted vs.
|
||||||
untrusted.
|
untrusted.
|
||||||
@ -165,38 +162,23 @@ await page.evaluate(() => {
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Q: What features does Puppeteer not support?
|
## Q: Does Puppeteer support media and audio playback?
|
||||||
|
|
||||||
You may find that Puppeteer does not behave as expected when controlling pages
|
Puppeteer uses [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) binaries
|
||||||
that incorporate audio and video. (For example,
|
by default which ship with properietary codecs support starting from
|
||||||
[video playback/screenshots is likely to fail](https://github.com/puppeteer/puppeteer/issues/291).)
|
[M120](https://chromiumdash.appspot.com/commit/12d607016c31ea13579e897740c765be189ed6eb).
|
||||||
There are two reasons for this:
|
|
||||||
|
|
||||||
- Puppeteer is bundled with [Chrome for Testing](https://goo.gle/chrome-for-testing) — not the regular Chrome — and so by default, it
|
## Q: I am having trouble installing / running Puppeteer in my test environment. Where should I look for help?
|
||||||
inherits all of
|
|
||||||
[Chromium's media-related limitations](https://www.chromium.org/audio-video).
|
|
||||||
This means that Puppeteer does not support licensed formats such as AAC or
|
|
||||||
H.264. (However, it is possible to force Puppeteer to use a
|
|
||||||
separately-installed version Chrome instead of Chromium via the
|
|
||||||
[`executablePath` option to `puppeteer.launch`](./api/puppeteer.launchoptions).
|
|
||||||
You should only use this configuration if you need an official release of
|
|
||||||
Chrome that supports these media formats.)
|
|
||||||
- Since Puppeteer (in all configurations) controls a desktop version of
|
|
||||||
Chromium/Chrome, features that are only supported by the mobile version of
|
|
||||||
Chrome are not supported. This means that Puppeteer
|
|
||||||
[does not support HTTP Live Streaming (HLS)](https://caniuse.com/#feat=http-live-streaming).
|
|
||||||
|
|
||||||
#### Q: I am having trouble installing / running Puppeteer in my test environment. Where should I look for help?
|
|
||||||
|
|
||||||
We have a
|
We have a
|
||||||
[troubleshooting](https://pptr.dev/troubleshooting)
|
[troubleshooting](https://pptr.dev/troubleshooting)
|
||||||
guide for various operating systems that lists the required dependencies.
|
guide for various operating systems that lists the required dependencies.
|
||||||
|
|
||||||
#### Q: I have more questions! Where do I ask?
|
## Q: I have more questions! Where do I ask?
|
||||||
|
|
||||||
There are many ways to get help on Puppeteer:
|
There are many ways to get help on Puppeteer:
|
||||||
|
|
||||||
- [bugtracker](https://github.com/puppeteer/puppeteer/issues)
|
- For questions: [Stack Overflow](https://stackoverflow.com/questions/tagged/puppeteer)
|
||||||
- [Stack Overflow](https://stackoverflow.com/questions/tagged/puppeteer)
|
- For bug reports: [GitHub Issues](https://github.com/puppeteer/puppeteer/issues)
|
||||||
|
|
||||||
Make sure to search these channels before posting your question.
|
Make sure to search these channels before posting your question.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Docker
|
# Docker
|
||||||
|
|
||||||
Puppeteer offers a Docker image that includes [Chrome for Testing](https://goo.gle/chrome-for-testing) along with the required
|
Puppeteer offers a Docker image that includes [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) along with the required
|
||||||
dependencies and a pre-installed Puppeteer version. The image is available via
|
dependencies and a pre-installed Puppeteer version. The image is available via
|
||||||
the
|
the
|
||||||
[GitHub Container Registry](https://github.com/puppeteer/puppeteer/pkgs/container/puppeteer).
|
[GitHub Container Registry](https://github.com/puppeteer/puppeteer/pkgs/container/puppeteer).
|
||||||
|
@ -46,7 +46,7 @@ pnpm i puppeteer
|
|||||||
```
|
```
|
||||||
|
|
||||||
When you install Puppeteer, it automatically downloads a recent version of
|
When you install Puppeteer, it automatically downloads a recent version of
|
||||||
[Chrome for Testing](https://goo.gle/chrome-for-testing) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
|
[Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
|
||||||
work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
|
work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
|
||||||
with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
|
with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
|
||||||
by default (starting with Puppeteer v19.0.0).
|
by default (starting with Puppeteer v19.0.0).
|
||||||
|
@ -172,7 +172,7 @@ export class PuppeteerNode extends Puppeteer {
|
|||||||
* for a description of the differences between Chromium and Chrome.
|
* for a description of the differences between Chromium and Chrome.
|
||||||
* {@link https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md | This article}
|
* {@link https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md | This article}
|
||||||
* describes some differences for Linux users. See
|
* describes some differences for Linux users. See
|
||||||
* {@link https://goo.gle/chrome-for-testing | this doc} for the description
|
* {@link https://developer.chrome.com/blog/chrome-for-testing/ | this doc} for the description
|
||||||
* of Chrome for Testing.
|
* of Chrome for Testing.
|
||||||
*
|
*
|
||||||
* @param options - Options to configure launching behavior.
|
* @param options - Options to configure launching behavior.
|
||||||
|
@ -28,7 +28,7 @@ Promise<[Browser](./puppeteer.browser.md)>
|
|||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
|
||||||
Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chrome for Testing downloaded by default. There is no guarantee it will work with any other version. If Google Chrome (rather than Chrome for Testing) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users. See [this doc](https://goo.gle/chrome-for-testing) for the description of Chrome for Testing.
|
Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chrome for Testing downloaded by default. There is no guarantee it will work with any other version. If Google Chrome (rather than Chrome for Testing) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users. See [this doc](https://developer.chrome.com/blog/chrome-for-testing/) for the description of Chrome for Testing.
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
|
@ -4,19 +4,19 @@ The following versions of Chromium are supported, mapped to Puppeteer version:
|
|||||||
|
|
||||||
<!-- version-start -->
|
<!-- version-start -->
|
||||||
|
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 119.0.6045.105 - [Puppeteer v21.5.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.5.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 119.0.6045.105 - [Puppeteer v21.5.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.5.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 118.0.5993.70 - [Puppeteer v21.4.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.4.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 118.0.5993.70 - [Puppeteer v21.4.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.4.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 117.0.5938.149 - [Puppeteer v21.3.7](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.7/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 117.0.5938.149 - [Puppeteer v21.3.7](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.7/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 117.0.5938.92 - [Puppeteer v21.3.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.2/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 117.0.5938.92 - [Puppeteer v21.3.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.2/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 117.0.5938.62 - [Puppeteer v21.3.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 117.0.5938.62 - [Puppeteer v21.3.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.3.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 116.0.5845.96 - [Puppeteer v21.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.1.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 116.0.5845.96 - [Puppeteer v21.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.1.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 115.0.5790.170 - [Puppeteer v21.0.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.2/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 115.0.5790.170 - [Puppeteer v21.0.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.2/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 115.0.5790.102 - [Puppeteer v21.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 115.0.5790.102 - [Puppeteer v21.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v21.0.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 115.0.5790.98 - [Puppeteer v20.9.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.9.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 115.0.5790.98 - [Puppeteer v20.9.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.9.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 114.0.5735.133 - [Puppeteer v20.7.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.7.2/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 114.0.5735.133 - [Puppeteer v20.7.2](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.7.2/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 114.0.5735.90 - [Puppeteer v20.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.6.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 114.0.5735.90 - [Puppeteer v20.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.6.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 113.0.5672.63 - [Puppeteer v20.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.1.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 113.0.5672.63 - [Puppeteer v20.1.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.1.0/docs/api/index.md)
|
||||||
- [Chrome for Testing](https://goo.gle/chrome-for-testing) 112.0.5615.121 - [Puppeteer v20.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.0.0/docs/api/index.md)
|
- [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) 112.0.5615.121 - [Puppeteer v20.0.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v20.0.0/docs/api/index.md)
|
||||||
- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.8.0/docs/api/index.md)
|
- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.8.0/docs/api/index.md)
|
||||||
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.7.0/docs/api/index.md)
|
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.7.0/docs/api/index.md)
|
||||||
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.6.0/docs/api/index.md)
|
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.6.0/docs/api/index.md)
|
||||||
|
@ -166,7 +166,7 @@ that incorporate audio and video. (For example,
|
|||||||
[video playback/screenshots is likely to fail](https://github.com/puppeteer/puppeteer/issues/291).)
|
[video playback/screenshots is likely to fail](https://github.com/puppeteer/puppeteer/issues/291).)
|
||||||
There are two reasons for this:
|
There are two reasons for this:
|
||||||
|
|
||||||
- Puppeteer is bundled with [Chrome for Testing](https://goo.gle/chrome-for-testing) — not the regular Chrome — and so by default, it
|
- Puppeteer is bundled with [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) — not the regular Chrome — and so by default, it
|
||||||
inherits all of
|
inherits all of
|
||||||
[Chromium's media-related limitations](https://www.chromium.org/audio-video).
|
[Chromium's media-related limitations](https://www.chromium.org/audio-video).
|
||||||
This means that Puppeteer does not support licensed formats such as AAC or
|
This means that Puppeteer does not support licensed formats such as AAC or
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Docker
|
# Docker
|
||||||
|
|
||||||
Puppeteer offers a Docker image that includes [Chrome for Testing](https://goo.gle/chrome-for-testing) along with the required
|
Puppeteer offers a Docker image that includes [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) along with the required
|
||||||
dependencies and a pre-installed Puppeteer version. The image is available via
|
dependencies and a pre-installed Puppeteer version. The image is available via
|
||||||
the
|
the
|
||||||
[GitHub Container Registry](https://github.com/puppeteer/puppeteer/pkgs/container/puppeteer).
|
[GitHub Container Registry](https://github.com/puppeteer/puppeteer/pkgs/container/puppeteer).
|
||||||
|
@ -46,7 +46,7 @@ pnpm i puppeteer
|
|||||||
```
|
```
|
||||||
|
|
||||||
When you install Puppeteer, it automatically downloads a recent version of
|
When you install Puppeteer, it automatically downloads a recent version of
|
||||||
[Chrome for Testing](https://goo.gle/chrome-for-testing) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
|
[Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing/) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
|
||||||
work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
|
work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
|
||||||
with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
|
with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
|
||||||
by default (starting with Puppeteer v19.0.0).
|
by default (starting with Puppeteer v19.0.0).
|
||||||
|
Loading…
Reference in New Issue
Block a user