Admin Documentation

PDF Rendering

By default BookStack uses Dompdf to export pages as PDF documents. The benefit of using DomPDF is that it doesn’t require any additional installation or setup but the rendering capabilities are somewhat limited.

As an alternative you can use wkhtmltopdf to generate PDF documents instead. wkhtmltopdf uses the Qt WebKit rendering engine to provide a more accurate overall result.

Using wkhtmltopdf

Pre-compiled binaries for wkhtmltopdf can be found on the downloads page of their website. BookStack will check for a file named wkhtmltopdf at the base folder of a BookStack install. If found it will use that to render PDF’s. If that does not exist it will check for a WKHTMLTOPDF variable in the .env file. You can use this variable to set an alternate location to wkhtmltopdf:

# In .env file

If neither of those exist Dompdf will be used instead.

Note: as of BookStack v21.08 you’ll need to also enable untrusted server fetching in your .env file like below. This change was made for security since, in many cases, wkhtmltopdf will perform fetches to external URLs which may be defined by users. You should only enable the below option in environments where only trusted users can export content.