Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.37 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.37 KB

express-electron-pdf

An Express server wrapped around @fraserxu's excellent Electron PDF.

Currently takes a minute or two to generate a PDF – probably due to the fact that this is spinning up a new instance of Electron (Chromium) with every request.

This project is a work in progress and isn't feature-complete (or bug-free!) yet. Pull requests welcome!

Getting started

Use Docker.

docker pull properdesign/express-electron-pdf

docker run -d -e "PORT=8080" -e "TOKEN=yoursecrettoken" --name=express-electron-pdf -p 8080:8080 properdesign/express-electron-pdf

Generating a PDF

Assuming that you're running this on localhost...

Basic usage

Downloads a PDF called output.pdf.

http://localhost:8080/?token=yoursecrettoken&url=http://yoursite.com

Specify a filename

You can specify your own filename (without the PDF extension) using filename=yourcustomfilename.

http://localhost:8080/?token=yoursecrettoken&url=http://yoursite.com&filename=yourcustomfilename

To-do

  • Custom stylesheets
  • Handling for multiple displays using xvfb-run -a [mycommand]
  • General making it a more full-functioning webserver, handling bum requests etc.
  • Handling for multiple files being generated at the same time
  • Handline for HTTP auth (will be useful for WP admin requests etc.)