mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
1fbc3c643f
This PR makes some improvements to the documentation. It migrates docker, debugging, and chrome extension documentation to the `guides` folder and also updates some of the terminology.
23 lines
1.2 KiB
Markdown
23 lines
1.2 KiB
Markdown
# Docker
|
|
|
|
Puppeteer offers a Docker image that includes Chromium along with the required dependencies and a pre-installed Puppeteer version. The image is available via the [GitHub Container Registry](https://github.com/puppeteer/puppeteer/pkgs/container/puppeteer). The latest image is tagged as `latest` and other tags match Puppeteer versions. For example,
|
|
|
|
```sh
|
|
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:
|
|
|
|
```sh
|
|
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`](https://github.com/puppeteer/puppeteer/blob/main/docker/Dockerfile) as the starting point.
|