From 8956ab85f9735cb00a55ce00b5d96b11d25546ed Mon Sep 17 00:00:00 2001 From: katie-lpd Date: Mon, 7 Jul 2025 16:50:32 -0700 Subject: [PATCH 1/3] Update README.md --- README.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 54b2d68c..24a4c9f5 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Lightpanda is the open-source browser made for headless usage: - Javascript execution - Support of Web APIs (partial, WIP) -- Compatible with Playwright[^1], Puppeteer through CDP (WIP) +- Compatible with Playwright[^1], Puppeteer, chromedp through CDP Fast web automation for AI agents, LLM training, scraping and testing: @@ -41,7 +41,8 @@ Due to the nature of Playwright, a script that works with the current version of ## Quick start -### Install from the nightly builds +### Install +**Install from the nightly builds** You can download the last binary from the [nightly builds](https://github.com/lightpanda-io/browser/releases/tag/nightly) for @@ -64,6 +65,16 @@ chmod a+x ./lightpanda The Lightpanda browser is compatible to run on windows inside WSL. Follow the Linux instruction for installation from a WSL terminal. It is recommended to install clients like Puppeteer on the Windows host. +**Install from Docker** +Lightpanda provides [official Docker +images](https://hub.docker.com/r/lightpanda/browser) for both Linux amd64 and +arm64 architectures. +The following command fetches the Docker image and starts a new container exposing Lightpanda's CDP server on port `9222`. +The `--privileged` option is required because the browser requires `io_uring` syscalls which are blocked by default by Docker. +```sh copy +$ docker run -d --name lightpanda -p 9222:9222 --privileged lightpanda/browser:nightly +``` + ### Dump a URL ```console @@ -124,21 +135,26 @@ By default, Lightpanda collects and sends usage telemetry. This can be disabled ## Status -Lightpanda is still a work in progress and is currently at a Beta stage. - -:warning: You should expect most websites to fail or crash. +Lightpanda is in Beta and currently a work in progress. Stability and coverage are improving and many websites now work. +You may still encounter errors or crashes. Please open an issue with specifics if so. Here are the key features we have implemented: - [x] HTTP loader +- [x] HTTP headers - [x] HTML parser and DOM tree (based on Netsurf libs) - [x] Javascript support (v8) -- [x] Basic DOM APIs +- [x] DOM APIs - [x] Ajax - [x] XHR API - - [x] Fetch API + - [x] Fetch API (polyfill) - [x] DOM dump -- [x] Basic CDP/websockets server +- [x] CDP/websockets server +- [x] Click +- [x] Input form +- [x] Cookies +- [ ] Proxy support +- [ ] Network interception NOTE: There are hundreds of Web APIs. Developing a browser (even just for headless mode) is a huge task. Coverage will increase over time. From d30631f99182b0513f7fefbdb9a7f92066964024 Mon Sep 17 00:00:00 2001 From: katie-lpd Date: Mon, 7 Jul 2025 16:59:07 -0700 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Pierre Tachoire --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 24a4c9f5..4842a919 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ The Lightpanda browser is compatible to run on windows inside WSL. Follow the Li It is recommended to install clients like Puppeteer on the Windows host. **Install from Docker** + Lightpanda provides [official Docker images](https://hub.docker.com/r/lightpanda/browser) for both Linux amd64 and arm64 architectures. @@ -141,7 +142,7 @@ You may still encounter errors or crashes. Please open an issue with specifics i Here are the key features we have implemented: - [x] HTTP loader -- [x] HTTP headers +- [x] HTTP loader - [x] HTML parser and DOM tree (based on Netsurf libs) - [x] Javascript support (v8) - [x] DOM APIs @@ -153,6 +154,7 @@ Here are the key features we have implemented: - [x] Click - [x] Input form - [x] Cookies +- [x] Custom HTTP headers - [ ] Proxy support - [ ] Network interception From 80fe167646def80be16f965ba6c7436f0151231b Mon Sep 17 00:00:00 2001 From: Pierre Tachoire Date: Mon, 7 Jul 2025 17:00:54 -0700 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4842a919..8c3ecc9e 100644 --- a/README.md +++ b/README.md @@ -72,8 +72,8 @@ images](https://hub.docker.com/r/lightpanda/browser) for both Linux amd64 and arm64 architectures. The following command fetches the Docker image and starts a new container exposing Lightpanda's CDP server on port `9222`. The `--privileged` option is required because the browser requires `io_uring` syscalls which are blocked by default by Docker. -```sh copy -$ docker run -d --name lightpanda -p 9222:9222 --privileged lightpanda/browser:nightly +```console +docker run -d --name lightpanda -p 9222:9222 --privileged lightpanda/browser:nightly ``` ### Dump a URL