Code Monkey home page Code Monkey logo

breezy-pdf-lite's Introduction

BreezyPDF Lite: HTML to PDF generation as a Service

Submit a slug of HTML, get a Google Chrome rendered PDF back.

Build Status Open Source Helpers

Deploy

A quick to stand up HTML to PDF service powered by headless Google Chrome. Deploy with one click and start generating PDF's from your web application or command line.

Getting Started

1. Submit HTML to be converted

This is done with a POST request the the web server. We'll use some example HTML for this example.

  curl -X POST -H 'Authorization: Bearer PRIVATE_TOKEN_DEFINED_IN_SERVER_ENVIRONMENT' \
    http://url-of-your-breezy-pdf-lite-server/render/html \
    -d "`curl https://raw.githubusercontent.com/danielwestendorf/breezy-pdf-lite/master/sample.html`" \
    -o example.pdf

This will create the PDF in the current directory by the name of example.pdf.

2. Configure with meta tags (optional)

All configuration for the rendering of your PDF can be configured by meta tags within the HTML you submit. Simply insert the needed meta tag into the head or body of the HTML.

  <meta name="breezy-pdf-width" content="10">
Tag name Default Value Description
breezy-pdf-filename output.pdf Name of the pdf
breezy-pdf-width 8.5 PDF page width in inches
breezy-pdf-height 11 PDF page height in inches
breezy-pdf-cssPageSize false Use page size defined by CSS
breezy-pdf-marginTop 0.4 Top margin
breezy-pdf-marginRight 0.4 Right margin
breezy-pdf-marginBottom 0.4 Bottom margin
breezy-pdf-marginLeft 0.4 Left margin
breezy-pdf-landscape false Print in landscape mode
breezy-pdf-scale 1 Scale the viewport before converting to pdf
breezy-pdf-displayBackground false Render the background in the HTML is included in the PDF

View the all the configuration options and their documentation here.

2.a Header and Footer Templates

Configure the HTML template to be included at the top and bottom of every page. Include elements with the classes of date, title, pageNumber, and totalPages to have values inserted at render time. At this time, any images must be DataURI encoded and styles must be specified within the template. Defaults to no HTML.

CSS class Description
date Formatted render date displayed in UTC
title Title of the document specified by the title tag
pageNumber The count of the current page in the PDF
totalPages The total count of pages in the PDF
2.b Completion Triggers

Notify the rendering engine when your rich content has completed loading and the PDF is ready to be rendered. Most typically used when complex JavaScript needs to be evaluated. The default completion trigger is a timer of 5000ms. If multiple completion triggers, the first trigger used will be adopted based on the order in which they're specified here.

Callback

A JavaScript function in the global namespace which will be defined by the renderer. Your code will be invoke this callback when the document is ready for PDF rendering. Optional timeout can be specified in ms, defaulting to 5000ms.

<meta name="breezy-pdf-callback" content="myWorkHereIsDoneCallback">
<meta name="breezy-pdf-timeout" content="3000">
function() {
    // My hard working JS here
    window.myWorkHereIsDoneCallback();
}
Event

A JavaScript event which will be dispatched on an element when the document is ready for PDF rendering. Optional CSS element selector can be specified, defaulting to document. Optional timeout can be specified in ms, defaulting to 5000ms.

<meta name="breezy-pdf-event" content="myCustomEvent">
<meta name="breezy-pdf-element" content="#myContainer">
<meta name="breezy-pdf-timeout" content="3000">
var event = new CustomEvent('myCustomEvent');
var element = document.getElementBydId('myContainer');

element.dispatchEvent(event);
Element

The CSS selector of an element which will be inserted into the document when the document is ready for PDF rendering. Optional timeout can be specified in ms, defaulting to 5000ms.

<meta name="breezy-pdf-element" content="#last-page > #last-element">
<meta name="breezy-pdf-timeout" content="3000">
function() {
    // My hard working JS here
    var lastPage    = document.getElementById('#last-page');
    var lastElement = document.createElement('div');
    
    lastElement.id = 'last-element';
    
    lastPage.appendChild(lastElement);
}
Variable

The variable in the global namespace which will be defined when the document is ready for PDF rendering. Optional timeout can be specified in ms, defaulting to 5000ms.

<meta name="breezy-pdf-variable" content="myWorkHereIsDoneVariable">
function() {
    // My hard working JS here
    window.myWorkHereIsDoneVariable = true;
}
Timer

The predefined amount of time to wait before the document is rendered to PDF. Timer should be specified in ms, defaulting to 5000ms.

<meta name="breezy-pdf-timer" content="10000">

