Run a cluster of pa11y scans using AWS Lambda.
Dependencies:
- Docker
- docker-compose
Set up an AWS Lambda function with pa11y using pa11y-lambda.
Add an AWS API Gateway endpoint (click on the "API Endpoints" tab in the Lambda console).
The endpoint's HTTP method should be POST. Select "Open" for the security setting.
Once the endpoint is created, AWS will show you its URL.
Create an API key for your endpoint (https://console.aws.amazon.com/apigateway/home#/api-keys).
Clone this repo and cd into it.
Build the image:
docker-compose build
Make sure the build succeeded:
docker-compose run web npm --version
This should output the version of NPM installed on the Docker container.
Configure your .env file:
cp app/.env.example app/.env
Edit the environment variables using the API key and API endpoint from the Setup AWS Lambda section.
Run the cluster:
docker-compose run web node index.js
The results of each scan will appear in the app/results folder (contents are .gitignored). Each file will be named {domain}.json and contain the JSON output from the pa11y scan.
In app/.env you can set the concurrency level. It defaults to 4.
At some point this will all be much easier to configure, but by modifying app/index.js you can alter the following:
const urls(the URLs to scan)
Currently, urls is an array with a sample of 11 .gov URLs.
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.