launchPuppeteer
Callable
Parameters
optionallaunchContext: PuppeteerLaunchContext
All
PuppeteerLauncher
parameters are passed via an launchContext object. If you want to pass custompuppeteer.launch(options)
options you can use thePuppeteerLaunchContext.launchOptions
property.optionalconfig: Configuration = ...
Returns Promise<Browser>
Promise that resolves to Puppeteer's
Browser
instance.
Launches headless Chrome using Puppeteer pre-configured to work within the Apify platform. The function has the same argument and the return value as
puppeteer.launch()
. See Puppeteer documentation for more details.The
launchPuppeteer()
function alters the following Puppeteer options:CRAWLEE_HEADLESS
environment variable to theheadless
option, unless it was already defined by the caller orCRAWLEE_XVFB
environment variable is set to1
. Note that Apify Actor cloud platform automatically setsCRAWLEE_HEADLESS=1
to all running actors.proxyUrl
option, validates it and adds it toargs
as--proxy-server=XXX
. The proxy URL must define a port number and have one of the following schemes:http://
,https://
,socks4://
orsocks5://
. If the proxy is HTTP (i.e. has thehttp://
scheme) and contains username or password, thelaunchPuppeteer
functions sets up an anonymous proxy HTTP to make the proxy work with headless Chrome. For more information, read the blog post about proxy-chain library.To use this function, you need to have the puppeteer NPM package installed in your project. When running on the Apify cloud, you can achieve that simply by using the
apify/actor-node-chrome
base Docker image for your actor - see Apify Actor documentation for details.