Skip to content

Commit

Permalink
feat(Launcher): Allow environment variables definition when launching…
Browse files Browse the repository at this point in the history
… chromium (#912)

This patch adds `env` option to the `puppeteer.launch` method to define custom environment
variables to the launched chrome.
  • Loading branch information
BenoitZugmeyer authored and aslushnikov committed Oct 5, 2017
1 parent 97e40e6 commit c225b93
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/api.md
Expand Up @@ -196,6 +196,7 @@ This methods attaches Puppeteer to an existing Chromium instance.
- `timeout` <[number]> Maximum time in milliseconds to wait for the Chrome instance to start. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
- `dumpio` <[boolean]> Whether to pipe browser process stdout and stderr into `process.stdout` and `process.stderr`. Defaults to `false`.
- `userDataDir` <[string]> Path to a [User Data Directory](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md).
- `env` <[Object]> Specify environment variables that will be visible to Chromium. Defaults to `process.env`.
- returns: <[Promise]<[Browser]>> Promise which resolves to browser instance.

The method launches a browser instance with given arguments. The browser will be closed when the parent node.js process is closed.
Expand Down
9 changes: 8 additions & 1 deletion lib/Launcher.js
Expand Up @@ -89,7 +89,14 @@ class Launcher {
if (Array.isArray(options.args))
chromeArguments.push(...options.args);

const chromeProcess = childProcess.spawn(chromeExecutable, chromeArguments, {detached: true});
const chromeProcess = childProcess.spawn(
chromeExecutable,
chromeArguments,
{
detached: true,
env: options.env || process.env
}
);
if (options.dumpio) {
chromeProcess.stdout.pipe(process.stdout);
chromeProcess.stderr.pipe(process.stderr);
Expand Down

0 comments on commit c225b93

Please sign in to comment.