1. Navigate to Settings → Community Nodes in your n8n instance
2. Click Install a community node
3. Enter package name: n8n-nodes-headlessx
4. Click Install and wait for completion
5. Restart n8n if required

Global installation
npm install -g n8n-nodes-headlessx
Local installation (for self-hosted n8n)
npm install n8n-nodes-headlessx

FROM n8nio/n8n:latest
USER root
RUN npm install -g n8n-nodes-headlessx
USER node

Docker Compose Example:

version: '3.8'
services:
  headlessx:
    build: ./HeadlessX
    ports: ["3000:3000"]
    environment:
      - DATABASE_URL=postgresql://...
    restart: unless-stopped
  n8n:
    image: n8nio/n8n:latest
    ports: ["5678:5678"]
    volumes: ["n8n_data:/home/node/.n8n"]
    depends_on: [headlessx]
    restart: unless-stopped
volumes:
  n8n_data:

Endpoint: POST /api/website/html

Extract raw HTML content from any webpage quickly without JavaScript rendering.

Parameters:
| Option | Description | Default |
| ————– | ——————– | ——– |
| URL | Target webpage URL | Required |
| Timeout | Request timeout (ms) | 30000 |
| Wait Until | Page load condition | load |
| Headers | Custom HTTP headers | – |
| User Agent | Custom user agent | – |

Use Cases:

• Simple page scraping
• Static content extraction
• Fast bulk operations

Endpoint: POST /api/website/html-js

Extract HTML with full JavaScript rendering for SPAs and dynamic content.

Parameters:
| Option | Description | Default |
| ————– | ——————————- | ————– |
| URL | Target webpage URL | Required |
| Timeout | Request timeout (ms) | 30000 |
| Extra Wait | Additional wait time after load | 0 |
| Wait Until | Page load condition | networkidle0 |

Use Cases:

Endpoint: POST /api/website/content

Extract clean, readable Markdown content from any webpage.

Parameters:
| Option | Description | Default |
| ————– | ——————– | ——– |
| URL | Target webpage URL | Required |
| Timeout | Request timeout (ms) | 30000 |
| Wait Until | Page load condition | load |

Use Cases:

Endpoint: POST /api/website/screenshot

Capture high-quality screenshots of webpages.

Parameters:
| Option | Description | Default |
| ——————— | ———————— | ——– |
| URL | Target webpage URL | Required |
| Full Page | Capture entire page | true |
| Format | PNG, JPEG, WebP | png |
| Quality | Image quality (1-100) | 80 |
| Wait for Selector | CSS selector to wait for | – |

Use Cases:

Endpoint: POST /api/google-serp/search

Extract Google search results with advanced anti-detection.

Parameters:
| Option | Description | Default |
| ——————— | ——————- | ——– |
| Query | Search query | Required |
| Number of Results | Results to return | 10 |
| Language | Search language | en |
| Country | Result localization | us |
| Safe Search | Safety filter level | off |

Use Cases:

graph LR
    A[Manual Trigger] --> B[HeadlessX: Extract HTML]
    B --> C[Code Node: Process HTML]
    C --> D[Output Results]

Configuration:

{
  "operation": "html",
  "url": "https://example.com",
  "htmlOptions": {
    "timeout": 30000,
    "waitUntil": "networkidle2"
  }
}

graph LR
    A[Schedule Trigger] --> B[HeadlessX: Google SERP]
    B --> C[Store Results]
    C --> D[Alert on Changes]

Configuration:

{
  "operation": "googleSerp",
  "query": "your keyword",
  "serpOptions": {
    "num": 20,
    "hl": "en",
    "gl": "us"
  }
}

graph LR
    A[Schedule Trigger] --> B[HeadlessX: Screenshot]
    B --> C[Compare Images]
    C --> D[Send Alert]

Configuration:

{
  "operation": "screenshot",
  "url": "https://your-website.com",
  "screenshotOptions": {
    "fullPage": true,
    "format": "png"
  }
}

“Couldn’t connect with these settings”

| Check | Solution |
| —————— | ————————————— |
| Server Running | curl http://localhost:3000/api/health |
| URL Format | Use http://localhost:3000 (no /api) |
| Network Access | Check firewall/Docker networking |
| Token Validity | Verify API token is correct |

“Request timeout” errors

| Cause | Solution |
| ——————- | ————————————— |
| Slow Page Load | Increase timeout to 60000ms+ |
| Dynamic Content | Use htmlJs operation with extraWait |
| Heavy Resources | Use domcontentloaded wait condition |