]> BookStack Code Mirror - bookstack/commitdiff
Updated complete env wkhtml text and added advisory
authorDan Brown <redacted>
Fri, 21 Apr 2023 10:54:23 +0000 (11:54 +0100)
committerDan Brown <redacted>
Fri, 21 Apr 2023 10:54:23 +0000 (11:54 +0100)
Added advisory to start to refer to docs for full details.
Updated added WKHTMLTOPDF option text.

.env.example.complete

index 0ac40a90b7e4527581a98880a5b3cbe160659f1b..f46bfccc02ae8b84a0eef374b83c6c004c11c594 100644 (file)
@@ -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 <script> tags in page content
 # Note, if set to 'true' the page editor may still escape scripts.
 ALLOW_CONTENT_SCRIPTS=false
@@ -372,10 +383,4 @@ 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
-
-# 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
+IP_ADDRESS_PRECISION=4
\ No newline at end of file