Skip to main content

Prerequisites

Node.js 18+

Required for standalone and plugin installation

~500MB disk space

For Camoufox browser engine (downloads on first run)

Linux/macOS/Windows

Runs on all major operating systems

2GB RAM minimum

Recommended 4GB+ for multiple concurrent sessions

Installation options

Install from npm

Start the server

On first run, Camoufox will automatically download the browser engine (~300MB). This is cached locally at ~/.config/camoufox/.

Verify installation

You should see:

Environment variables

Configure the server with environment variables:
Cookie import is disabled unless CAMOFOX_API_KEY is set. See Cookie Import for setup.
When a proxy is configured:
  • All traffic routes through the proxy
  • Camoufox’s GeoIP automatically sets locale, timezone, and geolocation to match the proxy’s exit IP
  • Browser fingerprint is consistent with proxy location
Example:

Resource requirements

Minimum:
  • CPU: 1 core
  • RAM: 2GB
  • Disk: 1GB (500MB for Camoufox + dependencies)
Recommended:
  • CPU: 2 cores
  • RAM: 4GB
  • Disk: 2GB

Optional dependencies

yt-dlp (YouTube transcripts)

For fast YouTube transcript extraction:
Without yt-dlp, the /youtube/transcript endpoint falls back to a slower browser-based method.
The Docker image includes yt-dlp by default.

Verify installation

Run these checks to ensure everything works:
1

Health check

Should return: {"ok": true, "engine": "camoufox"}
2

Create a test tab

Should return a tabId.
3

Get snapshot

Should return accessibility tree with “Example Domain” heading.
If step 2 hangs for ~30 seconds, this is normal on first run - Camoufox is launching the browser for the first time.

Troubleshooting

Error: Error: Cannot find module 'camoufox-js'Solution:
Error: Error: EADDRINUSE: address already in useSolution: Port 9377 is in use. Change port:
Error: Error: Browser download failedSolution:
  1. Check internet connection
  2. Retry: npx camoufox-js fetch
  3. If behind a proxy, set HTTP_PROXY environment variable
Manual download:
Error: JavaScript heap out of memorySolution: Increase Node.js heap size:
Or set environment variable:
Error: Plugin @askjo/camofox-browser failed to loadSolution:
  1. Check plugin is installed: openclaw plugins list
  2. Reinstall: openclaw plugins install @askjo/camofox-browser
  3. Check logs: openclaw logs

Next steps

Quickstart

Try your first browser automation workflow

API reference

Explore all endpoints and parameters

Cookie import

Set up authenticated browsing for LinkedIn, Amazon, etc.

Search macros

Use built-in shortcuts for Google, YouTube, Reddit, and more