A wrapper for wkhtmltopdf (HTML to PDF) and PDFTK (adds in encryption) for use in Elixir projects. If available, it will use xvfb-run (x virtual frame buffer) to use wkhtmltopdf on systems that have no X installed, e.g. a server.
- 0.3.6
- bumped dependencies:
- porcelain 2.0.3 to support newer erlangs and remove warnings
- ex_doc 0.16 to remove warnings, remove from runtime
- removed explixit earmark
- add option to pick output pdf filename, thanks to praveenperera
- improved README on heroku, corrected typos. Thanks to jbhatab and maggy96
- bumped dependencies:
For a proper changelog, see CHANGES
Download wkhtmltopdf and place it in your $PATH. Current binaries can be found here: http://wkhtmltopdf.org/downloads.html
(optional) To use wkhtmltopdf on systems without an X window server installed,
please install xvfb-run from your repository (on Debian/Ubuntu: sudo apt-get install xvfb).
On current (2016) Macintosh computers /usr/X11/bin/xvfb should be available
and is reported to do the same thing. warning: This is untested. PLS report to
me if you ran this successfully on a Mac.
(optional) For best results, download goon and place it in your $PATH. Current binaries can be found here: https://github.com/alco/goon/releases
(optional) Install pdftk via your package manager or homebrew. The project page also contains a Windows installer
Add this to your dependencies in your mix.exs:
def application do
[applications: [
:logger,
:pdf_generator # <-- add this
]]
end
defp deps do
[
# ... whatever else
{ :pdf_generator, ">=0.3.5" }, # <-- and this
]
end
Then pass some html to PdfGenerator.generate
$ iex -S mix
html = "<html><body><p>Hi there!</p></body></html>"
# be aware, this may take a while...
{ :ok, filename } = PdfGenerator.generate html, page_size: "A5"
{ :ok, pdf_content } = File.read filename
# or, if you prefer methods that raise on error:
filename = PdfGenerator.generate! html
Or use the bang-methods:
filename = PdfGenerator.generate! "<html>..."
pdf_binary = PdfGenerator.generate_binary! "<html>..."
This module will automatically try to finde both wkhtmltopdf and pdftk in
your path. But you may override or explicitly set their paths in your
config/config.exs.
config :pdf_generator,
wkhtml_path: "/usr/bin/wkhtmltopdf", # <-- this program actually does the heavy lifting
pdftk_path: "/usr/bin/pdftk" # <-- only needed for PDF encryption
If you want to run wkhtmltopdf with an unpatched verison of webkit that requires
an X Window server, but your server (or Mac) does not have one installed,
you may find the command_prefix handy:
PdfGenerator.generate "<html..", command_prefix: "xvfb-run"
This can also be configured globally in your config/config.exs:
config :pdf_generator,
command_prefix: "/usr/bin/xvfb-run"
page_size: defaults toA4, seewkhtmltopdffor more optionsopen_password: requirespdftk, set password to encrypt PDFs withedit_password: requirespdftk, set password for edit permissions on PDFshell_params: pass custom parameters towkhtmltopdf. CAUTION: BEWARE OF SHELL INJECTIONS!command_prefix: prefixwkhtmltopdfwith some command (e.g.xvfb-run,sudo..)delete_temporary: immediately remove temp files after generationfilename- filename for the output pdf file (without .pdf extension, defaults to a random string)
If you want to use this project on heroku, you can use buildpacks instead of binaries
to load pdftk and wkhtmltopdf:
https://github.com/fxtentacle/heroku-pdftk-buildpack
https://github.com/dscout/wkhtmltopdf-buildpack
https://github.com/HashNuke/heroku-buildpack-elixir
https://github.com/gjaldon/phoenix-static-buildpack
note: The list also includes Elixir and Phoenix buildpacks to show you that they
must be placed after pdftk and wkhtmltopdf. It won't work if you load the
Elixir and Phoenix buildpacks first.
For more info, read the docs on hex or issue
h PdfGenerator in your iex shell.
ERROR
(UndefinedFunctionError) function Misc.Random.string/0 is undefined (module Misc.Random is not available)
FIX
For now, unfortunately, it's required to add misc_random to either your
included_applications section in your mix.exs (exrm) or for (distillery) add
it to your release/applications list in rel/config.exs.
...
release :your_app do
set version: current_version(:your_app)
set applications: [:misc_random]
end