From d353e87ca17c42b39ebab877b485f37e908db963 Mon Sep 17 00:00:00 2001 From: Daiki Urata <7nohe.urata@gmail.com> Date: Thu, 30 Mar 2023 17:58:17 +0900 Subject: [PATCH 1/2] Add WKHTMLTOPDF to .env.example.complete --- .env.example.complete | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.env.example.complete b/.env.example.complete index f81bccae4..0ac40a90b 100644 --- a/.env.example.complete +++ b/.env.example.complete @@ -372,4 +372,10 @@ LOG_FAILED_LOGIN_CHANNEL=errorlog_plain_webserver # IP address '146.191.42.4' would result in '146.191.x.x' being logged. # For the IPv6 address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as: # '2001:db8:85a3:8d3:x:x:x:x' -IP_ADDRESS_PRECISION=4 \ No newline at end of file +IP_ADDRESS_PRECISION=4 + +# Use wkhtmltopdf to generate PDF documents instead of dompdf. +# Set the path to the wkhtmltopdf binary +# Example: WKHTMLTOPDF=/home/user/bins/wkhtmltopdf +# Refer to https://www.bookstackapp.com/docs/admin/pdf-rendering/#using-wkhtmltopdf +WKHTMLTOPDF=false \ No newline at end of file From 7505443a0c1cfd84de1be04fc6b9adc616b2060e Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Fri, 21 Apr 2023 11:54:23 +0100 Subject: [PATCH 2/2] Updated complete env wkhtml text and added advisory Added advisory to start to refer to docs for full details. Updated added WKHTMLTOPDF option text. --- .env.example.complete | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/.env.example.complete b/.env.example.complete index 0ac40a90b..f46bfccc0 100644 --- a/.env.example.complete +++ b/.env.example.complete @@ -3,6 +3,10 @@ # Each option is shown with it's default value. # Do not copy this whole file to use as your '.env' file. +# The details here only serve as a quick reference. +# Please refer to the BookStack documentation for full details: +# https://www.bookstackapp.com/docs/ + # Application environment # Can be 'production', 'development', 'testing' or 'demo' APP_ENV=production @@ -322,6 +326,13 @@ FILE_UPLOAD_SIZE_LIMIT=50 # Can be 'a4' or 'letter'. EXPORT_PAGE_SIZE=a4 +# Set path to wkhtmltopdf binary for PDF generation. +# Can be 'false' or a path path like: '/home/bins/wkhtmltopdf' +# When false, BookStack will attempt to find a wkhtmltopdf in the application +# root folder then fall back to the default dompdf renderer if no binary exists. +# Only used if 'ALLOW_UNTRUSTED_SERVER_FETCHING=true' which disables security protections. +WKHTMLTOPDF=false + # Allow