Screenshotter

A Node server that takes screenshots of websites with pageres.

Install

npm install

Running

npm start # listens on port 8090 by default

Usage

POST /save

Saves screenshots of url with dimensions sizes to the directory dest in the server's local filesystem.

interface Payload {
  url: string;
  dest: string;
  sizes?: string[]; // defaults to ["1024x768"]
  failOnWarnings?: boolean; // defaults to false
  options?: PageresOptions;
}

POST /stream

Streams a screenshot of url with dimensions size.

interface Payload {
  url: string;
  size?: string; // defaults to "1024x768"
  options?: PageresOptions;
}

Pageres options and defaults

interface PageresOptions {
  delay?: number;
  timeout?: number;
  crop?: boolean;
  css?: string;
  script?: string;
  cookies?: string[];
  filename?: string; // https://github.com/sindresorhus/pageres#filename
  incrementalName?: boolean;
  selector?: string;
  hide?: string[];
  username?: string;
  password?: string;
  scale?: number; // 1
  format?: 'png' | 'jpg'; // png
  userAgent?: string;
  headers?: object;
}

const defaultPageresOptions: PageresOptions = {
  delay: 0,
  timeout: 30,
  scale: 1,
  format: 'png',
  incrementalName: false,
  crop: true,
};

Examples

Start the screenshotter at localhost:8090 with

docker-compose up

Save to a directory

read -r -d '' BODY <<EOF
{
  "url": "https://google.com",
  "dest": "/screenshots",
  "sizes": ["1024x768", "1920x1200"],
  "options": {
    "scale": 2
  }
}
EOF
echo $BODY | curl -v -H "Content-Type: application/json" -d '@-' localhost:8090/save

There should now exist two PNGs at test/tmp.

Stream to a file

read -r -d '' BODY <<EOF
{
  "url": "https://google.com",
  "options": {
    "scale": 2
  }
}
EOF
echo $BODY | curl -v -H "Content-Type: application/json" -d '@-' localhost:8090/stream > screenshot.png

License

MIT