zenato/puppeteer-renderer repository overview

⁠Puppeteer(Chrome headless node API) based web page renderer

Puppeteer⁠ (Chrome headless node API) based web page renderer.

Useful server side rendering through proxy. Outputs HTML, PDF and screenshots as PNG.

⁠Requirements

You can run Chromium or docker.

⁠Getting Started

⁠Install dependencies.

npm install

⁠Start server (If you can run Chromium)

npm start

(service port: 3000)

⁠Start server using docker (If you can not run Chromium and installed docker)

docker run -d --name renderer -p 8080:3000 zenato/puppeteer-renderer

⁠Test on your browser

Input url http://localhost:{port}/?url=https://www.google.com

If you can see html code, server works fine.

⁠Integration with existing service.

If you have active service, set proxy configuration with middleware. See puppeteer-renderer-middleware⁠ for express.

const renderer = require('puppeteer-renderer-middleware');

const app = express();

app.use(renderer({
  url: 'http://installed-your-puppeteer-renderer-url',
  // userAgentPattern: /My-Custom-Agent/i,
  // excludeUrlPattern: /*.html$/i
  // timeout: 30 * 1000,
}));

// your service logics..

app.listen(8080);

⁠API

⁠PDF File Name Convention

Generated PDFs are returned with a Content-disposition header requesting the browser to download the file instead of showing it. The file name is generated from the URL rendered:

⁠License

MIT⁠

Copyright (c) 2017-present, Yeongjin Lee