Plugin which bundles and ensures that Headless Chrome/Chromium is running when your AWS Lambda function handler is invoked.
Serverless Chrome contains everything you need to get started running headless Chrome on AWS Lambda (possibly Azure and GCP Functions soon).
The aim of this project is to provide the scaffolding for using Headless Chrome during a serverless function invocation. Serverless Chrome takes care of building and bundling the Chrome binaries and making sure Chrome is running when your serverless function executes. In addition, this project also provides a few example services for common patterns (e.g. taking a screenshot of a page, printing to PDF, some scraping, etc.)
Why? Because it's neat. It also opens up interesting possibilities for using the Chrome DevTools Protocol (and tools like Chromeless or Puppeteer) in serverless architectures and doing testing/CI, web-scraping, pre-rendering, etc.
"Bla bla bla! I just want to start coding!" No problem:
Using AWS Lambda, the quickest way to get started is with the Serverless-framework CLI.
serverless globally (
npm install -g serverless) and then:
serverless create -u https://github.com/adieuadieu/serverless-chrome/tree/master/examples/serverless-framework/aws
Then, you must configure your AWS credentials either by defining
AWS_SECRET_ACCESS_KEY environmental variables, or
using an AWS profile. You can read more about this on the
Serverless Credentials Guide.
In short, either:
export AWS_ACCESS_KEY_ID=<your-key-here> export AWS_SECRET_ACCESS_KEY=<your-secret-key-here>
Then, to deploy the service and all of its functions:
npm run deploy
Further details are available in the Serverless Lambda example.
This project contains:
A collection of example functions for different providers and frameworks.
npm test. Each package also contains it's own integration tests
which can be run with
npm run test:integration.
A collection of articles and tutorials written by others on using serverless-chrome
Tell us about your project on the Wiki!
See the CHANGELOG
OMG. Yes. Plz, halp meeee.
This project was inspired in various ways by the following projects: