[github/fretlink/docker-puppeteer.git] / README.md

# Docker Puppeteer

A Node + Puppeteer base image for running Puppeteer scripts. Add your own tools (such as Jest, Mocha, etc), link services you want to test via Docker Compose, and run your Puppeteer scripts with a headless Chromium.

## Versions

See the list of [Docker Hub tags](https://hub.docker.com/r/buildkite/puppeteer/tags/) for Puppeteer versions available.

## Example

See the [example directory](example) for a complete Docker Compose example, showing how to run Puppeteer against a linked Docker Compose web service.

## Dependent Services

This image includes [wait-for-it.sh](https://github.com/vishnubob/wait-for-it) which can be useful if you need to wait for a dependent web service to start accepting requests before your Puppeteer container attempts connecting to it. See [the example](example) for usage.

## Releasing

1. Create a new release on GitHub. The image is tagged with the same version as Puppeteer.
2. Docker Hub automatically builds images for the tag.
3. There is no step 3.
Commit	Line	Data
162d70f3 TL	1	# Docker Puppeteer
162d70f3 TL	2
a8f76dff TL	3	A Node + Puppeteer base image for running Puppeteer scripts. Add your own tools (such as Jest, Mocha, etc), link services you want to test via Docker Compose, and run your Puppeteer scripts with a headless Chromium.
a8f76dff TL	4
40876fe8	5	## Versions
162d70f3	6
40876fe8	7	See the list of [Docker Hub tags](https://hub.docker.com/r/buildkite/puppeteer/tags/) for Puppeteer versions available.
162d70f3	8
40876fe8	9	## Example
162d70f3	10
40876fe8	11	See the [example directory](example) for a complete Docker Compose example, showing how to run Puppeteer against a linked Docker Compose web service.
68111971 TL	12
	13	## Dependent Services
	14
	15	This image includes [wait-for-it.sh](https://github.com/vishnubob/wait-for-it) which can be useful if you need to wait for a dependent web service to start accepting requests before your Puppeteer container attempts connecting to it. See [the example](example) for usage.
79b430f2 TL	16
	17	## Releasing
	18
	19	1. Create a new release on GitHub. The image is tagged with the same version as Puppeteer.
	20	2. Docker Hub automatically builds images for the tag.
	21	3. There is no step 3.