[Question]: Missing X server or $DISPLAY error while running xvfb-run in docker #14250

denismur · 2022-05-18T00:03:39Z

Your question

I'm trying to run playwright script in docker with headless=False option and with hvfb-run but got an error

╔════════════════════════════════════════════════════════════════════════════════════════════════╗
║ Looks like you launched a headed browser without having a XServer running.                     ║
║ Set either 'headless: true' or use 'xvfb-run <your-playwright-app>' before running Playwright. ║
║                                                                                                ║
║ <3 Playwright Team                                                                             ║
╚════════════════════════════════════════════════════════════════════════════════════════════════╝

=========================== logs ===========================

<launching> /ms-playwright/chromium-1005/chrome-linux/chrome --disable-field-trial-config --disable-background-networking --enable-features=NetworkService,NetworkServiceInProcess --disable-background-timer-throttling --disable-backgrounding-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-background-pages --disable-default-apps --disable-dev-shm-usage --disable-extensions --disable-features=ImprovedCookieControls,LazyFrameLoading,GlobalMediaControls,DestroyProfileOnBrowserClose,MediaRouter,DialMediaRouteProvider,AcceptCHFrame,AutoExpandDetailsElement,CertificateTransparencyComponentUpdater,AvoidUnnecessaryBeforeUnloadCheckSync --allow-pre-commit-input --disable-hang-monitor --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-backgrounding --disable-sync --force-color-profile=srgb --metrics-recording-only --no-first-run --enable-automation --password-store=basic --use-mock-keychain --no-service-autorun --export-tagged-pdf --no-sandbox --window-size=1300,570 --window-position=000,000 --disable-dev-shm-usage --no-sandbox --disable-web-security --disable-features=site-per-process --disable-setuid-sandbox --disable-accelerated-2d-canvas --no-first-run --no-zygote --single-process --disable-gpu --use-gl=egl --disable-blink-features=AutomationControlled --disable-background-networking --enable-features=NetworkService,NetworkServiceInProcess --disable-background-timer-throttling --disable-backgrounding-occluded-windows --disable-breakpad --disable-client-side-phishing-detection --disable-component-extensions-with-background-pages --disable-default-apps --disable-extensions --disable-features=Translate --disable-hang-monitor --disable-ipc-flooding-protection --disable-popup-blocking --disable-prompt-on-repost --disable-renderer-backgrounding --disable-sync --force-color-profile=srgb --metrics-recording-only --enable-automation --password-store=basic --use-mock-keychain --hide-scrollbars --mute-audio --user-data-dir=/tmp/playwright_chromiumdev_profile-1XCxqn --remote-debugging-pipe --no-startup-window

<launched> pid=155

[pid=155][err] [155:155:0517/235522.027129:ERROR:ozone_platform_x11.cc(247)] Missing X server or $DISPLAY

[pid=155][err] [155:155:0517/235522.052874:ERROR:env.cc(226)] The platform failed to initialize.  Exiting.

============================================================

I use a mcr.microsoft.com/playwright/python:v1.22.0-focal image,
ENV DISPLAY :99
and my CMD look's like:
xvfb-run --auto-servernum --server-num=1 --server-args='-screen 0, 1920x1080x24' python3 browser.py param

Any ideas what am I doing wrong?

The text was updated successfully, but these errors were encountered:

SidduMirji · 2022-05-18T12:11:32Z

I'm also getting the same error. Running the test from docker container with jenkins pipeline.

mxschmitt · 2022-05-18T17:46:58Z

I tried to reproduce but it works for me:

use the official Docker image
Run a headed browser instance and create a page, without xvfb it will yield to the error
Add xvfb-run then the error will be gone

could you share with us a repro without Jenkins etc?

denismur · 2022-05-18T17:52:59Z

Could you share your Dockerfile?

I tried to reproduce but it works for me:

use the official Docker image

Run a headed browser instance and create a page, without xvfb it will yield to the error

Add xvfb-run then the error will be gone

could you share with us a repro without Jenkins etc?

mxschmitt · 2022-05-18T18:09:33Z

I did the following: docker run -it mcr.microsoft.com/playwright/python:v1.22.0-focal /bin/bash in step 1

And used an snippet from the docs which launches a browser instance.

denismur · 2022-05-18T18:18:34Z

