Metadata-Version: 2.4
Name: changedetection.io-cloak-browser
Version: 0.1.1
Summary: CloakBrowser stealth fetcher plugin for changedetection.io.
Home-page: https://github.com/dgtlmoon/changedetection.io-cloak-browser
Author: dgtlmoon
Author-email: dgtlmoon@gmail.com
Keywords: changedetection web monitoring anti-bot stealth chromium cloakbrowser cloudflare bypass
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Security
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: changedetection.io>=0.54.6
Requires-Dist: cloakbrowser>=0.3.0
Requires-Dist: playwright>=1.40.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# changedetection.io-cloak-browser

Stealth browser fetcher plugin for [changedetection.io](https://github.com/dgtlmoon/changedetection.io) powered by [CloakBrowser](https://github.com/CloakHQ/CloakBrowser).

- ✅ Bypasses **Cloudflare Turnstile**, reCAPTCHA v3, FingerprintJS, BrowserScan and more
- ✅ 33 source-level C++ patches compiled into Chromium — no JS injection tricks
- ✅ Full **browser steps** support (same Playwright page API)
- ✅ Full **screenshot** and **visual selector** support
- ✅ Drop-in replacement — select "CloakBrowser" per-watch in the UI
- ✅ Proxy support with optional geo-IP auto-detection
- ✅ Human-like behaviour mode to avoid timing-based detection

## Requirements

- changedetection.io >= 0.54.5
- Python 3.10+
- ~200 MB disk space for the CloakBrowser Chromium binary (downloaded automatically on first run)

***NOTE: - The biggest red-flag is still your IP address "quality", always use a high quality 'residential IP address' through a SOCKS style proxy - When you sign up using https://brightdata.grsm.io/n0r16zf7eivq BrightData will match any first deposit up to $150 .***

***Cloak Browser works by downloading a pre-compiled binary chrome-browser from CloakHQ, remember, you are running a black-box piece of software that you do not know what's inside of it.***

## Quick Start

### 1. Install the plugin

**Docker (docker-compose.yml):**

```yaml
services:
  changedetection:
    environment:
      - EXTRA_PACKAGES=changedetection.io-cloak-browser
```

**Local install:**

```bash
pip install changedetection.io-cloak-browser
# Download the Chromium binary
python -m cloakbrowser install
```

### 2. Select CloakBrowser for a watch

In the changedetection.io UI, open any watch → **Edit** → **Fetch** tab → choose
**"CloakBrowser - Stealth Chromium (anti-bot bypass)"** from the fetcher dropdown.

### 3. (Optional) Configure via environment variables

| Variable | Default | Description |
|---|---|---|
| `CLOAKBROWSER_HUMANIZE` | `true` | Enable human-like mouse/keyboard/scroll behaviour |
| `playwright_proxy_server` | *(none)* | Proxy URL, e.g. `http://proxy:8080` |
| `playwright_proxy_username` | *(none)* | Proxy username |
| `playwright_proxy_password` | *(none)* | Proxy password |
| `PLAYWRIGHT_SERVICE_WORKERS` | `allow` | `allow` or `block` service workers |
| `WEBDRIVER_DELAY_BEFORE_CONTENT_READY` | `5` | Seconds to wait after page load |
| `SCREENSHOT_MAX_HEIGHT` | `20000` | Maximum screenshot height in pixels |

## Docker Compose Example

```yaml
version: '3'

services:
  changedetection:
    image: ghcr.io/dgtlmoon/changedetection.io:latest
    container_name: changedetection
    volumes:
      - ./datastore:/datastore
    environment:
      - EXTRA_PACKAGES=changedetection.io-cloak-browser
      - CLOAKBROWSER_HUMANIZE=true
      # Optional proxy
      # - playwright_proxy_server=http://proxy.example.com:8080
      # - playwright_proxy_username=user
      # - playwright_proxy_password=pass
    ports:
      - "5000:5000"
    restart: unless-stopped
```

## How It Works

CloakBrowser is a patched Chromium binary with 33 source-level C++ modifications that
make it indistinguishable from a real user's Chrome browser. Unlike JavaScript-injection
approaches (which detection services can identify), these patches operate at the binary level.

The Python `cloakbrowser` package wraps the Playwright Python library but connects to the
patched binary instead of stock Chromium. This means **the page API is 100% identical to
Playwright** — browser steps, screenshots, visual selectors, and JS execution all work
unchanged.

### Detection bypass results

| Service | Stock Playwright | CloakBrowser |
|---|---|---|
| reCAPTCHA v3 score | 0.1 (bot) | **0.9** (human) |
| Cloudflare Turnstile | FAIL | **PASS** |
| FingerprintJS | DETECTED | **PASS** |
| BrowserScan | DETECTED | **NORMAL** |
| `navigator.webdriver` | `true` | **`false`** |
| TLS fingerprint | Mismatch | **Identical to Chrome** |

## Browser Steps

CloakBrowser fully supports all changedetection.io browser steps:

- Click element / Click element if exists
- Enter text in field
- Execute JS
- Wait for text / Wait for seconds
- Scroll down
- Check/uncheck checkbox
- Select by label
- Remove elements
- … and all others

This works because CloakBrowser pages are standard Playwright page objects — the browser
steps engine requires no modification.

## Troubleshooting

**Plugin not loading?**
```python
from changedetectionio.pluggy_interface import plugin_manager
print([name for name, _ in plugin_manager.list_name_plugin()])
# Should include: cloak_browser
```

**Binary not downloaded?**
```bash
python -m cloakbrowser install
python -m cloakbrowser info
```

**Test that the fetcher registers:**
```python
from changedetectionio.content_fetchers import available_fetchers
print(available_fetchers())
# Should include: ('html_cloakbrowser', 'CloakBrowser - Stealth Chromium (anti-bot bypass)')
```

**Check for CloakBrowser updates:**
```bash
python -m cloakbrowser update
```

## License

MIT License — see [LICENSE](LICENSE).

CloakBrowser binary: free-to-use, no redistribution. See
[CloakBrowser BINARY-LICENSE](https://github.com/CloakHQ/CloakBrowser/blob/main/BINARY-LICENSE.md).
