Wiki source code of PDF Generator Configuration
Last modified by Eleni Cojocariu on 2026/02/05 17:22
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | When [[configuring PDF export>>documentation.xs.admin.exports.configure-pdf-export.WebHome]], you have the option to choose the tool to use for generating PDFs: | ||
| 2 | |||
| 3 | {{image reference="generator-dropdown.png" size="medium" alt=""/}} | ||
| 4 | |||
| 5 | |=The tool used as a PDF Generator|=Description|=Image | ||
| 6 | |User Browser|This is the default setting, it generates the PDF using the user's web browser on the client side. The main advantage of this approach is that it doesn't require any external services (such as Docker or a remote headless Chrome). However, a downside is that different users, depending on their web browser or its version, may experience variations in the final PDF output|{{image reference="user-browser-generator.png" size="large" alt=""/}} | ||
| 7 | |[[Chrome Docker Container>>extensions:Extension.PDF Export Application.WebHome||anchor="HChromeDockerContainer"]]|The PDF can also be generated on the server side using a headless Chrome web browser running inside a Docker container. The application automatically handles the following tasks:((( | ||
| 8 | * Pulling the correct Docker image if it is not found locally. | ||
| 9 | * Creating and starting the container if no existing container is available. | ||
| 10 | * Stopping the container when XWiki shuts down, if the container was created by XWiki. | ||
| 11 | )))|{{image reference="chrome-docker-container-generator" size="large" alt=""/}} | ||
| 12 | |[[Remote Chrome Generator>>extensions:Extension.PDF Export Application.WebHome||anchor="HRemoteChrome"]]|If you don't want to rely on Docker, or you don't want to give XWiki access to Docker for security reasons, but you still want to perform the PDF export on the server side then you also have the option to connect to a remote Chrome instance. |{{image reference="remote-chrome-generator" size="large" alt=""/}} | ||
| 13 | |||
| 14 | For both the Chrome Docker Container and the Remote Chrome generators, you can specify the base URI that the remote (headless) Chrome browser uses to access XWiki when generating PDFs (in particular, the print preview page). The host (domain name or IP address) is required. The scheme (e.g., ##HTTP## or ##HTTPS##) and the port (e.g., ##8080##) are optional and, if not provided, default to the values from the URL used to trigger the export. This setting replaces the deprecated XWiki Host configuration (##export.pdf.xwikiHost##). |