I've used the same docker image, but I've reinstalled python to 3.9

Dockerfile:

FROM mcr.microsoft.com/playwright/python:latest

RUN apt-get update && DEBIAN_FRONTEND="noninteractive" TZ="Europe/Moscow" apt-get install -y tzdata

# === INSTALL Python ===
RUN apt-get update && apt-get install -y python3.9 python3-pip && \
    update-alternatives --install /usr/bin/pip pip /usr/bin/pip3 1 && \
    update-alternatives --install /usr/bin/python python /usr/bin/python3 1 && \
    update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.9 1

RUN apt-get update && \
    apt-get upgrade -y && \
    apt-get install -y git gnupg2

RUN apt-get update && apt-get install -y --no-install-recommends apt-utils

COPY . /usr/src/test
WORKDIR /usr/src/test
RUN pip install --upgrade pip
RUN pip install --no-cache-dir -r requirements.txt

requirements.txt:

aiodocker
beautifulsoup4
EasyProcess
elasticsearch[async]
motor
pandas
pillow
playwright
playwright_stealth
pymongo
pydantic
python_ghost_cursor
requests

I did the following: docker run -it mcr.microsoft.com/playwright/python:v1.22.0-focal /bin/bash in step 1

And used an snippet from the docs which launches a browser instance.

mxschmitt · 2022-05-18T20:54:52Z

How does browser.py look like? something which I can easily run locally would be nice!

denismur · 2022-05-18T21:01:53Z

Here is a short version without additional parameters

from playwright.async_api import Playwright, async_playwright, expect
from playwright_stealth import stealth_async, StealthConfig
from python_ghost_cursor.playwright_async import create_cursor
import asyncio

async def run(playwright: Playwright) -> None:
    browser_args = [
        '--window-size=1300,570',
        '--window-position=000,000',
        '--disable-dev-shm-usage',
        '--no-sandbox',
        '--disable-web-security',
        '--disable-features=site-per-process',
        '--disable-setuid-sandbox',
        '--disable-accelerated-2d-canvas',
        '--no-first-run',
        '--no-zygote',
        '--single-process',
        '--disable-gpu',
        '--use-gl=egl',
        '--disable-blink-features=AutomationControlled',
        '--disable-background-networking',
        '--enable-features=NetworkService,NetworkServiceInProcess',
        '--disable-background-timer-throttling',
        '--disable-backgrounding-occluded-windows',
        '--disable-breakpad',
        '--disable-client-side-phishing-detection',
        '--disable-component-extensions-with-background-pages',
        '--disable-default-apps',
        '--disable-extensions',
        '--disable-features=Translate',
        '--disable-hang-monitor',
        '--disable-ipc-flooding-protection',
        '--disable-popup-blocking',
        '--disable-prompt-on-repost',
        '--disable-renderer-backgrounding',
        '--disable-sync',
        '--force-color-profile=srgb',
        '--metrics-recording-only',
        '--enable-automation',
        '--password-store=basic',
        '--use-mock-keychain',
        '--hide-scrollbars',
        '--mute-audio'
    ]         
    chromium = playwright.chromium
    browser = await chromium.launch(
        headless=False,
        args=browser_args,
    )

    context = await browser.new_context(
        ignore_https_errors=True,
        locale='en-US',
        permissions=['notifications'],
    )

    page = await context.new_page()
    await stealth_async(page)
    cursor = create_cursor(page)

    await page.goto('https://google.com', wait_until='networkidle')
    print(page.url)

    await context.close()
    await browser.close()
async def main():
    async with async_playwright() as playwright:
        await run(playwright)

if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())
loop.close()

By the way:
OS: macOS Monterey 12.3.1
Docker Engine: 20.10.14
Python 3.9
Playwright 1.22

mxschmitt · 2022-05-19T08:39:41Z

This is using playwright_stealth which is not supported. I did the following which makes it work for me:

removed playwright_stealth
removed create_cursor

removed the args:

```
    '--single-process',
```
```
   '--disable-gpu',
```

Then it was working for me.

denismur · 2022-05-20T01:01:49Z

@mxschmitt Doesn't worked for me. No output, just script freeze on run.
Could you share the details of your script? On what python version you've tested?

mxschmitt · 2022-05-23T17:04:20Z

