Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

BotBrowser Guides

Configuration, deployment, and verification guides. Each guide includes prerequisites, examples, and troubleshooting.


Reference

Guide Description
CLI Flag Directory Find every documented flag by task, availability, and primary guide.
Advanced Features Browse capabilities by subsystem, then open the related flag or setup guide.

Getting Started

Guide Description
Playwright Integrate BotBrowser with Playwright for stable fingerprint behavior and automation-safe launches.
Puppeteer Integrate BotBrowser with Puppeteer for consistent fingerprint control in automation workflows.
Bot Script Automate BotBrowser without Playwright or Puppeteer using --bot-script and Chrome Debugger APIs.
CLI Recipes Use copy-paste CLI recipes for proxy, fingerprint, identity, and deployment scenarios.
Profile Management Manage profile files, versions, and lifecycle for reproducible browser identity.
First Verification Validate fingerprint consistency with CreepJS and BrowserLeaks.
Automation Consistency Practices Reduce framework-related inconsistency signals in Playwright/Puppeteer workflows.
CanvasLab Record Canvas 2D, WebGL, and WebGL2 API calls to study graphics signal collection and verify fingerprint protection.
AudioLab Record Web Audio API calls to study audio fingerprint collection and verify audio privacy protection.
V8Log Forensics Review browser-runtime calls, arguments, and return previews for authorized privacy validation.

Network and Proxy

Guide Description
Proxy Configuration Configure HTTP/SOCKS proxy routing for stable browser identity and network privacy.
Proxy and Geolocation Align proxy IP, timezone, locale, and language for consistent geolocation signals.
Dynamic Proxy Switching Switch proxies at runtime per BrowserContext without restarting sessions.
WebRTC Leak Prevention Prevent WebRTC IP leaks by controlling ICE behavior and candidate exposure.
DNS Leak Prevention Prevent DNS leaks by controlling local vs proxy-path resolution behavior.
Custom HTTP Headers Configure custom request headers for all outgoing browser traffic.
Port Protection Block remote pages from scanning localhost and internal service ports.
UDP over SOCKS5 Route QUIC/STUN UDP traffic through SOCKS5 for consistent network identity.
PAC-Like Request Callback Use trusted PAC scripts for authenticated routing, URL-specific proxy policy, capture, and controlled synthetic responses.
Per-Context Proxy Assign different proxies to different contexts for multi-identity automation.
Proxy Selective Routing Control selective proxy routing with regex-based direct/proxied paths.
GeoIP Database Map proxy IPs to consistent timezone, locale, and language settings.

Fingerprint Protection

Guide Description
Browser Fingerprinting Explained Learn core fingerprinting techniques and how BotBrowser keeps browser signals consistent.
Canvas Fingerprinting Control Canvas readback behavior and noise for consistent, privacy-protective output.
WebGL Fingerprinting Manage GPU-exposed WebGL parameters and rendering output consistency.
Font Fingerprinting Control font availability and text metrics for cross-platform consistency.
CSS Signal Consistency Reduce CSS media-query and feature-detection fingerprint leakage.
Audio Fingerprinting Manage AudioContext-derived fingerprint signals with consistent behavior.
Performance Fingerprinting Control timing-based fingerprint signals across browser performance APIs.
Navigator Properties Keep navigator properties aligned across pages, workers, and headers.
Permission State Consistency Keep permission queries and browser-side permission decisions aligned with the active profile and BrowserContext.
Screen and Window Fingerprinting Normalize screen/window metrics to avoid display-identity mismatches.
Speech Synthesis Fingerprinting Control speech voice lists and TTS metadata exposure.
MIME and Codec Fingerprinting Configure MIME/codec capability surfaces to match target identity.
Noise Seed Reproducibility Use deterministic noise seeds for repeatable fingerprint behavior.
DRM Fingerprinting Keep DRM/EME capability responses consistent with platform identity.
Stack Depth Fingerprinting Control recursive stack-depth signals across JS execution contexts.
FPS Control Tune display frame-rate behavior and video playback cadence for timing consistency and media workload control.
Storage Quota Fingerprinting Control storage and memory quota surfaces, including runtime policy overrides.
Incognito Fingerprinting Keep fingerprint surfaces consistent between regular and private browsing sessions.
Console Suppression Suppress CDP-forwarded console artifacts that can affect runtime consistency checks.
Active Window Emulation Prevent focus-based tracking by keeping windows in an always-active state.
WebGPU Fingerprint Protection Control WebGPU adapter information and rendering behavior across platforms.
Media Devices Privacy Control device enumeration to return consistent audio/video device lists.
CPU Core Scaling Protection Constrain Worker parallelism to match the profile's claimed core count.

Identity and Session

Guide Description
Multi-Account Isolation Run multi-account browser isolation with per-context fingerprints and reduced cross-account linkability.
Browser Brand Alignment Present as Chrome, Edge, Brave, Opera, or WebView with consistent UA-CH metadata.
Custom User-Agent Configure User-Agent and Client Hints with internally consistent browser identity.
Timezone, Locale, and Language Configure timezone, locale, and language for consistent geographic identity APIs.
Cookie Management Inject, persist, and restore cookies for pre-authenticated session state.
Bookmark Seeding Inject realistic bookmarks to strengthen cross-session browser state consistency.
History Seeding Inject browsing history to reduce fresh-profile and empty-state signals.
Plaintext Storage Access Read cookies, passwords, and LocalStorage directly from disk after a session.

Platform Emulation

Guide Description
Cross-Platform Profiles Run the same profile across Windows, macOS, and Linux with consistent output.
Android Emulation Emulate Android browser identity on desktop with mobile API behavior.
Android WebView Configure Android WebView identity for in-app browser simulation.
WebKit-family Profile Consistency Use premium WebKit-family profiles for runtime, network, and protocol consistency.
Windows on Mac/Linux Use Windows-target profiles while running on macOS or Linux hosts.
CJK Font Rendering Keep Chinese/Japanese/Korean font rendering consistent across hosts.
Widevine DRM Setup Set up Widevine/CDM compatibility for DRM playback workflows.
Device Emulation Configure device models and metrics with matching hardware signals.

Deployment and Operations

Guide Description
Headless Server Setup Set up headless Ubuntu servers for stable production BotBrowser automation.
Docker Deployment Deploy BotBrowser in Docker for reproducible, isolated automation environments.
Linux GPU Backend Selection Choose the right Linux software rendering backend to keep WebGL1/WebGL2/WebGPU available with stable performance.
Performance Optimization Tune startup speed, memory usage, and throughput for high-scale workloads. Includes guidance on when to choose Trimmed Build (ENT Tier3) for short-session automation (-62% wall time, -85% per-context creation on Linux x64).
Screenshot Best Practices Capture stable screenshots across headless and headful environments.
Mirror Distributed Run distributed sessions with synchronized actions and consistent fingerprint output.

Related documentation: Installation | CLI Flags Reference | Profile Configuration | Validation


Legal Disclaimer & Terms of UseResponsible Use Guidelines. BotBrowser is for authorized fingerprint protection and privacy research only.