isabella232 / dreamcatcher

Image and PDF web page capture service using Node and Puppeteer

Node-based service providing a lightweight API for generating JPEG/PNG and PDF representations of a web page, using headless Chrome and Puppeteer.

Quick Start

• Install depencencies with npm install.
• To install additional fonts in the built image, place them in a top-level fonts directory.
• To start the server, npm start.

Consult the documentation for configuration options and usage.

Troubleshooting Tips

• When testing Dreamcatcher locally using Docker and a locally-served target site, be sure to use your machine's external-facing IP address in the url parameter (rather than localhost).
• If your generated image files seem to be twice as large as the requested dimensions, it's because Dreamcatcher sets by default the deviceScaleFactor property of the Chromium viewport to 2, so as to generate images suitable for high-resolution "retina" displays. To override, pass the scaleFactor parameter (e.g. scaleFactor: 1).