]> BookStack Code Mirror - website/blobdiff - content/docs/admin/pdf-rendering.md
Made doc updates for v24.10 release
[website] / content / docs / admin / pdf-rendering.md
index e02d45a4677c1265843b5aa57fcf979f62234745..ae2324eafde46abb7682795acfdc70e7231354d8 100644 (file)
@@ -42,13 +42,22 @@ EXPORT_PDF_COMMAND="/scripts/convert.sh {input_html_path} {output_pdf_path}"
 
 Below you can find some examples using this for specific PDF generation options.
 
+**Timeout**
+
+By default BookStack will wait for 15 seconds before reaching a timeout, at which point it'd consider the export process as failed, but this can be configured like so:
+
+```bash
+# Allow 30 seconds for the export process instead of the default 15
+EXPORT_PDF_COMMAND_TIMEOUT=30
+```
+
 **Considerations**
 
 - Security is a significant concern for this option and process. Input HTML will include user-editable data, and is not assured to be trustworthy & safe. Ideally, any networking or filesystem access would be disabled/prevented during conversion.
 - BookStack will attempt to embed required images into the HTML data as base64 data URIs to avoid external fetching.
 - BookStack will embed CSS styling into the HTML data.
 - Use of this option requires running a process from PHP, which can be considered risky and may potentially be blocked by configuration, environment and/or systems like SELinux by default.
-- BookStack sets a timeout of 15 seconds for this command to return.
+- BookStack sets a default timeout of 15 seconds for this command to return, unless altered as shown above.
 - BookStack will use the return status code of the command as an indicator of failure/success, while also checking that the output PDF was written to.
 
 #### Example: Weasyprint Command Option