# drudge/n8n-nodes-puppeteer architecture

> Architecture diagram of the GitHub repository drudge/n8n-nodes-puppeteer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/drudge/n8n-nodes-puppeteer
- Repository: https://github.com/drudge/n8n-nodes-puppeteer

## Overview

##### Project type and purpose
- This is a community-maintained n8n node package (“n8n-nodes-puppeteer”) that extends the n8n workflow automation platform to perform browser automation via Puppeteer.
- The node sits inside an n8n installation, exposing operations such as “Get Page Content,” “Get Screenshot,” “Get PDF,” and “Custom Script” to end users.

##### File structure
- Top-level files:
- index.js – Entry point that registers the Puppeteer node(s) with n8n
- package.json, tsconfig.json, tslint.json – Configuration & metadata
- Dockerfile + docker/ folder – Prebuilt container for production usage
- nodes/Puppeteer/ – TypeScript source for the Puppeteer integration
- Puppeteer.node.ts – Definition of the node’s operations & parameters
- Puppeteer.node.options.ts – Option schema for each operation
- types.d.ts – Shared type definitions
- gulpfile.js – Build tasks (compile TS, copy assets)
- .github/workflows/publish.yml – CI/CD pipeline for publishing to npm

##### README for additional insights
- Explains two deployment modes:
a. Local installation as an n8n community node
b. Dockerized image hosting both n8n and Puppeteer with required dependencies
- Describes runtime options: local browser vs. remote WebSocket endpoint

##### Elements
- Clear labels: “n8n Core,” “Puppeteer Node,” “Puppeteer Library,” “Browser Instance,” “Docker Host”
- n8n → Plugin → Puppeteer → Browser
- Browser → Plugin → n8n
- (Optional) Plugin → Remote Browser Service
- Rectangles for compute components (n8n, Plugin, Browser)
- Container boundary to enclose Dockerized components

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Development Components
    subgraph "Development Environment"
        direction TB
        index["index.js"]:::code
        pkg["package.json"]:::code
        tsconfig["tsconfig.json"]:::code
        tslint["tslint.json"]:::code
        gulpfile["gulpfile.js"]:::code
        publish[".github/workflows/publish.yml"]:::code
        dependabot[".github/dependabot.yml"]:::code
        readme["README.md"]:::code
        subgraph "Puppeteer Node Source"
            direction TB
            puppeteerNodeImpl["nodes/Puppeteer/Puppeteer.node.ts"]:::code
            puppeteerOptions["nodes/Puppeteer/Puppeteer.node.options.ts"]:::code
            types["nodes/Puppeteer/types.d.ts"]:::code
        end
    end

    %% Docker Deployment
    subgraph "Docker Deployment"
        direction TB
        dockerfile["Dockerfile"]:::infra
        dockerFolder["docker/"]:::infra
        dockerEntrypoint["docker/docker-custom-entrypoint.sh"]:::infra
    end

    %% Runtime Components
    subgraph "Runtime Environment (Containerized)"
        direction TB
        n8nCore["n8n Core"]:::runtime
        puppeteerNode["Puppeteer Node"]:::runtime
        puppeteerLib["Puppeteer Library"]:::runtime
        browserInstance["Browser Instance"]:::runtime
        fileStorage["File System & Data Store"]:::storage
        remoteBrowser["Remote Browser Service"]:::external
    end

    %% Development to Runtime Relationships
    index -->|registers plugin| n8nCore
    puppeteerNodeImpl -->|implements| puppeteerNode
    pkg -->|declares deps| puppeteerLib
    tsconfig -->|configures build| gulpfile
    tslint -->|lints code| gulpfile
    gulpfile -->|builds| puppeteerNodeImpl
    publish -->|CI/CD publish| pkg
    dependabot -->|updates deps| pkg
    readme -->|documents| n8nCore

    %% Docker to Runtime
    dockerfile -->|builds container| n8nCore
    dockerFolder -->|includes Chromium| browserInstance
    dockerEntrypoint -->|startup logic| n8nCore

    %% Runtime Data Flow
    n8nCore -->|invokes node| puppeteerNode
    puppeteerNode -->|calls API| puppeteerLib
    puppeteerLib -->|drives| browserInstance
    browserInstance -->|returns data| puppeteerNode
    puppeteerNode -->|outputs results| n8nCore
    puppeteerNode -->|saves to| fileStorage
    puppeteerNode -->|optional connect| remoteBrowser

    %% Click Events
    click index "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/index.js"
    click pkg "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/package.json"
    click tsconfig "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/tsconfig.json"
    click tslint "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/tslint.json"
    click gulpfile "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/gulpfile.js"
    click publish "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/.github/workflows/publish.yml"
    click dependabot "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/.github/dependabot.yml"
    click readme "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/README.md"
    click puppeteerNodeImpl "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/nodes/Puppeteer/Puppeteer.node.ts"
    click puppeteerOptions "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/nodes/Puppeteer/Puppeteer.node.options.ts"
    click types "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/nodes/Puppeteer/types.d.ts"
    click dockerfile "https://github.com/drudge/n8n-nodes-puppeteer/tree/main/Dockerfile"
    click dockerFolder "https://github.com/drudge/n8n-nodes-puppeteer/tree/main/docker/"
    click dockerEntrypoint "https://github.com/drudge/n8n-nodes-puppeteer/blob/main/docker/docker-custom-entrypoint.sh"

    %% Styles
    classDef code fill:#f9f,stroke:#333,stroke-width:1px
    classDef infra fill:#9ff,stroke:#333,stroke-width:1px
    classDef runtime fill:#ff9,stroke:#333,stroke-width:1px
    classDef storage fill:#f96,stroke:#333,stroke-width:1px
    classDef external fill:#ccc,stroke:#333,stroke-width:1px
```
