Skip to content

Commit dbff9f9

Browse files
committed
update readme
1 parent 032dd1a commit dbff9f9

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@
33

44
**Lambdium allows you to run a Selenium Webdriver script written in Javascript inside of an AWS Lambda function bundled with [Headless Chromium](https://developers.google.com/web/updates/2017/04/headless-chrome).**
55

6-
*This project is now published on the [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com), allowing you to install it in your AWS account with one click. Install in your AWS account [here](https://serverlessrepo.aws.amazon.com/#/applications/arn:aws:serverlessrepo:us-east-1:156280089524:applications~lambdium).* Quickstart instructions are in the [`README-SAR.md` file](https://github.com/smithclay/lambdium/blob/master/README-SAR.md).
6+
*This project is on the [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com), allowing you to install it in your AWS account with one click. Install in your AWS account [here](https://serverlessrepo.aws.amazon.com/#/applications/arn:aws:serverlessrepo:us-east-1:156280089524:applications~lambdium).* Quickstart instructions are in the [`README-SAR.md` file](https://github.com/smithclay/lambdium/blob/master/README-SAR.md).
77

8-
This uses the binaries from the [serverless-chrome](https://github.com/adieuadieu/serverless-chrome) project to prototype running headless chromium with `selenium-webdriver` in AWS Lambda. I've also bundled the chromedriver binary so the browser can be interacted with using the [Webdriver Protocol](https://www.w3.org/TR/webdriver/).
8+
lambdium lets you run Selenium Webdriver scripts _written in JavaScript_ using a full version of Google Chrome on AWS Lambda. You can use this AWS Lambda function to:
99

10-
#### Background
10+
* Run many concurrent selenium scripts at the same time without worrying about the infrastructure
11+
* Configure Cloudwatch Events to run script(s) on a schedule
12+
* Integrate tests into any event-driven workflows (like CodeDeploy checks, webhooks, or uploads to an S3 bucket)
1113

12-
The function interacts with [headless Chromium](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md) process using [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) and a popular webdriver node.js client library.
14+
Since this Lambda function is written using node.js, you can run almost any script written for [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver). Example scripts can be found in the `examples` directory.
1315

14-
*This is highly experimental and not all chromedriver functions will work. Check [issues](https://github.com/smithclay/lambdium/issues) for known issues.*
16+
This uses a special version of Chrome (headless chromium) from the [serverless-chrome](https://github.com/adieuadieu/serverless-chrome) project.
1517

16-
Since this Lambda function is written using node.js, you can run almost any script written for [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver). Example scripts can be found in the `examples` directory.
18+
*This is highly experimental and not all chromedriver functions will work. Check [issues](https://github.com/smithclay/lambdium/issues) for known issues.*
1719

1820
#### Requirements and Setup
1921

template.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
AWSTemplateFormatVersion : '2010-09-09'
22
Transform: AWS::Serverless-2016-10-31
3-
Description: headless chromium running selenium
3+
Description: selenium with headless chromium
44
Resources:
55
Lambdium:
66
Type: AWS::Serverless::Function
@@ -9,6 +9,7 @@ Resources:
99
Runtime: nodejs6.10
1010
FunctionName: lambdium
1111
Description: headless chromium running selenium
12+
# This needs to be fairly large: chromium needs a lot of memory
1213
MemorySize: 1156
1314
Timeout: 20
1415
Environment:

0 commit comments

Comments
 (0)