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.5
- add
generate_binrayandgenerate_binary!that immediately return the PDF binary instead of an{:ok, filename}tuple. - add
generate!to immediately return the filename - some more tests
- minor change
delete_temporarymust be truthy. (the old supported value:htmlwill stil work) and will delete both intermediate HTML And PDF files in ``generate_binaryandgenerate_binary!`
- add
- 0.3.4
- BUGFIX: fix merge confusion to realy support
xvfb-runor other command prefixes to wkhtmltopdf - support explicit deletion of temporary files thanks to Edipo Vinicius da Silva
- Improve README
- BUGFIX: fix merge confusion to realy support
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 (optional) 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.0" }, # <-- 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", open_password: "s3cr3t"
{ :ok, pdf_content } = File.read file_name
# or, if you prefail methods that rais 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",
pdftk_path: "/usr/bin/pdftk"
If you happen to want to run an wkhtmltopdf with an unpatched version of webkit
that requires an X Window server - but on your server (or Mac) ain't one, you
might find a command_prefix handy:
PdfGenerator.generate "<html..", command_prefix: "xvfb-run"
This can also be configured globally in cour config/config.exs:
config :pdf_generator,
command_prefix: "/usr/bin/xvfb-run"
page_size: defaults toA4, see wkhtmltopdf for more optionsopen_password: requirespdftk, password to encrypt PDFs withedit_password: requirespdftk, sets password for edit permissions on PDFshell_params: pass custom parameters to wkhtmltopdf. CAUTION: BEWARE OF SHELL INJECTIONS!command_prefix: prefix wkhtmltopdf with some command (e.g.xvfb-run,sudo..)delete_temporary: immediately remove temp files after generation
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_ramdom 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