Skip to content

Commit 8d6ab1f

Browse files
committed
docs: restructure README with categorized Feature Reference tables, add CLI_FLAGS anchors
1 parent 95fa783 commit 8d6ab1f

2 files changed

Lines changed: 75 additions & 64 deletions

File tree

CLI_FLAGS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ This skips per-page IP lookups and speeds up navigation.
109109
- [Per-context proxy](PER_CONTEXT_FINGERPRINT.md) (ENT Tier1): set different proxies via `createBrowserContext({ proxy })`; BotBrowser auto-derives geo info in both cases
110110
- Avoid: framework-specific options like `page.authenticate()` that disable BotBrowser's geo-detection, which may leak location information
111111

112+
<a id="--proxy-bypass-rgx"></a>
112113
### `--proxy-bypass-rgx` (PRO)
113114
Define URL patterns via regular expressions for proxy routing control. Uses RE2 regex syntax. Matches against both hostname and full URL path (including HTTPS).
114115

@@ -189,6 +190,7 @@ Sets custom browser window title and taskbar/dock icon label.
189190
- Displays as a label next to the Refresh button
190191
- Useful for managing multiple instances
191192

193+
<a id="--bot-cookies"></a>
192194
### `--bot-cookies` (PRO)
193195
Session restoration and cookie management.
194196

@@ -206,6 +208,7 @@ Accepts cookie data as either inline JSON or from a file.
206208

207209
The file should contain a JSON array of cookie objects with name, value, and domain fields.
208210

211+
<a id="--bot-bookmarks"></a>
209212
### `--bot-bookmarks`
210213
Pre-populate bookmarks for session preservation.
211214

README.md

