Getting started

WebProbe targets Node.js 24 LTS. Run PostgreSQL and Redis, install dependencies and Chromium, migrate the database, provision a client/key, then start the API and execution worker. The fixture server on port 3199 provides authorized deterministic targets.

These instructions install WebProbe v1.0.0 and correspond to the /v1 API and /v1/ documentation line.

cp .env.example .env
npm install
npx playwright install chromium
npm run db:migrate
npm run db:bootstrap
npm run dev:fixture
npm run dev:worker
npm run dev:api

Check liveness at GET /health, dependency readiness at GET /ready, and the interactive OpenAPI reference at /reference.

curl http://127.0.0.1:3100/v1/run \
  -H "Authorization: Bearer $WEBPROBE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com","extract":{"title":"h1"}}'

Private and loopback targets are blocked by default. Enable ALLOW_PRIVATE_NETWORKS=true only for an explicitly trusted local QA environment.