Gotenberg Rails
Render Rails HTML as PDFs with Gotenberg.
Installation
Add the gem to your Gemfile:
gem "gotenberg-rails"Run Gotenberg:
docker run --rm -p 3000:3000 gotenberg/gotenberg:8Usage
Render a PDF from a Rails controller:
def show
respond_to do |format|
format.html
format.pdf do
render gotenberg_pdf: {}, disposition: :inline, filename: "invoice.pdf"
end
end
endCustomize the rendered template and Gotenberg options:
def show
render gotenberg_pdf: {
print_background: true,
paper_width: "8.27",
paper_height: "11.7",
margin_top: "0.4",
margin_bottom: "0.4",
margin_left: "0.4",
margin_right: "0.4"
},
layout: "pdf",
template: "invoices/show",
disposition: :inline,
filename: "invoice.pdf"
endYou can also render directly:
Gotenberg::Rails.render_pdf(html: html)
Gotenberg::Rails.render_pdf(html: html, display_url: "https://example.com/invoice")
Gotenberg::Rails.render_pdf(url: "https://example.com/invoice")When rendering HTML, display_url is used to rewrite relative image, link, JavaScript, stylesheet, and CSS url(...) references to absolute URLs before sending the HTML to Gotenberg. Controller rendering uses request.original_url automatically.
Options are sent to Gotenberg as Chromium form fields. Ruby-style snake case keys are converted to Gotenberg camel case keys:
Gotenberg::Rails.render_pdf(
html: html,
pdf_options: {
print_background: true,
emulated_media_type: "screen",
wait_delay: "2s",
fail_on_http_status_codes: [499, 599],
metadata: { Title: "Invoice" }
}
)Configuration
Gotenberg::Rails.configure do |config|
config.endpoint = ENV.fetch("GOTENBERG_ENDPOINT", "http://gotenberg:3000")
config.open_timeout = 5
config.request_timeout = 30
config.headers = { "X-Request-Source" => "rails" }
config.pdf_options = {
print_background: true,
prefer_css_page_size: true
}
endGotenberg receives rendered HTML as an index.html upload. Use absolute URLs for stylesheets, images, and fonts that Gotenberg must fetch from your Rails app.
License
The gem is available as open source under the terms of the MIT License.