mirror of
https://github.com/daijro/camoufox.git
synced 2026-11-19 00:07:28 +00:00
* Let a launch leave Web Audio output unmodified The launchers seed Web Audio noise per identity so a returning identity reproduces its audio hash. A caller who wanted stock audio output had to pass audio:seed in config, and NewContext contexts still drew their own seed. audio_noise (default True, as before) set to False sends seed 0, which audio-fingerprint-manager.patch reads as no noise, and NewBrowser records it so NewContext gives its contexts seed 0 as well. An audio:seed the caller sets wins either way. Python and TypeScript take the option the same way, the launch goldens gain an audio_noise_false scenario, and both package READMEs list it. On v158.0-beta.40 an OfflineAudioContext probe renders the same with audio_noise=False across launches, in the page and in a NewContext, and matches a launch with audio:seed 0; default launches differ. Split out of #890, without its gpu_passthrough option. Co-Authored-By: coffeegrind123 <103264516+coffeegrind123@users.noreply.github.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Let a context turn its Web Audio noise off A context without an audio seed of its own takes the launch's audio:seed, so a per-context seed of 0 means "the launch's seed", not "no noise". On a browser launched with noise, no context could render stock audio. setAudioFingerprintNoise(false) stores that choice for the calling context, and AudioFingerprintManager::GetSeed returns 0 for it whatever the launch seed. The setter has its own gate and is sealed with the others; the build tester and the setter-seal guard list it. The context-audio-off guard renders an OfflineAudioContext with the noise off at launch as the reference, then on a noised launch requires a context that called the setter to match it, also after a navigation, while a plain context and a NewContext context stay noised. It fails on v158.0-beta.40, which has no such setter. Both patches were regenerated from a tree of the files the series touches, and the whole series applies to vanilla 158 without fuzz. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Replace audio_noise with fingerprint_options The launchers take one option for the noise Camoufox adds on top of an identity, in Python and TypeScript alike: fingerprint_options={"audio": {"noise": False}} # stock Web Audio fingerprint_options={"audio": {"seed": 1000433}} # fixed audio seed fingerprint_options={"canvas": {"randomize": True}} Without an audio entry the seed still follows the identity; without a canvas entry randomization is still on for another OS or GPU. Any other surface or key raises InvalidFingerprintOptions, naming the tribal rules that keep canvas pixels and glyph spacing unnoised, as do a seed outside 1 to 2**32-1 and noise off together with a seed. fingerprint= stays the fpgen identity. canvas_noise= and config={"audio:seed": N} keep working with a FutureWarning, as a deprecated GeoIP source does; either one together with the matching fingerprint_options entry raises. NewContext takes the audio entry per context. Without one a context follows the browser, read from the audio:seed the launch sent, so launch_options() and from_options launches behave the same: no noise if the launch sent 0, otherwise a fresh seed of its own. A context never takes the browser's seed, fixed or not, since two devices sharing an audio hash are linked; a per-context seed reproduces a context instead. A context with its noise off calls setAudioFingerprintNoise(false). On a noised browser that needs a build with the setter: NewContext asks the browser once, from an init script in a throwaway context, and raises on an older build rather than leave the context noised. canvas in a context raises: randomization belongs to the browser. audio_noise, context_audio(browser) and _camoufox_audio_noise are gone. The launch goldens replace audio_noise_false with audio and canvas scenarios, the init-script golden gains a seed-0 case, and the READMEs, AGENTS.md and docs/per-context-patches.md describe the option; repo callers of canvas_noise use the new form. On v158.0-beta.40, an OfflineAudioContext probe renders the same with {"audio": {"noise": False}} in the page, in a NewContext and with config audio:seed 0; default launches differ; seed 1000433 and a context seed reproduce across launches; a context turning its noise off on a noised browser raises. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Audio renders as stock: remove the noise, the seed and fingerprint_options Stock Firefox has one audio fingerprint per CPU architecture. 103 runs of Firefox 152-158 on 12 CPUs gave 35.749972093850374 on every x86-64 machine and 35.74996626004577 on every ARM64 one, whatever the OS, sound device, sample rate or version. The per-identity noise put every Camoufox identity on a value no real machine renders. Browser: audio-fingerprint-manager.patch is gone, with setAudioFingerprintSeed and setAudioFingerprintNoise; font-list-spoofing, webrtc-ip-spoofing and window-setter-seal are regenerated without its context (the series applies cleanly to vanilla 158). audio:seed is marked removed in properties.json. Library (py and ts): no seed is derived or drawn, and config or config_overrides carrying audio:seed raise InvalidPropertyType pointing at the new tribal rule. fingerprint_options, never released, is reverted; canvas_noise stays as released. Tests: tribal rule audio-is-not-noised with its test; the audio-matches-stock guard replaces context-audio-off and audio-frequency-noise, holding the fpjs buffer, AnalyserNode, biquad and sine renders to the recorded stock values in several contexts and two launches while sending the seed released libraries send. build-tester counts the audio hash as must-match and fails its noise trap. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * A removed audio:seed warns and is dropped; the rule lists each machine Passing audio:seed in config (or a NewContext config_overrides) no longer raises. Both launchers drop the key and emit one FutureWarning from warnings.yml (audio_seed_removed): the option was removed and audio is rendered exactly as stock Firefox renders it. The caller's dict is left as it was. Tests on both sides check the single warning and a normal launch; the launch golden records the warning in order. audio-is-not-noised now lists the evidence per machine and architecture, including the Raspberry Pi 4 runs (106 runs: 45 ARM64, 61 x86-64), the device swap, fpgen's share and what the noise produced. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: coffeegrind123 <103264516+coffeegrind123@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
388 lines
20 KiB
Markdown
388 lines
20 KiB
Markdown
<div align="center">
|
|
|
|
# camoufox (Python)
|
|
|
|
#### The Python launcher for the Camoufox anti-detect browser.
|
|
|
|
</div>
|
|
|
|
`camoufox` drives the Camoufox browser through Playwright. On every launch it
|
|
draws a complete device identity from [fpgen](https://github.com/scrapfly/fingerprint-generator),
|
|
a model of real-world traffic, checks that the parts agree with each other, and
|
|
hands it to the browser, which spoofs it in C++. With a proxy and `geoip=True`
|
|
it also matches timezone, locale, geolocation and the WebRTC IP to the proxy's
|
|
exit IP.
|
|
|
|
The TypeScript package ([`typescript/`](https://github.com/daijro/camoufox/tree/main/typescript)) is a port of this one
|
|
with the same options. Notes for AI coding agents are in
|
|
[`AGENTS.md`](https://github.com/daijro/camoufox/blob/main/AGENTS.md#using-camoufox).
|
|
|
|
## Install
|
|
|
|
```bash
|
|
pip install -U "camoufox[geoip]"
|
|
camoufox fetch
|
|
```
|
|
|
|
| Requirement | Value |
|
|
|---|---|
|
|
| Python | 3.10 or newer |
|
|
| Playwright | below 1.63 (installed as a dependency) |
|
|
| `geoip` extra | needed for `geoip=`; downloads the [GeoIP All-in-One](https://github.com/daijro/geoip-all-in-one) database, refreshed once it is a week old |
|
|
|
|
`camoufox fetch` installs the browser build this release is paired with, and
|
|
fpgen's model, pinned by sha256. Without it, the first launch downloads both.
|
|
It reads the build's release with one GitHub API call and exits non-zero
|
|
when it installs nothing. On a shared CI runner, set `GITHUB_TOKEN` to raise
|
|
GitHub's API rate limit.
|
|
Run `fetch` as the user that owns the Python environment if the browser will
|
|
run as someone else, for example while building a Docker image.
|
|
`camoufox remove` deletes everything that was downloaded.
|
|
|
|
## Usage
|
|
|
|
Camoufox returns ordinary Playwright objects, so existing Playwright code works
|
|
once the launch is changed.
|
|
|
|
### Sync and async
|
|
|
|
```python
|
|
from camoufox.sync_api import Camoufox
|
|
|
|
with Camoufox(headless=True) as browser:
|
|
page = browser.new_page()
|
|
page.goto("https://example.com")
|
|
```
|
|
|
|
```python
|
|
import asyncio
|
|
from camoufox.async_api import AsyncCamoufox
|
|
|
|
async def main():
|
|
async with AsyncCamoufox(headless=True) as browser:
|
|
page = await browser.new_page()
|
|
await page.goto("https://example.com")
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
### Proxy with a matching location
|
|
|
|
```python
|
|
from camoufox.sync_api import Camoufox
|
|
|
|
with Camoufox(
|
|
proxy={"server": "http://proxy.example.com:8080", "username": "user", "password": "pass"},
|
|
geoip=True,
|
|
) as browser:
|
|
page = browser.new_page()
|
|
page.goto("https://example.com")
|
|
```
|
|
|
|
`geoip=True` looks up the exit IP through the proxy, then sets timezone,
|
|
locale, geolocation and the WebRTC IP from it. Pass an IP string instead to
|
|
skip the lookup.
|
|
|
|
Without a proxy, sites can reach this machine over IPv6. IPv6 stays on when the
|
|
machine's IPv6 address geolocates where the IPv4 identity does. Otherwise, the
|
|
browser behaves as on an IPv4-only network, and a `LeakWarning` says why.
|
|
|
|
### Persistent profile
|
|
|
|
```python
|
|
from camoufox.sync_api import Camoufox
|
|
|
|
with Camoufox(persistent_context=True, user_data_dir="profiles/alice") as context:
|
|
page = context.new_page()
|
|
page.goto("https://example.com")
|
|
```
|
|
|
|
With `persistent_context=True` the context manager yields a `BrowserContext`,
|
|
not a `Browser`.
|
|
|
|
### One browser, many identities
|
|
|
|
`NewContext()` gives each context its own identity (navigator, screen, WebGL,
|
|
fonts, voices, timezone, WebRTC IP), applied through
|
|
`add_init_script` before any page script runs.
|
|
|
|
```python
|
|
from camoufox.sync_api import Camoufox, NewContext
|
|
|
|
with Camoufox(headless=True, canvas_noise=True) as browser:
|
|
alice = NewContext(browser, os="windows")
|
|
bob = NewContext(
|
|
browser,
|
|
os="macos",
|
|
proxy={"server": "http://proxy.example.com:8080", "username": "user", "password": "pass"},
|
|
)
|
|
alice.new_page().goto("https://example.com")
|
|
bob.new_page().goto("https://example.com")
|
|
```
|
|
|
|
| `NewContext` argument | Effect |
|
|
|---|---|
|
|
| `preset` | Use this fingerprint preset dict instead of an fpgen draw. |
|
|
| `os` | `"windows"`, `"macos"` or `"linux"` for the drawn identity. On a browser without canvas noise, the host's OS, and anything else raises `ValueError`. |
|
|
| `ff_version` | Firefox major version claimed in the User-Agent. Defaults to the browser's own. |
|
|
| `webrtc_ip` | IPv4 or IPv6 address WebRTC reports. |
|
|
| `proxy` | Per-context proxy, in Playwright's format. Unless `webrtc_ip` and `timezone_id` are both given, they are looked up from the proxy's exit IP, and `InvalidIP` is raised if the lookup fails. |
|
|
| `geolocation` | `{"latitude": ..., "longitude": ...}`; also grants the `geolocation` permission. |
|
|
| anything else | Passed to Playwright's `new_context()`, overriding the generated value. |
|
|
|
|
`AsyncNewContext()` is the async twin.
|
|
|
|
Canvas noise belongs to the browser, not the context (see
|
|
[The canvas on another OS](#the-canvas-on-another-os)). On a browser without it,
|
|
every context claims the host's OS and GPU too, since its canvas renders there.
|
|
Contexts with other OSes, like the ones above, need `canvas_noise=True`.
|
|
|
|
The browser's own OS also decides some things for all its contexts. A browser
|
|
launched as Windows on a Linux or macOS host (`os="windows"`, or drawn so)
|
|
computes `Math` as the Windows CRT does and uses Windows' keyboard shortcuts
|
|
(on a Linux host; on macOS only the editor caret style), middle-click and
|
|
scrollbars ([docs/HOST-PARITY.md](../docs/HOST-PARITY.md)).
|
|
Those are browser settings, so a macOS context on it has them too, and a
|
|
Windows context on a browser launched as another OS has the host's. `NewContext`
|
|
does not refuse the mix. Pass `os` at launch for the OS whose behaviour matters,
|
|
or use one browser per OS.
|
|
|
|
### The canvas on another OS
|
|
|
|
A page can draw a canvas or a WebGL scene and read the pixels back. Those pixels
|
|
come from the real OS, driver and GPU, whatever the identity claims.
|
|
|
|
- **On the host's OS**, the launcher starts the browser once, unspoofed and with
|
|
the same display, reads the GPU Firefox reports, and the identity claims it.
|
|
The pixels then agree with the identity. A host that renders in software (no
|
|
GPU driver, as on most servers) keeps a drawn GPU: it reads as a machine
|
|
whose driver failed to load.
|
|
- **On another OS, or with another GPU** (`webgl_config`, a preset's GPU, or a
|
|
host GPU fpgen never recorded), the pixels would show the real one. Camoufox
|
|
then turns on the canvas protection of `privacy.resistFingerprinting`, and
|
|
only that:
|
|
canvas and WebGL readback return random data, as in LibreWolf, Tor Browser
|
|
and Mullvad Browser. Stock Firefox does not do this, so the launch prints a
|
|
`LeakWarning`; the browser reads as a privacy-hardened Firefox rather than a
|
|
stock one.
|
|
|
|
`canvas_noise=True` turns the protection on for any OS, `canvas_noise=False`
|
|
never.
|
|
|
|
WebGPU follows the same rule. `navigator.gpu` exists only where Firefox on the
|
|
claimed device has it (Windows and Apple Silicon Macs), and the adapter is the
|
|
host's only when the identity claims the host's GPU. Otherwise
|
|
`requestAdapter()` returns `null`, as Firefox does for a blocked or software GPU.
|
|
|
|
### Headless modes
|
|
|
|
| `headless=` | What runs | Notes |
|
|
|---|---|---|
|
|
| `False` (default) | A normal window | Needs a display. |
|
|
| `True` | Firefox headless | Camoufox patches the headless tells it knows about. |
|
|
| `"virtual"` | A headed browser on a private Xvfb display | Linux only, needs `Xvfb` and `setpriv` (util-linux). Handled by `Camoufox`, `AsyncCamoufox`, `NewBrowser` and `launch_server`. The display is 1x1 unless `CAMOUFOX_VIRTUAL_DISPLAY_SIZE` (e.g. `1920x1080x24`) says otherwise. Xvfb has no GPU: canvas and WebGL render in software. |
|
|
| `"virtual-gpu"` | A headed browser on a private, headless Xorg server bound to one GPU | Linux only, needs Xorg and the card's driver. Canvas and WebGL render on the card. Handled like `"virtual"`. See [The GPU display](#the-gpu-display). |
|
|
|
|
#### The GPU display
|
|
|
|
```python
|
|
from camoufox.sync_api import Camoufox
|
|
|
|
with Camoufox(headless="virtual-gpu", gpu="0000:01:00.0", os="linux") as browser:
|
|
page = browser.new_page()
|
|
```
|
|
|
|
- **The card is named, never guessed.** `gpu=` (or `CAMOUFOX_GPU`) takes a PCI
|
|
address, which is the stable choice, or an index in PCI address order, a
|
|
render or card node (`renderD128`, `/dev/dri/card1`), `vendor:device` ids
|
|
(`10de:2c02`) or a vendor name (`nvidia`). With several GPUs and no selector
|
|
the launch raises `AmbiguousGpuSelection`; `GpuNotFound` and `NoGpuFound`
|
|
mean what they say. `python -m camoufox gpu-xorg-config` lists the GPUs when
|
|
the choice is ambiguous.
|
|
- **Without root, set the machine up once per card.** Xorg then runs through
|
|
the setuid `Xorg.wrap`, which takes a config only from `/etc/X11` and needs
|
|
`allowed_users=anybody` and `needs_root_rights=yes` in
|
|
`/etc/X11/Xwrapper.config`. Stock Debian and Ubuntu ship
|
|
`allowed_users=console`, which refuses a launch from ssh, systemd or a
|
|
container. One command installs Xorg and the wrapper (with `apt-get`;
|
|
elsewhere it says what to install), sets those two lines and installs the
|
|
card's config. It is safe to run again:
|
|
```bash
|
|
python -m camoufox gpu-setup 0000:01:00.0 | sudo sh
|
|
```
|
|
A launch that fails for want of any of this ends its error with that
|
|
command. The settings let any local user start a root X server.
|
|
`gpu-xorg-config` prints just the card's config. As root, nothing is
|
|
installed: a temporary config is used instead.
|
|
- **It leaves your desktop alone.** The server drives no monitor, shares the
|
|
current VT and exits when the browser closes. If the active VT changes while
|
|
it starts, the launch switches back, stops the server and raises
|
|
`GpuVtTakeover`.
|
|
- **The launch checks the browser renders on the card.** A page draws WebGL
|
|
and the launch waits up to 30 s (`CAMOUFOX_GPU_WAIT_S`) for the kernel to
|
|
account GPU work to the browser. If it never does, the browser is closed and
|
|
`GpuSoftwareFallback` is raised; `require_gpu=False` warns instead. There is
|
|
no fallback to Xvfb.
|
|
- **The identity claims that card.** On the host's OS the identity claims the
|
|
GPU Firefox reports, read on this display, so it is the card's and not the
|
|
desktop's (see [The canvas on another OS](#the-canvas-on-another-os)).
|
|
- The browser gets `DISPLAY` and the X11 backend, and nothing that chooses a
|
|
GL driver. These prefs default on, and `firefox_user_prefs` wins:
|
|
`gfx.webrender.all`, `layers.acceleration.force-enabled`,
|
|
`gfx.x11-egl.enabled`, `gfx.canvas.accelerated` and
|
|
`gfx.canvas.accelerated.force-enabled`.
|
|
|
|
Every error here is a `VirtualDisplayError`.
|
|
|
|
### Remote server
|
|
|
|
Run Camoufox in one process and connect from any language Playwright supports:
|
|
|
|
```python
|
|
from camoufox.server import launch_server
|
|
|
|
launch_server(headless=True, geoip=True, port=1234, ws_path="camoufox")
|
|
```
|
|
|
|
It prints the websocket endpoint. Connect with
|
|
`playwright.firefox.connect("ws://localhost:1234/camoufox")`. A persistent
|
|
context cannot be served.
|
|
|
|
### Your own Playwright instance
|
|
|
|
`NewBrowser()` launches on a Playwright instance you already have, and
|
|
`launch_options()` returns the keyword arguments for
|
|
`playwright.firefox.launch()`:
|
|
|
|
```python
|
|
from playwright.sync_api import sync_playwright
|
|
from camoufox import NewBrowser, launch_options
|
|
|
|
with sync_playwright() as playwright:
|
|
browser = NewBrowser(playwright, os="linux", headless=True)
|
|
browser.close()
|
|
|
|
browser = playwright.firefox.launch(**launch_options(os="linux", headless=True))
|
|
browser.close()
|
|
```
|
|
|
|
Prefer `NewBrowser()`: it also defaults new pages to `no_viewport` when the
|
|
window size is spoofed, and to the host's own color scheme and motion settings.
|
|
|
|
## Launch options
|
|
|
|
`Camoufox`, `AsyncCamoufox`, `NewBrowser`, `AsyncNewBrowser`, `launch_server`
|
|
and `launch_options` all take these keyword arguments. Any other keyword is
|
|
passed to Playwright's `firefox.launch()` (or `launch_persistent_context()`).
|
|
|
|
| Option | Type | Default | Effect |
|
|
|---|---|---|---|
|
|
| `os` | `str` or `list[str]` | fpgen's real-world mix | `"windows"`, `"macos"`, `"linux"`, or a list to pick from. |
|
|
| `headless` | `bool`, `"virtual"` or `"virtual-gpu"` | `False` | See [Headless modes](#headless-modes). |
|
|
| `gpu` | `str` or `int` | `CAMOUFOX_GPU`, or the only GPU | The card for `headless="virtual-gpu"`. See [The GPU display](#the-gpu-display). Not taken by `launch_options`. |
|
|
| `require_gpu` | `bool` | `True` | With `headless="virtual-gpu"`, fail the launch when the browser does not render on the card; `False` warns. Not taken by `launch_options`. |
|
|
| `proxy` | `dict` | none | Playwright proxy: `server`, `username`, `password`, `bypass`. |
|
|
| `geoip` | `bool` or `str` | none | `True` finds the public IP (through `proxy` if set); a string uses that IP. Sets timezone, locale, geolocation and the WebRTC IP. Without a proxy, also decides whether IPv6 stays on. Needs the `geoip` extra. |
|
|
| `geoip_db` | `str` | the `camoufox set --geoip` choice | GeoIP database name, e.g. `"GeoIP AIO by daijro"`. |
|
|
| `locale` | `str` or `list[str]` | from `geoip`, else the drawn identity's | Locale(s), e.g. `"en-US"` or `["fr-FR", "en-US"]`. The first is used for `Intl`. |
|
|
| `humanize` | `bool` or `float` | off | Human cursor movement. A number caps one movement at that many seconds (default cap 1.5). |
|
|
| `screen` | `camoufox.fingerprints.Screen` | the real display when headed | Bounds the generated screen: `Screen(max_width=1920, max_height=1080)`. |
|
|
| `window` | `(int, int)` | generated | Fixed outer window size. |
|
|
| `fonts` | `list[str]` | none | Extra font families on top of the OS's own. |
|
|
| `custom_fonts_only` | `bool` | `False` | Use only `fonts`, not the OS fonts. Warns: the font set no longer matches the OS. |
|
|
| `addons` | `list[str]` | none | Paths to extracted Firefox addons (folders with a `manifest.json`). |
|
|
| `exclude_addons` | `list[DefaultAddons]` | none | Default addons to leave out, e.g. `[DefaultAddons.UBO]`. |
|
|
| `block_images` | `bool` | `False` | Block image loading. Warns: some WAFs detect it. |
|
|
| `block_webrtc` | `bool` | `False` | Disable WebRTC entirely. |
|
|
| `block_webgl` | `bool` | `False` | Disable WebGL. Warns: many WAFs check for it. |
|
|
| `webgl_config` | `(vendor, renderer)` | drawn | Use one GPU fpgen has recorded for Firefox on `os` (see `camoufox.webgl.firefox_gpus`); any other pair raises `ValueError`. Needs `os`. |
|
|
| `canvas_noise` | `bool` | on for another OS or GPU | Random canvas and WebGL readback, as in LibreWolf. Warns. See [The canvas on another OS](#the-canvas-on-another-os). |
|
|
| `disable_coop` | `bool` | `False` | Turn off Cross-Origin-Opener-Policy so elements in cross-origin iframes (such as the Turnstile checkbox) can be clicked. Warns. |
|
|
| `main_world_eval` | `bool` | `False` | Allow `page.evaluate("mw:...")` and `mw:` init scripts to run in the page's own world. |
|
|
| `allow_addon_new_tab` | `bool` | `False` | Let addons open tabs. |
|
|
| `enable_cache` | `bool` | `False` | Keep Firefox's page and request caches. Uses more memory. |
|
|
| `pin_cpu_cores` | `bool` | `False` | Linux and Windows: pin the browser to as many cores as `navigator.hardwareConcurrency` claims, so a page timing parallel workers measures the same number. Costs CPU and serializes concurrent launches. |
|
|
| `fingerprint` | fpgen fingerprint `dict` | drawn | Use this fpgen fingerprint instead of drawing one. Warns. |
|
|
| `fingerprint_preset` | `bool` or `dict` | `None` | Opt into a recorded real-device preset instead of fpgen: `True` picks a random bundled one, a dict uses that one. |
|
|
| `ff_version` | `int` | the browser's own | Firefox version to claim. Warns: a mismatch with the engine is detectable. |
|
|
| `config` | `dict` | none | Raw Camoufox properties ([`properties.json`](https://github.com/daijro/camoufox/blob/main/browser/settings/properties.json)). Overrides the generated identity; manual identity keys warn. |
|
|
| `firefox_user_prefs` | `dict` | none | Extra Firefox prefs. |
|
|
| `args` | `list[str]` | none | Extra browser command-line arguments. |
|
|
| `env` | `dict` | a copy of the environment | Environment variables for the browser. |
|
|
| `executable_path` | `str` or `Path` | the installed build | Use this binary. `CAMOUFOX_EXECUTABLE_PATH` sets it too. Raises with `browser`. |
|
|
| `browser` | `str` | the paired build | Launch another installed build: `"official/beta.20"`, `"beta.20"` or `"134.0.2-beta.20"`. Never downloads; warns like `camoufox set`. |
|
|
| `virtual_display` | `str` | none | Use an existing X display, e.g. `":99"`. |
|
|
| `i_know_what_im_doing` | `bool` | `False` | Silence the leak warnings above. |
|
|
| `debug` | `bool` | `False` | Print the config sent to the browser. |
|
|
|
|
`NewBrowser` and `AsyncNewBrowser` also take `persistent_context` and
|
|
`from_options` (a dict from `launch_options()` to use as is).
|
|
|
|
## CLI
|
|
|
|
`camoufox <command>`, or `python -m camoufox <command>`.
|
|
|
|
| Command | Options | What it does |
|
|
|---|---|---|
|
|
| `fetch [VERSION]` | | Install the paired build (or, after `set`, the latest in the chosen channel), or `VERSION` without making it active. A named or paired build is read from its own release; anything else syncs first. Exits non-zero when nothing is installed. |
|
|
| `sync` | `--spoof-os auto\|mac\|win\|lin`, `--spoof-arch auto\|x86_64\|i686\|arm64` | Refresh the list of available builds from every repository. |
|
|
| `set [SPECIFIER]` | `--geoip`, `--release` | Pin a build (`official/stable/134.0.2-beta.20`) or follow a channel (`official/stable`). No specifier opens a picker. `--geoip` picks the GeoIP database instead; `--release` goes back to the paired build. |
|
|
| `active` | | Print the active build. A build that is chosen but not downloaded is marked `(not fetched)`. |
|
|
| `list [installed\|all]` | `--path` | List installed builds, or every available one, as a tree. |
|
|
| `remove [VERSION]` | `--select`, `-y/--yes` | Remove one build, pick one interactively, or (with no argument) the whole data directory. |
|
|
| `version` | | Package versions (Camoufox, fpgen, Playwright), the active build and whether it is the latest in its channel, the GeoIP database, and storage paths and sizes. |
|
|
| `path` | | Print the data directory (`~/.cache/camoufox` on Linux). |
|
|
| `test [URL]` | `--executable-path PATH` | Open a headed browser with the Playwright inspector. |
|
|
| `server` | | Start a Playwright server with default options and print its websocket endpoint. |
|
|
| `gpu-setup [GPU]` | | Print the root script that sets this machine up for `headless="virtual-gpu"` on the card `GPU` names (or `CAMOUFOX_GPU`). Run it with `\| sudo sh`. |
|
|
| `gpu-xorg-config [GPU]` | | Print the Xorg config `headless="virtual-gpu"` needs for the card `GPU` names (or `CAMOUFOX_GPU`). |
|
|
|
|
`set` and `fetch` read builds from these repositories (`repos.yml`):
|
|
|
|
| Name | Repository |
|
|
|---|---|
|
|
| Official | `daijro/camoufox` |
|
|
| CoryKing | `coryking/camoufox` |
|
|
| JWriter20 | `JWriter20/camoufox` |
|
|
|
|
https://github.com/user-attachments/assets/992b1830-6b21-4024-9165-728854df1473
|
|
|
|
### Which browser build is used
|
|
|
|
Each release of this package is paired with the one browser build it was built
|
|
and tested with. `camoufox fetch` installs that build and every launch uses it,
|
|
even when other builds are installed and even when the paired build is a
|
|
prerelease. A launch with the paired build missing downloads it first, so
|
|
upgrading the package never runs a browser it was not tested with.
|
|
|
|
`camoufox set` overrides the pairing. The choice is kept, and each launch warns
|
|
that the build differs from the paired one. `camoufox set --release` goes back.
|
|
The `browser` launch option overrides it for one launch, the same way: the named
|
|
build must already be installed, and nothing is downloaded.
|
|
|
|
Every browser release declares the interface it speaks, and the package refuses
|
|
one it cannot drive: `sync` leaves it out, `fetch` refuses it, and a launch
|
|
fails, each saying which package upgrade is needed. Once a sync has seen such a
|
|
build, every launch warns that the package needs upgrading.
|
|
|
|
A development checkout (installed from the repository, not from PyPI) is
|
|
paired with nothing and follows its channel, `official/stable` by default.
|
|
|
|
## Development
|
|
|
|
From the repository root:
|
|
|
|
```bash
|
|
python3 -m venv .venv
|
|
.venv/bin/pip install -r ci/requirements.txt -e 'python[geoip]'
|
|
.venv/bin/python python/scripts/pin-fpgen-model.py
|
|
.venv/bin/python -m ci.run_pythonlib
|
|
```
|
|
|
|
`ci.run_pythonlib` runs `python/tests/`, the same job CI runs. Which suite covers
|
|
which change is in [`AGENTS.md`](https://github.com/daijro/camoufox/blob/main/AGENTS.md#testing).
|
|
|
|
## Licence
|
|
|
|
MIT ([`LICENSE`](https://github.com/daijro/camoufox/blob/main/python/LICENSE)). The browser itself is MPL-2.0.
|