puppeteer/website/versioned_docs/version-22.6.3/guides/docker.md
release-please[bot] a63b8305ac
chore: release main (#12190)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-04-05 13:11:52 +00:00

1.4 KiB

Docker

Puppeteer offers a Docker image that includes Chrome for Testing along with the required dependencies and a pre-installed Puppeteer version. The image is available via the GitHub Container Registry. The latest image is tagged as latest and other tags match Puppeteer versions. For example,

docker pull ghcr.io/puppeteer/puppeteer:latest # pulls the latest
docker pull ghcr.io/puppeteer/puppeteer:16.1.0 # pulls the image that contains Puppeteer v16.1.0

The image is meant for running the browser in sandbox mode and therefore, running the image requires the SYS_ADMIN capability.

Usage

To use the docker image directly, run:

docker run -i --init --cap-add=SYS_ADMIN --rm ghcr.io/puppeteer/puppeteer:latest node -e "$(cat path/to/script.js)"

where path/to/script.js is the path relative to your working directory. Note the image requires the SYS_ADMIN capability since the browser runs in sandbox mode.

If you need to build an image based on a different base image, you can use our Dockerfile as the starting point.

:::caution

Make sure to specify a init process via the --init flag or a custom ENTRYPOINT to make sure all processes started by Puppeteer are managed properly.

:::