Skip to content

Commit 907490e

Browse files
Merge pull request #852 from lightpanda-io/katie-lpd-patch-1
Update README.md
2 parents 300428d + 80fe167 commit 907490e

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Lightpanda is the open-source browser made for headless usage:
1818

1919
- Javascript execution
2020
- Support of Web APIs (partial, WIP)
21-
- Compatible with Playwright[^1], Puppeteer through CDP (WIP)
21+
- Compatible with Playwright[^1], Puppeteer, chromedp through CDP
2222

2323
Fast web automation for AI agents, LLM training, scraping and testing:
2424

@@ -41,7 +41,8 @@ Due to the nature of Playwright, a script that works with the current version of
4141

4242
## Quick start
4343

44-
### Install from the nightly builds
44+
### Install
45+
**Install from the nightly builds**
4546

4647
You can download the last binary from the [nightly
4748
builds](https://github.com/lightpanda-io/browser/releases/tag/nightly) for
@@ -64,6 +65,17 @@ chmod a+x ./lightpanda
6465
The Lightpanda browser is compatible to run on windows inside WSL. Follow the Linux instruction for installation from a WSL terminal.
6566
It is recommended to install clients like Puppeteer on the Windows host.
6667

68+
**Install from Docker**
69+
70+
Lightpanda provides [official Docker
71+
images](https://hub.docker.com/r/lightpanda/browser) for both Linux amd64 and
72+
arm64 architectures.
73+
The following command fetches the Docker image and starts a new container exposing Lightpanda's CDP server on port `9222`.
74+
The `--privileged` option is required because the browser requires `io_uring` syscalls which are blocked by default by Docker.
75+
```console
76+
docker run -d --name lightpanda -p 9222:9222 --privileged lightpanda/browser:nightly
77+
```
78+
6779
### Dump a URL
6880

6981
```console
@@ -124,21 +136,27 @@ By default, Lightpanda collects and sends usage telemetry. This can be disabled
124136

125137
## Status
126138

127-
Lightpanda is still a work in progress and is currently at a Beta stage.
128-
129-
:warning: You should expect most websites to fail or crash.
139+
Lightpanda is in Beta and currently a work in progress. Stability and coverage are improving and many websites now work.
140+
You may still encounter errors or crashes. Please open an issue with specifics if so.
130141

131142
Here are the key features we have implemented:
132143

144+
- [x] HTTP loader
133145
- [x] HTTP loader
134146
- [x] HTML parser and DOM tree (based on Netsurf libs)
135147
- [x] Javascript support (v8)
136-
- [x] Basic DOM APIs
148+
- [x] DOM APIs
137149
- [x] Ajax
138150
- [x] XHR API
139-
- [x] Fetch API
151+
- [x] Fetch API (polyfill)
140152
- [x] DOM dump
141-
- [x] Basic CDP/websockets server
153+
- [x] CDP/websockets server
154+
- [x] Click
155+
- [x] Input form
156+
- [x] Cookies
157+
- [x] Custom HTTP headers
158+
- [ ] Proxy support
159+
- [ ] Network interception
142160

143161
NOTE: There are hundreds of Web APIs. Developing a browser (even just for headless mode) is a huge task. Coverage will increase over time.
144162

0 commit comments

Comments
 (0)