Lines changed: 72 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -112,18 +112,70 @@ Examples: [Playwright](examples/playwright/) • [Puppeteer](examples/puppeteer/
112112
- Docker: [docker/README.md](docker/)
113113
- Full flags: [CLI_FLAGS.md](CLI_FLAGS.md)
114114

115-
## Advanced Capabilities
116-
> **Professional-grade privacy technology** built on multi-layer fingerprint protection, network-stack control, and hardening.
117-
118-
- **Multi Layer Noise**: Canvas, WebGL, WebGPU, text, and AudioContext surfaces share deterministic, cross-worker noise with low-level [Skia and HarfBuzz tuning](ADVANCED_FEATURES.md#multi-layer-fingerprint-noise) so observers cannot correlate runs
119-
- **Per-Context Fingerprint**: [Independent fingerprint per BrowserContext](PER_CONTEXT_FINGERPRINT.md) without new processes, millisecond-level switching (ENT Tier3); clean execution contexts and console suppression (ENT Tier1) maintain isolation
120-
- **Configurable Stack**: 50+ CLI overrides, [per-context proxies](PER_CONTEXT_FINGERPRINT.md) (ENT Tier1) with auto geo, session tooling (cookies, bookmarks, title, history), and [plaintext storage access](examples/storage-access/) (PRO) make privacy scripting flexible
121-
- **Typography Fidelity**: DOM text renders from [embedded Windows and macOS font packs](ADVANCED_FEATURES.md#cross-platform-font-engine) (Android fonts require PRO) so host fonts never leak during cross-OS simulation
122-
- **Client Hints Lockstep**: DPR, device-memory, and [UA-CH headers match JavaScript-visible values](ADVANCED_FEATURES.md#browser-os-fingerprinting); custom User-Agent with full userAgentData control (ENT Tier3)
123-
- **Headless ↔ GUI Parity**: Identical GPU, WebGPU, and media signals [across browser modes](ADVANCED_FEATURES.md#headless-incognito-compatibility) so privacy regression tests remain stable
124-
- **Performance Controls** (ENT Tier2): Precision FPS, timing controls, and noise seeds for reproducible privacy benchmarks
125-
- **Focus & Session Control**: [Always-active tabs](ADVANCED_FEATURES.md#active-window-emulation), [configurable ICE presets](ADVANCED_FEATURES.md#webrtc-leak-protection), and expanded media reporting keep privacy sessions believable
126-
- **Network Enhancements**: [Per-context proxies](PER_CONTEXT_FINGERPRINT.md) (ENT Tier1), [dynamic proxy switching](ADVANCED_FEATURES.md#dynamic-proxy-switching) at runtime (ENT Tier2), [port protection](ADVANCED_FEATURES.md#port-protection) for local services (PRO), optional [local DNS solver](CLI_FLAGS.md#--bot-local-dns-ent-tier1) (ENT Tier1), [UDP-over-SOCKS5](CLI_FLAGS.md#udp-over-socks5-ent-tier3) (ENT Tier3), and SOCKS5H protocol support for [tunnel-based resolution](ADVANCED_FEATURES.md#network-fingerprint-control)
115+
## Feature Reference
116+
117+
> Configuration priority: [CLI flags](CLI_FLAGS.md) (highest) > [Profile configs](profiles/PROFILE_CONFIGS.md) > defaults. Timezone, locale, and language auto-derive from your proxy IP.
118+
119+
### Network & Proxy
120+
121+
| Feature | Reference |
122+
|---------|-----------|
123+
| Proxy with embedded credentials (HTTP/SOCKS5/SOCKS5H) | [Proxy Configuration](CLI_FLAGS.md#enhanced-proxy-configuration) |
124+
| Regex-based proxy routing rules | [--proxy-bypass-rgx](CLI_FLAGS.md#--proxy-bypass-rgx) |
125+
| Per-context proxy with auto geo-detection | [Per-Context Fingerprint](PER_CONTEXT_FINGERPRINT.md) |
126+
| Dynamic proxy switching at runtime | [Dynamic Proxy Switching](ADVANCED_FEATURES.md#dynamic-proxy-switching) |
127+
| UDP over SOCKS5 (QUIC/STUN tunneling) | [UDP over SOCKS5](CLI_FLAGS.md#udp-over-socks5-ent-tier3) |
128+
| Local DNS solver | [--bot-local-dns](CLI_FLAGS.md#--bot-local-dns-ent-tier1) |
129+
| Port protection for local services | [--bot-port-protection](CLI_FLAGS.md#--bot-port-protection-pro) |
130+
| WebRTC leak protection (SDP/ICE control) | [WebRTC Leak Protection](ADVANCED_FEATURES.md#webrtc-leak-protection) |
131+
132+
### Fingerprint & Rendering
133+
134+
| Feature | Reference |
135+
|---------|-----------|
136+
| Canvas / WebGL / WebGPU deterministic noise | [Multi-Layer Noise](ADVANCED_FEATURES.md#multi-layer-fingerprint-noise) |
137+
| AudioContext noise calibration | [Multi-Layer Noise](ADVANCED_FEATURES.md#multi-layer-fingerprint-noise) |
138+
| Text metrics & ClientRects noise | [Multi-Layer Noise](ADVANCED_FEATURES.md#multi-layer-fingerprint-noise) |
139+
| Deterministic noise seeds (reproducible per-tenant) | [--bot-noise-seed](CLI_FLAGS.md#behavior--protection-toggles) |
140+
| Cross-platform font engine (Win/Mac/Android) | [Font Engine](ADVANCED_FEATURES.md#cross-platform-font-engine) |
141+
| GPU simulation on headless servers | [Headless Compatibility](ADVANCED_FEATURES.md#headless-incognito-compatibility) |
142+
143+
### Identity & Platform
144+
145+
| Feature | Reference |
146+
|---------|-----------|
147+
| Cross-platform profile portability (Win / Mac / Linux) | [Advanced Features](ADVANCED_FEATURES.md) |
148+
| Browser brand switching (Chrome/Edge/Brave/Opera) | [Profile Overrides](CLI_FLAGS.md#profile-configuration-override-flags) |
149+
| Custom User-Agent with full userAgentData control | [Profile Overrides](CLI_FLAGS.md#profile-configuration-override-flags) |
150+
| Client Hints alignment (DPR, device-memory, UA-CH) | [Browser & OS](ADVANCED_FEATURES.md#browser-os-fingerprinting) |
151+
| Android WebView emulation | [Profile Overrides](CLI_FLAGS.md#profile-configuration-override-flags) |
152+
| Chrome behavior emulation (HTTP/2, HTTP/3, headers) | [Chrome Behavior](ADVANCED_FEATURES.md#chrome-behavior-emulation) |
153+
154+
### Automation & Scripting
155+
156+
| Feature | Reference |
157+
|---------|-----------|
158+
| Playwright / Puppeteer integration | [Examples](examples/) |
159+
| Framework-less bot-script (chrome.debugger API) | [--bot-script](CLI_FLAGS.md#--bot-script) |
160+
| Per-context fingerprint (multiple profiles per process) | [Per-Context Fingerprint](PER_CONTEXT_FINGERPRINT.md) |
161+
| Console message suppression | [Behavior Toggles](CLI_FLAGS.md#behavior--protection-toggles) |
162+
| Headless / GUI parity | [Headless Compatibility](ADVANCED_FEATURES.md#headless-incognito-compatibility) |
163+
| Mirror: distributed privacy consistency | [Mirror Documentation](tools/mirror/) |
164+
| CanvasLab: Canvas 2D API recorder | [--bot-canvas-record-file](CLI_FLAGS.md#--bot-canvas-record-file) |
165+
166+
### Session & Behavior
167+
168+
| Feature | Reference |
169+
|---------|-----------|
170+
| Cookie management (inline JSON or file) | [--bot-cookies](CLI_FLAGS.md#--bot-cookies) |
171+
| Bookmark injection | [--bot-bookmarks](CLI_FLAGS.md#--bot-bookmarks) |
172+
| Random history injection | [Behavior Toggles](CLI_FLAGS.md#behavior--protection-toggles) |
173+
| Always-active windows (anti-focus-tracking) | [Active Window](ADVANCED_FEATURES.md#active-window-emulation) |
174+
| Custom HTTP headers (CLI + CDP) | [--bot-custom-headers](CLI_FLAGS.md#--bot-custom-headers-pro) |
175+
| Plaintext storage access (cookies, localStorage) | [Storage Access](examples/storage-access/) |
176+
| Precision FPS simulation | [Behavior Toggles](CLI_FLAGS.md#behavior--protection-toggles) |
177+
| Timing scale (performance.now compression) | [Behavior Toggles](CLI_FLAGS.md#behavior--protection-toggles) |
178+
| Window/screen dimension control | [Profile Overrides](CLI_FLAGS.md#profile-configuration-override-flags) |
127179

128180
<details>
129181
<summary><strong>Fingerprint Protection Implementation: Privacy Controls → Technical Design → Validation</strong></summary>
@@ -162,25 +214,10 @@ This reference maps privacy protection goals to BotBrowser implementation detail
162214
</details>
163215

164216

165-
**[Complete Advanced Features Documentation ](ADVANCED_FEATURES.md)**
217+
**[Advanced Features (architecture & design) ](ADVANCED_FEATURES.md)** | **[CLI Flags (all options) →](CLI_FLAGS.md)**
166218

167219

168220

169-
---
170-
171-
## Configuration & Profiles
172-
173-
> BotBrowser combines synthetic and aggregated profiles with flexible configuration for authorized privacy research. Profile protection and CLI settings enable comparative analysis without leaking host traits.
174-
175-
- **Profile Foundation:** Synthetic and aggregated profiles provide realistic fingerprint data for authorized privacy testing
176-
- **CLI Flexibility:** Override profile settings at runtime without modifying encrypted files
177-
- **Cross-Platform Compatibility:** A *macOS profile* works on Ubuntu; a *Windows profile* works on macOS; an *Android profile* can be fully emulated on any OS
178-
- **Smart Configuration:** Timezone, locale, and languages intelligently derived from IP/proxy
179-
- **CLI Flags:** See the [CLI Flags Reference](CLI_FLAGS.md) - *Recommended for most users*
180-
181-
182-
> ⚠️ Note: This project must only be used in environments you own or where you have explicit authorization. Use against third-party services without permission is strictly prohibited and undermines the privacy mission.
183-
184221
---
185222

186223
## BotBrowserLauncher (GUI Tool)
@@ -189,23 +226,9 @@ Prefer a GUI launcher? See [launcher/README.md](launcher) for BotBrowserLauncher
189226

190227
---
191228

192-
## Mirror: Distributed Privacy Consistency (ENT Tier3)
193-
194-
Ensure your privacy protection works effectively across platforms and networks. Run a controller instance and multiple client instances to verify that all instances maintain identical privacy defenses, protecting you from tracking across Windows, macOS, Linux, and remote environments.
195-
196-
Launch with CLI flags: [`--bot-mirror-controller-endpoint`](CLI_FLAGS.md#mirror-distributed-privacy-consistency)`=127.0.0.1:9990` on the controller, [`--bot-mirror-client-endpoint`](CLI_FLAGS.md#mirror-distributed-privacy-consistency)`=127.0.0.1:9990` on each client. Runtime activation via CDP is also supported for programmatic control.
197-
198-
See [Mirror documentation](tools/mirror/) for detailed setup, testing procedures, and troubleshooting.
199-
200-
---
201-
202229
## Fingerprint Protection Validation
203230

204-
### Validation Methodology
205-
206-
Our fingerprint protection validation examines how standardized browser fingerprints prevent tracking systems from collecting tracking data to identify users across platforms. By maintaining identical fingerprints across operating systems, we demonstrate how privacy protection prevents the tracking methods that malicious observers rely on.
207-
208-
> ⚠️ Research validation uses authorized test environments. See [DISCLAIMER](DISCLAIMER.md).
231+
Fingerprint protection validated across 31+ tracking scenarios. See [DISCLAIMER](DISCLAIMER.md) for authorized use.
209232

210233
<table cellspacing="0" cellpadding="8">
211234
<tr>
@@ -233,34 +256,19 @@ Our fingerprint protection validation examines how standardized browser fingerpr
233256
- **Android Emulation on Desktop (PRO):** Mobile API parity enables fingerprint testing for cross-device privacy research
234257
- **Headless vs GUI Mode:** Identical fingerprint behavior ensures privacy validation results remain effective across execution contexts
235258

236-
**[Complete Validation Results & Research Data →](VALIDATION.md)** - 31+ tracking analysis scenarios, 15+ tracking methodologies, statistical analysis
259+
**[Complete Validation Results & Research Data →](VALIDATION.md)**
237260

238261
---
239262

240263
## Resources & Support
241264

242265
### Documentation
243266

244-
| Document | Description | Content Preview |
245-
|----------|-------------|-----------------|
246-
| [Installation Guide](INSTALLATION.md) | Platform-specific setup | Windows/macOS guides, Ubuntu (ENT Tier1), Docker deployment, troubleshooting |
247-
| [Advanced Features](ADVANCED_FEATURES.md) | Technical capabilities | 50+ CLI flags, privacy noise augmentation, GPU micro-benchmarks |
248-
| [Validation Results](VALIDATION.md) | Research data | 31+ tracking observatories, 50,000+ test sessions, statistical analysis |
249-
| [CLI Flags Reference](CLI_FLAGS.md) | Command-line options | `--bot-*` flags, proxy auth, session management |
250-
| [Profile Configuration](profiles/PROFILE_CONFIGS.md) | Profile customization | Fingerprint control, cross-platform compatibility |
251-
| [Mirror](tools/mirror/) | Distributed privacy consistency | Verify privacy protection across multiple browser instances simultaneously |
252-
| [CanvasLab](tools/canvaslab/) | Canvas forensics tool | Canvas 2D recording with JSONL viewer (deterministic replay under development) |
253-
| [Examples](examples/) | Code samples | Playwright, Puppeteer, bot-script integration |
254-
255-
### Quick Access
256-
257-
**Framework Integration:**
258-
- [Playwright Examples](examples/playwright/) - TypeScript/Python integration
259-
- [Puppeteer Examples](examples/puppeteer/) - JavaScript scripting
260-
- [Bot-Script Examples](examples/bot-script/) - Framework-less `chrome.debugger` API
261-
262-
**Profile Management:**
263-
- Demo profiles available in [profiles/](profiles/) directory
267+
- [Installation Guide](INSTALLATION.md) - Platform-specific setup, Docker deployment, troubleshooting
268+
- [Advanced Features](ADVANCED_FEATURES.md) - Architecture and design details
269+
- [CLI Flags Reference](CLI_FLAGS.md) - Core and extended runtime flags with examples
270+
- [Profile Configuration](profiles/PROFILE_CONFIGS.md) - Profile JSON field reference
271+
- [Validation Results](VALIDATION.md) - Research data across 31+ tracking scenarios
264272

265273
### Support Channels
266274

0 commit comments

Comments
 (0)