📋 Table of Contents
🚀 Get Started in Seconds!
Get up and running in three simple steps:
Step 1: Run the Docker image
docker run -p 3000:3000 ghcr.io/browserless/chromium
Step 2: Open the docs in your browser
Visit http://localhost:3000/docs
✅ Success! Your browser service is live at ws://localhost:3000
Step 3: Connect your script with Puppeteer or Playwright
import puppeteer from 'puppeteer-core';
const browser = await puppeteer.connect({
browserWSEndpoint: 'ws://localhost:3000',
});
const page = await browser.newPage();
await page.goto('https://example.com');
console.log(await page.title());
await browser.close();
import pw from 'playwright-core';
const browser = await pw.firefox.connect(
'ws://localhost:3000/firefox/playwright',
);
const page = await browser.newPage();
await page.goto('https://example.com');
console.log(await page.title());
await browser.close();
Note: Use ghcr.io/browserless/firefox or ghcr.io/browserless/multi for Firefox/Webkit support.
Output:
Example Domain
✨ Features
General Features
- Parallelism and queueing — Handle multiple sessions with configurable concurrency limits
- Debug Viewer — Actively view and debug running browser sessions in real-time
- Unforked libraries — Works seamlessly with standard Puppeteer and Playwright
- Fonts & emoji — All system fonts and emoji support out-of-the-box
- Configurable timeouts — Set session timers and health-checks to keep things running smoothly
- Error tolerant — If Chrome crashes, Browserless won't
- ARM64 architecture support — Full support for ARM64 platforms including Apple Silicon; some browsers (Edge, Chrome) have limited ARM64 compatibility
Premium Features
Our Self-serve cloud and Enterprise offerings include all the general features plus extras, such as:
- BrowserQL for avoiding detectors and solving captchas
- Hybrid automations for streaming live browser sessions during scripts
- Persistent Sessions for persisting browser state (cookies, cache, localStorage) across multiple sessions with configurable data retention up to 90 days
- Session Replay for recording and debugging browser sessions with event capture and video playback
- Chrome Extensions Support for loading custom extensions including ad blockers, captcha solvers, etc.
- Advanced Captcha/Stealth Routes for enhanced anti-detection with Captcha solving, fingerprint randomization, and residential proxy rotation
- REST APIs for tasks such as retrieving HTML, PDFs or Screenshot etc.
- Inbuilt residential proxy for automatic IP rotation and geo-targeting with residential proxy networks
- /smart-scrape API for intelligently scraping any URL using cascading strategies (HTTP fetch, proxy, headless browser, captcha solving)
- /crawl API for asynchronously crawling entire websites and scraping every discovered page into structured, LLM-ready data
🚢 Customisable Deployment Options
Select the deployment model that best fits your needs:
🔓 Open Source (Self-Hosted)
Free, self-hosted solution with core browser automation capabilities.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