Deployment

Heroku

Deploy

  1. Deploy to Heroku with one-click.

Clients

Docker

docker run -it -p 5002:5002 -e "DEBUG=breezy-pdf-lite:*" -e "PORT=5002" -e "PRIVATE_TOKEN=YOURSUPERSECRETTOKEN" danielwestendorf/breezy-pdf-lite:latest

Non-Heroku

  1. Install node & yarn
  2. yarn install
  3. Set the Environment variables specified below
  4. Start the web process node index.js

Configuration

Set the Environment/Heroku Config Vars

ENV Variable Default Value Description
PRIVATE_TOKEN generated secret A private key for accessing the API.

Set DEBUG Config var to breezy-pdf-lite:* to get debugged output.

Run Tests

$ /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --interpreter none --headless --disable-gpu --disable-translate --disable-extensions --disable-background-networking --safebrowsing-disable-auto-update --disable-sync --metrics-recording-only --disable-default-apps --no-first-run --mute-audio --hide-scrollbars --remote-debugging-port=9222

$ npm test

breezy-pdf-lite's People

Contributors

danielwestendorf avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar mikemand avatar pomartel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

breezy-pdf-lite's Issues

Suggestions for speeding up generation?

This is a great project, super simple and straight-to-the-point, thank you!

I'm testing rendering times and it seems that no matter how fast the machine I run it on, small PDFs tend to take no less than 5 seconds to generate which seems like quite a while. I'm running it in Docker with no environment flags except for the token so debug overhead shouldn't be there.

Any suggestions on how to bring down the time to generate a PDF?

"TypeError: Cannot read property 'toString' of undefined" on docker run

I wanted to run server on my local machine using docker as described in README.md but it fails.
When I use tag v0.0.4 it builds fine though.

$ sudo docker run -it -p 5002:5002 -e "DEBUG=breezy-pdf-lite:*" -e "PORT=5002" -e "PRIVATE_TOKEN=YOURSUPERSECRETTOKEN" danielwestendorf/breezy-pdf-lite:latest 
Starting Google Chrome
(node:6) ExperimentalWarning: The fs.promises API is experimental
TypeError: Cannot read property 'toString' of undefined
    at Launcher.<anonymous> (/usr/src/app/node_modules/chrome-launcher/dist/chrome-launcher.js:189:64)
    at Generator.next (<anonymous>)
    at /usr/src/app/node_modules/chrome-launcher/dist/chrome-launcher.js:12:71
    at new Promise (<anonymous>)
    at __awaiter (/usr/src/app/node_modules/chrome-launcher/dist/chrome-launcher.js:8:12)
    at spawnPromise (/usr/src/app/node_modules/chrome-launcher/dist/chrome-launcher.js:174:41)
    at Launcher.<anonymous> (/usr/src/app/node_modules/chrome-launcher/dist/chrome-launcher.js:192:16)
    at Generator.next (<anonymous>)
    at /usr/src/app/node_modules/chrome-launcher/dist/chrome-launcher.js:12:71
    at new Promise (<anonymous>)
Exiting

header and footer templates not working

Hi, I'm having an issue with the header and footer print options:

  • the footer templates seems to be rendering as the header and vice versa.
  • the footer wont display page numbers and the header can't display anything!

My template tags:

<meta name="breezy-pdf-headerTemplate" content="<div class='header'><table><tr><td class='date'></td><td><span class='title'></span></td><td><span class='pageNumber'></span>/<span class='totalPages'></span></td></tr></table></div>">

<meta name="breezy-pdf-footerTemplate" content="<div class='footer'><table><tr><td class='date'></td><td><span class='title'></span></td><td><span class='pageNumber'></span>/<span class='totalPages'></span></td></tr></table></div>">

Any ideas - I thought I'd followed the docs here...

Corrupted PDFs

Hello, after getting Breezy set up on my server (CentOS 7 from https://webfaction.com), I was able to successfully run the command from the readme:

$ curl -X POST -H 'Authorization: Bearer {myTokenHere}' \
> http://localhost:5001/render/html \
> -d "`curl https://raw.githubusercontent.com/danielwestendorf/breezy-pdf-lite/master/sample.html`" \
> -o example.pdf
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 33192  100 33192    0     0  42859      0 --:--:-- --:--:-- --:--:-- 42883
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 33272  100    81  100 33191    921   368k --:--:-- --:--:-- --:--:--  368k

After downloading the file from my server to open, it looks like the PDF is corrupt.

screen shot 2018-07-27 at 12 44 08 pm

screen shot 2018-07-27 at 12 44 13 pm

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.