playwright/docs/src/docker.md at cb10ef3c71455c50965cd8632c47a98c90bab4db

Andrey Lushnikov b09ea69024

chore(docker): address docker offline comments (#17377 )

This patch:
- Removes all `process.exit(1)` from `docker.ts` and instead throws
  errors.
- Drops the `npx playwright docker test` command. We agreed to
  engage docker when `PLAYWRIGHT_DOCKER` environment variable
  is set.
- Introduces hidden `npx playwright docker status` command that
  dumps a JSON with docker status:
  ```sh
  aslushnikov:~/prog/playwright$ npx playwright docker status
  {
    "dockerEngineRunning": true,
    "imageName": "playwright:local-1.27.0-next-focal",
    "imageIsPulled": true,
"containerWSEndpoing":
"ws://127.0.0.1:55077/eafeb84c-571b-4d12-ac51-f6a2b43e9155",
"containerVNCEndpoint":
"http://127.0.0.1:55076/?path=fb6d4add-9adf-4c3c-b335-893bdc235cd7&resize=scale&autoconnect=1"
  }
  ```

2022-09-15 15:48:12 -07:00

7.1 KiB

Raw Blame History

id	title
docker	Docker

[Dockerfile.focal] can be used to run Playwright scripts in Docker environment. These image includes all the dependencies needed to run browsers in a Docker container, and also include the browsers themselves.

Usage

This image is published on [Docker Hub].

Pull the image

docker pull mcr.microsoft.com/playwright:v1.27.0-focal

docker pull mcr.microsoft.com/playwright/python:v1.27.0-focal

docker pull mcr.microsoft.com/playwright/dotnet:v1.27.0-focal

docker pull mcr.microsoft.com/playwright/java:v1.27.0-focal

Run the image

By default, the Docker image will use the root user to run the browsers. This will disable the Chromium sandbox which is not available with root. If you run trusted code (e.g. End-to-end tests) and want to avoid the hassle of managing separate user then the root user may be fine. For web scraping or crawling, we recommend to create a separate user inside the Docker container and use the seccomp profile.

End-to-end tests

On trusted websites, you can avoid creating a separate user and use root for it since you trust the code which will run on the browsers.

docker run -it --rm --ipc=host mcr.microsoft.com/playwright:v1.27.0-focal /bin/bash

docker run -it --rm --ipc=host mcr.microsoft.com/playwright/python:v1.27.0-focal /bin/bash

docker run -it --rm --ipc=host mcr.microsoft.com/playwright/dotnet:v1.27.0-focal /bin/bash

docker run -it --rm --ipc=host mcr.microsoft.com/playwright/java:v1.27.0-focal /bin/bash

Crawling and scraping

On untrusted websites, it's recommended to use a separate user for launching the browsers in combination with the seccomp profile. Inside the container or if you are using the Docker image as a base image you have to use adduser for it.

docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright:v1.27.0-focal /bin/bash

docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright/python:v1.27.0-focal /bin/bash

docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright/dotnet:v1.27.0-focal /bin/bash

docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright/java:v1.27.0-focal /bin/bash

seccomp_profile.json is needed to run Chromium with sandbox. This is a default Docker seccomp profile with extra user namespace cloning permissions:

[
  {
    "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). Chrome can run out of memory without this flag. :::

Using on CI

See our Continuous Integration guides for sample configs.

Image tags

See [all available image tags].

Docker images are published automatically by GitHub Actions. We currently publish images with the following tags (v1.20.0 in this case is an example:):

:next - tip-of-tree image version based on Ubuntu 20.04 LTS (Focal Fossa).
:next-focal - tip-of-tree image version based on Ubuntu 20.04 LTS (Focal Fossa).
:v1.20.0 - Playwright v1.20.0 release docker image based on Ubuntu 20.04 LTS (Focal Fossa).
:v1.20.0-focal - Playwright v1.20.0 release docker image based on Ubuntu 20.04 LTS (Focal Fossa).
:sha-XXXXXXX - docker image for every commit that changed docker files or browsers, marked with a short sha (first 7 digits of the SHA commit).

:::note It is recommended to always pin your Docker image to a specific version if possible. If the Playwright version in your Docker image does not match the version in your project/tests, Playwright will be unable to locate browser executables. :::

Base images

We currently publish images based on the following Ubuntu versions:

Ubuntu 22.04 LTS (Jammy Jellyfish), image tags include jammy (not published for Java and .NET)
Ubuntu 20.04 LTS (Focal Fossa), image tags include focal
Ubuntu 18.04 LTS (Bionic Beaver), image tags include bionic (not published for Java and .NET)

Alpine

Browser builds for Firefox and WebKit are built for the glibc library. Alpine Linux and other distributions that are based on the musl standard library are not supported.

Development

langs: js

Build the image

Use //utils/docker/build.sh to build the image.

./utils/docker/build.sh focal playwright:localbuild-focal

The image will be tagged as playwright:localbuild-focal and could be run as:

docker run --rm -it playwright:localbuild /bin/bash

(Experimental) Playwright Test Docker Integration

langs: js

Playwright Test now ships an experimental Docker integration. The Docker container provides a consistent environment, eliminating browser rendering differences across platforms. With this integration, only browser binaries are running inside a Docker container, while all the code is still running on the host operating system.

Playwright Test will automatically proxy host network traffic into the container, so browsers can access servers running on the host.

:::note Docker integration requires Docker installed & running on your computer. See https://docs.docker.com/get-docker/

If you use Docker Desktop, make sure to increase default CPU and memory limit for better performance. :::

Docker integration usage:

Build a local Docker image that will be used to run containers. This step needs to be done only once.
```
npx playwright docker build
```
Run Docker container in the background.
```
npx playwright docker start
```

Run tests inside Docker container using the PLAYWRIGHT_DOCKER environment variable. You can set this environment variable as a part of your config:

// playwright.config.ts
import type { PlaywrightTestConfig } from '@playwright/test';

process.env.PLAYWRIGHT_DOCKER = '1';

const config: PlaywrightTestConfig = {
  /* ... configuration ... */
};
export default config;

NOTE: Playwright will automatically detect a running Docker container or start it if needed.

Finally, stop background Docker container when you're done working with tests:
```
npx playwright docker stop
```

7.1 KiB Raw Blame History