Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.44 KB

README.md

File metadata and controls

69 lines (44 loc) · 2.44 KB
Raw

lighthouse-chromium

Wrapper around lighthouse that means there is no need to have Chrome installed where you are running it. It will automatically download and install Chromium.

Build Status npm version

Using the Node CLI

Simply use it as you would use lighthouse. Everything is passed through. Read the lighthouse documentation.

For example:

npm install -g lighthouse-chromium
lighthouse http://www.bom.gov.au/tas/forecasts/hobart.shtml --chrome-flags="--headless"

Using programmatically

Simply use it as you would use lighthouse, and read the lighthouse documentation.

Instead of requiring lighthouse require lighthouse-chromium:

// const lighthouse = require('lighthouse');
const lighthouse = require('lighthouse-chromium');

The only difference, which you probably won't need, is that lighthouse has the property .CHROME_PATH which points to the dynamically installed chromium binary:

const chromeLauncher = require('chrome-launcher');

// If you felt like it you could do this, but it should be unnecessary:
const chrome = await chromeLauncher.launch({ chromePath: lighthouse.CHROME_PATH });

Configuration

The Chromium download is handled by node_chromium - please see that project page for further configuration details.

Environment variables

Since 2.0.0 the environment variable prefix changed from CHROMIUM_ to NODE_CHROMIUM_

NODE_CHROMIUM_REVISION - install a specific Chromium revision:

export NODE_CHROMIUM_REVISION=768783

NODE_CHROMIUM_DOWNLOAD_HOST - download from a mirror:

export NODE_CHROMIUM_DOWNLOAD_HOST=https://npm.taobao.org/mirrors/chromium-browser-snapshots/

NPM config

Lower-case variants of the environment variables may be set in your .npmrc:

node_chromium_download_host=https://npm.taobao.org/mirrors/chromium-browser-snapshots/
node_chromium_revision=768783

If the both environment variable and npmrc are set then npmrc takes precedence.