Files
h4ckf0r0day--obscura/docs/Run-in-production-at-scale.md
2026-07-13 12:22:13 +08:00

4.2 KiB

Docker

docker run -d \
  --name obscura \
  --restart unless-stopped \
  -p 127.0.0.1:9222:9222 \
  -v /srv/obscura/data:/data \
  h4ckf0r0day/obscura \
  serve --host 0.0.0.0 --storage-dir /data --stealth

The image runs obscura serve by default. Override with arguments after the image name.

Systemd

/etc/systemd/system/obscura.service:

[Unit]
Description=Obscura headless browser
After=network.target

[Service]
ExecStart=/usr/local/bin/obscura serve --port 9222 --stealth --storage-dir /var/lib/obscura
Restart=always
RestartSec=5
User=obscura
Group=obscura
LimitNOFILE=65536

[Install]
WantedBy=multi-user.target
systemctl enable --now obscura
journalctl -fu obscura

Workers

obscura serve --workers N runs N CDP server workers behind the listener.

obscura serve --workers 4

Use one worker per CPU core. Each worker handles its own pool of pages. Sessions are sticky to a worker.

V8 heap

Default V8 heap is 4 GB on 64-bit systems. The defaults also cap the young generation (--max-semi-space-size=4) and pass --optimize-for-size to hold RSS down. Override:

obscura serve --v8-flags "--max-old-space-size=2048"

Flags you pass are appended after the defaults, and V8 uses the last value for a repeated flag, so your --max-old-space-size wins while the memory-tuning defaults stay in effect. Lower for memory-constrained hosts, raise for heavy SPAs.

Parallel scrape

obscura scrape fans out a list of URLs across worker processes:

obscura scrape \
  --concurrency 20 \
  --format json \
  --timeout 60 \
  url1 url2 url3 ...

Reads URLs from stdin:

cat urls.txt | obscura scrape --concurrency 20 -

Requires obscura-worker next to obscura in PATH.

Resource limits

Per-process memory cap with systemd:

[Service]
MemoryMax=4G
MemoryHigh=3G

Per-container with Docker:

docker run --memory=4g --cpus=2 ...

Reverse proxy

Expose obscura on TLS through nginx or caddy:

location /obscura/ {
  proxy_pass http://127.0.0.1:9222/;
  proxy_http_version 1.1;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection "upgrade";
  proxy_read_timeout 86400;
}

CDP needs WebSocket upgrade and long read timeouts.

Authentication

Obscura's CDP server has no built-in auth. Anyone who can reach the port can drive the browser. Options:

  • Bind to 127.0.0.1 and require SSH for access (default).
  • Put it behind a reverse proxy that enforces auth.
  • Use Docker network isolation.

Never bind 0.0.0.0 on a public IP without one of the above.

MCP HTTP transport

obscura mcp --http binds 127.0.0.1 by default. To reach it from another container, bind with --host 0.0.0.0 and set an Origin allowlist so a browser page cannot drive it cross-origin:

OBSCURA_MCP_ALLOWED_ORIGINS="https://app.example.com" \
  obscura mcp --http --host 0.0.0.0 --port 3000

Request bodies are capped at 16 MiB. Like the CDP server it has no built-in auth, so keep it on an internal network or behind an authenticating proxy. See Use the MCP server.

Observability

obscura serve --verbose
RUST_LOG=obscura=debug obscura serve

--verbose enables info-level logs. RUST_LOG=obscura=debug enables debug-level. Logs go to stderr.

Reliability and timeouts

The engine is hardened so one page cannot hang, crash, or wedge a worker. A V8 watchdog terminates runaway scripts and microtask storms, DOM ops are panic-safe, cyclic DOM mutations are rejected, and the CDP server terminates any single command that overruns its budget so a hung session cannot stall the others. Scripted fetch()/XHR and navigation are timeout-bounded. You can point the server at arbitrary or heavy pages without a stuck worker.

Tune the bounds with environment variables (see Environment variables):

OBSCURA_NAV_TIMEOUT_MS=60000 \
OBSCURA_CDP_COMMAND_TIMEOUT_MS=30000 \
OBSCURA_FETCH_TIMEOUT_MS=20000 \
  obscura serve

OBSCURA_NAV_TIMEOUT_MS is the per-navigation ceiling (default 30000). OBSCURA_CDP_COMMAND_TIMEOUT_MS is the per-CDP-command V8 deadline (default 60000, 0 disables). OBSCURA_FETCH_TIMEOUT_MS bounds scripted fetch/XHR and module loads (default 30000).