wkhtmltopdf as a web service

A dockerized webservice written in Go that uses wkhtmltopdf to convert HTML into documents (images or pdf files).

Docker

build

docker build -t jayknoxqu/go-wkhtmltopdf:alpine3.8 .

run

docker run -d --name go-wkhtmltopdf -p 8080:80 jayknoxqu/go-wkhtmltopdf:alpine3.8

Usage

The service listens on port 80 for POST requests on the root path (/). Any other method returns a 405 not allowed status. Any other path returns a 404 not found status.

The body should contain a JSON-encoded object containing the following parameters:

url: The URL of the page to convert.
output: The type of document to generate, can be either jpg, png or pdf. Defauts to pdf if not specified. Depending on the output type the appropriate binary is called.
options: A list of key-value arguments that are passed on to the appropriate wkhtmltopdf binary. Boolean values are interpreted as flag arguments (e.g.: --greyscale).
cookies: A list of key-value arguments that are passed on to the appropriate wkhtmltopdf binary as separate cookie arguments.
fileName: The name of the download file.

Example: get the following JSON as request param param:

{
  "url": "http://www.google.com",
  "options": {
    "margin-bottom": "1cm",
    "orientation": "Landscape",
    "disable-smart-shrinking":true
  },
  "cookies": {
    "foo": "bar",
    "baz": "foo"
  },
  "output":"pdf",
  "fileName:"test"
}

http://localhost:80/?param=jsonValue and the jsonValue need urlEncode first.

will have the effect of the following command-line being executed on the server:

/usr/local/bin/wkhtmltopdf --margin-bottom 1cm --orientation Landscape --cookie foo bar --cookie baz foo http://www.google.com -

The - at the end of the command-line is so that the document contents are redirected to stdout so we can in turn redirect it to the web server's response stream.

When using jpg or png output, the set of options you can pass are actually more limited. Please check wkhtmltopdf usage docs or rather just use wkhtmltopdf --help or wkhtmltoimage --help to get help on the available command-line arguments.

multiple urls

support for multiple urls combined in one PDF

Example:

{
  "urls": {
    "http://www.google.com",
    "http://www.reddit.com",
  },
  "options": {
    "margin-bottom": "1cm",
    "orientation": "Landscape",
    "grayscale": true
  },
  "cookies": {
    "foo": "bar",
    "baz": "foo"
  }
}

reference

https://github.com/Surnet/docker-wkhtmltopdf

https://github.com/mickaelperrin/docker-wkhtmltopdf-service

yhan219 / go-wkhtmltopdf