Merge pull request #1 from phase2/the-stuff

Initial commit of the stuff.

Dockerfile

@@ -0,0 +1,32 @@
+FROM alekzonder/puppeteer:1
+
+# @see http://label-schema.org/rc1/
+LABEL maintainer="Phase2 <outrigger@phase2technology.com>" \
+  org.label-schema.vendor="Phase2 <outrigger@phase2technology.com>" \
+  org.label-schema.name="Outrigger pa11y" \
+  org.label-schema.description="Docker image for pa11y, the CLI-based accessibility testing tool." \
+  org.label-schema.vcs-url="https://github.com/phase2/docker-pa11y" \
+  org.label-schema.docker.cmd="docker run -it --rm --cap-add=SYS_ADMIN outrigger/pa11y http://example.com" \
+  org.label-schema.docker.cmd.help="docker run --rm outrigger/pa11y" \
+  org.label-schema.docker.debug="docker exec -it $CONTAINER bash" \
+  org.label-schema.schema-version="1.0"
+
+# It's a good idea to use dumb-init to help prevent zombie chrome processes.
+ADD https://github.com/Yelp/dumb-init/releases/download/v1.2.0/dumb-init_1.2.0_amd64 /usr/local/bin/dumb-init
+RUN chmod +x /usr/local/bin/dumb-init
+
+# Let's get pa11y v5 in here.
+RUN yarn global add pa11y@beta
+
+# Add user so we don't need --no-sandbox.
+RUN groupadd -r pptruser && useradd -r -g pptruser -G audio,video pptruser \
+    && mkdir -p /home/pptruser/Downloads \
+    && chown -R pptruser:pptruser /home/pptruser \
+    && chown -R pptruser:pptruser /screenshots \
+    && chown -R pptruser:pptruser /usr/local/share/.config/yarn/global/node_modules
+
+USER pptruser
+
+ENTRYPOINT ["dumb-init", "--", "pa11y"]
+
+CMD ["-h"]

README.md

@@ -0,0 +1,109 @@
+# Outrigger pa11y
+
+> Docker image for pa11y, the CLI-based accessibility testing tool.
+
+[![GitHub tag](https://img.shields.io/github/tag/phase2/docker-pa11y.svg)](https://github.com/phase2/docker-pa11y) [![Docker Stars](https://img.shields.io/docker/stars/outrigger/pa11y.svg)](https://hub.docker.com/r/outrigger/pa11y) [![Docker Pulls](https://img.shields.io/docker/pulls/outrigger/pa11y.svg)](https://hub.docker.com/r/outrigger/pa11y) [![](https://images.microbadger.com/badges/image/outrigger/pa11y:dev.svg)](https://microbadger.com/images/outrigger/pa11y:dev "Get your own image badge on microbadger.com")
+
+This Docker image provides the use of [pa11y v5](https://github.com/pa11y/pa11y).
+(Note that the v5 version of that project is currently not in the master branch.)
+
+## Usage Examples
+
+### Docker Run
+
+This is a quick demonstration of how you can use pa11y to run checks against a
+given URL.
+
+```
+docker run -i --rm --cap-add=SYS_ADMIN \
+  --name pa11y outrigger/pa11y:1 http://outrigger.sh
+```
+
+### Docker-Compose - Simple
+
+This is the docker-compose style to execute the same docker run command as above.
+
+```yaml
+version: '3.3'
+services:
+  pa11y:
+    image: outrigger/pa11y:1
+    container_name: projectname_${DOCKER_ENV:-local}_pa11y
+    command: http://outrigger.sh
+    network_mode: bridge
+    cap_add:
+      - SYS_ADMIN
+```
+
+### Docker-Compose - Project
+
+This is an example service definition to run pa11y as part of your project.
+
+Since you would not run this operationally alongside your webserver, this should
+not be added to your main docker-compose.yml. Instead, it might go in a build.yml
+or wherever you are defining CLI or testing tools.
+
+```yaml
+# docker-compose -f build.yml run --rm pa11y
+version: '3.3'
+services:
+  pa11y:
+    image: outrigger/pa11y:1
+    container_name: projectname_${DOCKER_ENV:-local}_pa11y
+    command: ["--config", "/code/pa11y/config.js"]
+    network_mode: bridge
+    volumes:
+      # Inject your pa11y configuration. We assume you have a config.js script.
+      - ./tests/pa11y/:/code/pa11y/
+    cap_add:
+      - SYS_ADMIN
+```
+
+### pa11y Configuration File
+
+This is a start for your configuration file.
+
+The default customizations to chrome ensures HTTPS errors are ignored and that Chrome has enough memory.
+
+```js
+const browser = await puppeteer.launch({
+    ignoreHTTPSErrors: true,
+    args: [
+      '--disable-dev-shm-usage'
+    ],
+});
+
+pa11y('http://outrigger.sh', {
+    browser: browser
+});
+
+browser.close();
+```
+
+### Screenshot Example
+
+This is an example of reaching around pa11y to the underlying screenshot tools
+built into the base puppeteer image we are using, [alekzonder/puppeteer](https://hub.docker.com/r/alekzonder/puppeteer/)
+
+```bash
+docker run -it --rm \
+  --shm-size 1G \
+  -v $PWD:/screenshots \
+  --entrypoint ""
+  outrigger/pa11y:1 \
+  screenshot_series 'http://outrigger.sh' 1366x768
+```
+
+## Resources
+
+* General issues on Puppeteer should check out the [base Puppeteer image](https://hub.docker.com/r/alekzonder/puppeteer/). Note: you can follow the instructions in that README to take screenshots. Since this image is based on that, you should not need a further Docker iamge download.
+* [Puppeteer Github Project](https://github.com/GoogleChrome/puppeteer)
+* [Official Puppeteer Docker guidance](https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#running-puppeteer-in-docker)
+
+## Security Reports
+
+Please email outrigger@phase2technology.com with security concerns.
+
+## Maintainers
+
+[![Phase2 Logo](https://s3.amazonaws.com/phase2.public/logos/phase2-logo.png)](https://www.phase2technology.com)

build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+docker build -t outrigger/pa11y .