mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
c0d9ccfebf
This patch: - updates docker seccomp profile to use a slightly modified default docker profile - removes SUID sandbox documentation since it doesn't seem to work References #2745
98 lines
3.1 KiB
Markdown
98 lines
3.1 KiB
Markdown
# Running Playwright in Docker
|
|
|
|
[Dockerfile.bionic](Dockerfile.bionic) is a playwright-ready image of playwright.
|
|
This image includes all the dependencies needed to run browsers in a Docker
|
|
container, including browsers.
|
|
|
|
<!-- GEN:toc -->
|
|
- [Usage](#usage)
|
|
* [Pull the image](#pull-the-image)
|
|
* [Run the image](#run-the-image)
|
|
* [Using on CI](#using-on-ci)
|
|
- [Development](#development)
|
|
* [Build the image](#build-the-image)
|
|
* [Push](#push)
|
|
- [Base images](#base-images)
|
|
* [Alpine](#alpine)
|
|
<!-- GEN:stop -->
|
|
|
|
## Usage
|
|
|
|
[](https://hub.docker.com/_/microsoft-playwright)
|
|
|
|
This image is published on [Docker Hub](https://hub.docker.com/_/microsoft-playwright).
|
|
|
|
### Pull the image
|
|
|
|
```
|
|
$ docker pull mcr.microsoft.com/playwright:bionic
|
|
```
|
|
|
|
### Run the image
|
|
|
|
```
|
|
$ docker container run -it --rm --ipc=host --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright:bionic /bin/bash
|
|
```
|
|
|
|
[`seccomp_profile.json`](seccomp_profile.json) is needed to run Chromium with sandbox. This is
|
|
a [default Docker seccomp profile](https://github.com/docker/engine/blob/d0d99b04cf6e00ed3fc27e81fc3d94e7eda70af3/profiles/seccomp/default.json) with extra user namespace cloning permissions:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"comment": "Allow create user namespaces",
|
|
"names": [
|
|
"clone",
|
|
"setns",
|
|
"unshare"
|
|
],
|
|
"action": "SCMP_ACT_ALLOW",
|
|
"args": [],
|
|
"includes": {},
|
|
"excludes": {}
|
|
}
|
|
]
|
|
```
|
|
|
|
> **NOTE**: Using `--ipc=host` is recommended when using Chrome ([Docker docs](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc)). Chrome can run out of memory without this flag.
|
|
|
|
### Using on CI
|
|
|
|
See our [Continuous Integration guides](../ci.md) for sample configs.
|
|
|
|
## Development
|
|
|
|
### Build the image
|
|
|
|
Use [`//docs/docker/build.sh`](build.sh) to build the image.
|
|
|
|
```
|
|
$ ./docs/docker/build.sh
|
|
```
|
|
|
|
The image will be tagged as `playwright:localbuild` and could be run as:
|
|
|
|
```
|
|
$ docker run --rm -it playwright:localbuild /bin/bash
|
|
```
|
|
|
|
> **NOTE**: any commit that changes docker image should also update [`//docs/docker/CURRENT_DOCKER_IMAGE_SIZE`](CURRENT_DOCKER_IMAGE_SIZE). Please run [`//docs/docker/docker-image-size.sh`](docker-image-size.sh) locally and commit updated number.
|
|
|
|
### Push
|
|
|
|
Docker images are published automatically by Github Actions. We currently publish the following
|
|
images:
|
|
- `mcr.microsoft.com/playwright:dev` - tip-of-tree image version.
|
|
- `mcr.microsoft.com/playwright:bionic` - last Playwright release docker image.
|
|
- `mcr.microsoft.com/playwright:sha-XXXXXXX` - docker image for every commit that changed
|
|
docker files or browsers, marked with a [short sha](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#Short-SHA-1) (first 7 digits of the SHA commit).
|
|
|
|
|
|
## Base images
|
|
|
|
`playwright:bionic` is based on Ubuntu 18.04 LTS (Bionic Beaver).
|
|
|
|
### Alpine
|
|
|
|
Browser builds for Firefox and WebKit are built for the [glibc](https://en.wikipedia.org/wiki/GNU_C_Library) library. Alpine Linux and other distributions that are based on the [musl](https://en.wikipedia.org/wiki/Musl) standard library are not supported.
|