Skip to content

Latest commit

 

History

History
159 lines (110 loc) · 5.97 KB

docker.md

File metadata and controls

159 lines (110 loc) · 5.97 KB
Raw
id title
docker
Docker

Introduction

[Dockerfile.noble] can be used to run Playwright scripts in Docker environment. This image includes the Playwright browsers and browser system dependencies. The Playwright package/dependency is not included in the image and should be installed separately.

Usage

This Docker image is published to [Microsoft Artifact Registry].

:::info This Docker image is intended to be used for testing and development purposes only. It is not recommended to use this Docker image to visit untrusted websites. :::

Pull the image

docker pull mcr.microsoft.com/playwright:v%%VERSION%%-noble
docker pull mcr.microsoft.com/playwright/python:v%%VERSION%%-noble
docker pull mcr.microsoft.com/playwright/dotnet:v%%VERSION%%-noble
docker pull mcr.microsoft.com/playwright/java:v%%VERSION%%-noble

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:v%%VERSION%%-noble /bin/bash
docker run -it --rm --ipc=host mcr.microsoft.com/playwright/python:v%%VERSION%%-noble /bin/bash
docker run -it --rm --ipc=host mcr.microsoft.com/playwright/dotnet:v%%VERSION%%-noble /bin/bash
docker run -it --rm --ipc=host mcr.microsoft.com/playwright/java:v%%VERSION%%-noble /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:v%%VERSION%%-noble /bin/bash
docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright/python:v%%VERSION%%-noble /bin/bash
docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright/dotnet:v%%VERSION%%-noble /bin/bash
docker run -it --rm --ipc=host --user pwuser --security-opt seccomp=seccomp_profile.json mcr.microsoft.com/playwright/java:v%%VERSION%%-noble /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].

We currently publish images with the following tags:

  • :v%%VERSION%% - Playwright v%%VERSION%% release docker image based on Ubuntu 24.04 LTS (Noble Numbat).
  • :v%%VERSION%%-noble - Playwright v%%VERSION%% release docker image based on Ubuntu 24.04 LTS (Noble Numbat).
  • :v%%VERSION%%-jammy - Playwright v%%VERSION%% release docker image based on Ubuntu 22.04 LTS (Jammy Jellyfish).

:::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 24.04 LTS (Noble Numbat), image tags include noble
  • Ubuntu 22.04 LTS (Jammy Jellyfish), image tags include jammy

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.

Using a different .NET version

  • langs: csharp

You can use the .NET install script in order to install different SDK versions:

curl -sSL https://dot.net/v1/dotnet-install.sh | bash /dev/stdin --install-dir /usr/share/dotnet --channel 6.0

Build your own image

  • langs: js

To run Playwright inside Docker, you need to have Node.js, Playwright browsers and browser system dependencies installed. See the following Dockerfile:

FROM node:20-bookworm

RUN npx -y playwright@%%VERSION%% install --with-deps

Build your own image

  • langs: python

To run Playwright inside Docker, you need to have Python, Playwright browsers and browser system dependencies installed. See the following Dockerfile:

FROM python:3.12-bookworm

RUN pip install playwright==@%%VERSION%% && \
    playwright install --with-deps