Installation

1. Clone the repository

   git clone https://github.com/rayobyte-data/rayobrowse.git
   cd rayobrowse

2. Configure environment

   cp .env.example .env

   Open .env and set STEALTH_BROWSER_ACCEPT_TERMS=true to accept the license. The daemon will not create browsers until this is set.

3. Start the container

   docker compose up -d

   Docker automatically pulls the rayobyte/rayobrowse:latest image for your architecture (x86_64 or ARM64).

4. Verify

   curl http://localhost:9222/health

   Expected response:

   {"success": true, "data": {"status": "healthy", ...}}

What’s running

After docker compose up -d, you have:

Port	Service
9222	Daemon API + CDP WebSocket proxy
6080–6119	Per-browser noVNC viewers (when STEALTH_BROWSER_NOVNC=true)

Docker Compose details

The docker-compose.yml from the repository:

• Image: rayobyte/rayobrowse:latest
• Restart policy: unless-stopped
• Shared memory: 2g (required for Chromium)
• Security: seccomp=unconfined (required for Chrome sandbox)
• Volume: rayobrowse-data mounted at /data
• Environment: loaded from .env

Install the SDK (optional)

The /connect endpoint works without any SDK. For programmatic control, install the SDK:

# Python
pip install rayobrowse

# Node.js
npm install rayobrowse

Tip

The SDK is intentionally minimal — it issues HTTP requests to the daemon and returns CDP WebSocket URLs. All browser-level logic runs inside the container.

Troubleshooting

Can’t connect to daemon

curl http://localhost:9222/health

If this fails, check that the container is running:

docker compose ps
docker compose logs -f

TERMS_REQUIRED error

Set STEALTH_BROWSER_ACCEPT_TERMS=true in your .env, then restart:

docker compose up -d

Environment variable changes not taking effect

The container reads .env at startup. After editing, recreate the container:

docker compose up -d