I was using the official Docker image: docker run -it mcr.microsoft.com/playwright/python:v1.22.0-focal /bin/bash

yury-s · 2022-05-26T00:43:28Z

@mxschmitt Doesn't worked for me. No output, just script freeze on run.
Could you share the details of your script? On what python version you've tested?

Works for me as well, the command I ran inside docker is :

xvfb-run --auto-servernum --server-num=1 --server-args='-screen 0, 1920x1080x24' python test.py

# test.py
from playwright.async_api import Playwright, async_playwright, expect
import asyncio

async def run(playwright: Playwright) -> None:
    browser_args = [
        '--window-size=1300,570',
        '--window-position=000,000',
        '--disable-dev-shm-usage',
        '--no-sandbox',
        '--disable-web-security',
        '--disable-features=site-per-process',
        '--disable-setuid-sandbox',
        '--disable-accelerated-2d-canvas',
        '--no-first-run',
        '--no-zygote',
        '--use-gl=egl',
        '--disable-blink-features=AutomationControlled',
        '--disable-background-networking',
        '--enable-features=NetworkService,NetworkServiceInProcess',
        '--disable-background-timer-throttling',
        '--disable-backgrounding-occluded-windows',
        '--disable-breakpad',
        '--disable-client-side-phishing-detection',
        '--disable-component-extensions-with-background-pages',
        '--disable-default-apps',
        '--disable-extensions',
        '--disable-features=Translate',
        '--disable-hang-monitor',
        '--disable-ipc-flooding-protection',
        '--disable-popup-blocking',
        '--disable-prompt-on-repost',
        '--disable-renderer-backgrounding',
        '--disable-sync',
        '--force-color-profile=srgb',
        '--metrics-recording-only',
        '--enable-automation',
        '--password-store=basic',
        '--use-mock-keychain',
        '--hide-scrollbars',
        '--mute-audio'
    ]         
    chromium = playwright.chromium
    browser = await chromium.launch(
        headless=False,
        args=browser_args,
    )

    context = await browser.new_context(
        ignore_https_errors=True,
        locale='en-US',
        permissions=['notifications'],
    )

    page = await context.new_page()

    await page.goto('https://google.com', wait_until='networkidle')
    print(page.url)

    await context.close()
    await browser.close()
async def main():
    async with async_playwright() as playwright:
        await run(playwright)

if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())
loop.close()

This is the output:

root@4f7680af8851:~# xvfb-run --auto-servernum --server-num=1 --server-args='-screen 0, 1920x1080x24' python test.py 
https://www.google.com/
root@4f7680af8851:~#

aslushnikov · 2022-05-31T11:18:52Z

Closing this since there's no repro. If this still happens for you and you think the issue is on Playwright side, please re-file with a repro that we can debug!

Ayan-Bandyopadhyay · 2024-09-26T07:12:16Z

I'm running into this issue while trying to run a fastapi server with poetry. The error message is Looks like you launched a headed browser without having a XServer running. Set either 'headless: true' or use 'xvfb-run <your-playwright-app>' before running Playwright.

Here is my Dockerfile:

FROM mcr.microsoft.com/playwright/python:v1.47.0-jammy

ENV POETRY_HOME=/opt/poetry
ENV POETRY_VENV=/opt/poetry-venv
ENV POETRY_DATA_DIR=/opt/poetry-data
ENV POETRY_CONFIG_DIR=/opt/poetry-config
# Tell Poetry where to place its cache and virtual environment
ENV POETRY_CACHE_DIR=/opt/.cache

VOLUME ./.poetry-data-cache /opt/poetry-data
VOLUME ./.poetry-cache /opt/.cache

RUN python -m pip install poetry==1.7.1
WORKDIR /workspace
RUN poetry config virtualenvs.create false

COPY ./pyproject.toml ./pyproject.toml
COPY ./poetry.lock ./poetry.lock
# install only deps in dependency list first and lockfile to cache them
RUN poetry install --no-root --only main

COPY . .
# then install our own module
RUN poetry install --only main

EXPOSE 8000

ENTRYPOINT ["xvfb-run", "--auto-servernum", "--server-num=1", "--server-args='-screen 0, 1920x1080x24'", "poetry", "run", "start" ]

And here is the fastapi endpoint that throws the above error:

