Updated complete env wkhtml text and added advisory

Added advisory to start to refer to docs for full details.
Updated added WKHTMLTOPDF option text.
This commit is contained in:
Dan Brown 2023-04-21 11:54:23 +01:00
parent d353e87ca1
commit 7505443a0c
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9

View File

@ -3,6 +3,10 @@
# Each option is shown with it's default value. # Each option is shown with it's default value.
# Do not copy this whole file to use as your '.env' file. # 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 # Application environment
# Can be 'production', 'development', 'testing' or 'demo' # Can be 'production', 'development', 'testing' or 'demo'
APP_ENV=production APP_ENV=production
@ -322,6 +326,13 @@ FILE_UPLOAD_SIZE_LIMIT=50
# Can be 'a4' or 'letter'. # Can be 'a4' or 'letter'.
EXPORT_PAGE_SIZE=a4 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 <script> tags in page content # Allow <script> tags in page content
# Note, if set to 'true' the page editor may still escape scripts. # Note, if set to 'true' the page editor may still escape scripts.
ALLOW_CONTENT_SCRIPTS=false ALLOW_CONTENT_SCRIPTS=false
@ -373,9 +384,3 @@ LOG_FAILED_LOGIN_CHANNEL=errorlog_plain_webserver
# For the IPv6 address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as: # For the IPv6 address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as:
# '2001:db8:85a3:8d3:x:x:x:x' # '2001:db8:85a3:8d3:x:x:x:x'
IP_ADDRESS_PRECISION=4 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