@app.get("/test")
async def test():
    browser_args = [
        "--window-size=1300,570",
        "--window-position=000,000",
        "--disable-dev-shm-usage",
        "--no-sandbox",
        "--disable-web-security",
        "--disable-features=site-per-process",
        "--disable-setuid-sandbox",
        "--disable-accelerated-2d-canvas",
        "--no-first-run",
        "--no-zygote",
        "--use-gl=egl",
        "--disable-blink-features=AutomationControlled",
        "--disable-background-networking",
        "--enable-features=NetworkService,NetworkServiceInProcess",
        "--disable-background-timer-throttling",
        "--disable-backgrounding-occluded-windows",
        "--disable-breakpad",
        "--disable-client-side-phishing-detection",
        "--disable-component-extensions-with-background-pages",
        "--disable-default-apps",
        "--disable-extensions",
        "--disable-features=Translate",
        "--disable-hang-monitor",
        "--disable-ipc-flooding-protection",
        "--disable-popup-blocking",
        "--disable-prompt-on-repost",
        "--disable-renderer-backgrounding",
        "--disable-sync",
        "--force-color-profile=srgb",
        "--metrics-recording-only",
        "--enable-automation",
        "--password-store=basic",
        "--use-mock-keychain",
        "--hide-scrollbars",
        "--mute-audio",
    ]
    async with async_playwright() as pw:
        browser = await pw.chromium.launch(
            args=browser_args + [f"--remote-debugging-port=9222"],
            headless=False,
        )
        context = await browser.new_context()
        page = await context.new_page()
        await page.goto("https://example.com")
        html = await page.content()
        await browser.close()

    return {"html": html}

denismur changed the title ~~[Question]: xvfb-run + docker~~ [Question]: Missing X server or $DISPLAY error while running xvfb-run in docker May 18, 2022

mxschmitt transferred this issue from microsoft/playwright-python May 18, 2022

mxschmitt added the triaging label May 18, 2022

aslushnikov closed this as completed May 31, 2022

avaleske mentioned this issue Feb 2, 2023

Fix text bolding in browser screenshot tests civiform/civiform#3225

Closed

buddhikajay mentioned this issue Aug 4, 2024

Supporting Google Meet berstend/puppeteer-extra#334

Closed

Ayan-Bandyopadhyay mentioned this issue Sep 26, 2024

Xvfb-run not working with fastapi in python docker container microsoft/playwright-python#2572

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Question]: Missing X server or $DISPLAY error while running xvfb-run in docker #14250

[Question]: Missing X server or $DISPLAY error while running xvfb-run in docker #14250

denismur commented May 18, 2022 •

edited

Loading

SidduMirji commented May 18, 2022

mxschmitt commented May 18, 2022

denismur commented May 18, 2022

mxschmitt commented May 18, 2022

denismur commented May 18, 2022

mxschmitt commented May 18, 2022

denismur commented May 18, 2022 •

edited

Loading

mxschmitt commented May 19, 2022 •

edited

Loading

denismur commented May 20, 2022 •

edited

Loading

mxschmitt commented May 23, 2022

yury-s commented May 26, 2022

aslushnikov commented May 31, 2022

Ayan-Bandyopadhyay commented Sep 26, 2024

[Question]: Missing X server or $DISPLAY error while running xvfb-run in docker #14250

[Question]: Missing X server or $DISPLAY error while running xvfb-run in docker #14250

Comments

denismur commented May 18, 2022 • edited Loading

Your question

SidduMirji commented May 18, 2022

mxschmitt commented May 18, 2022

denismur commented May 18, 2022

mxschmitt commented May 18, 2022

denismur commented May 18, 2022

mxschmitt commented May 18, 2022

denismur commented May 18, 2022 • edited Loading

mxschmitt commented May 19, 2022 • edited Loading

denismur commented May 20, 2022 • edited Loading

mxschmitt commented May 23, 2022

yury-s commented May 26, 2022

aslushnikov commented May 31, 2022

Ayan-Bandyopadhyay commented Sep 26, 2024

denismur commented May 18, 2022 •

edited

Loading

denismur commented May 18, 2022 •

edited

Loading

mxschmitt commented May 19, 2022 •

edited

Loading

denismur commented May 20, 2022 •

edited

Loading