Wiki source code of Configure PDF Conversion with Docker
Last modified by Vincent Massol on 2026/08/30 19:36
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Docker is the default way the LaTeX extension compiles an exported package into a PDF, and the one to use wherever Docker can be installed. [[PDF Conversion>>doc:documentation.extensions.admin.latex.pdf-conversion.WebHome]] explains how it compares with the local process converter and what it gives you. | ||
| 2 | |||
| 3 | 1. Install [[Docker>>https://docs.docker.com/get-docker/]] on the server machine where XWiki runs. | ||
| 4 | 1. Make sure the XWiki process can reach the Docker daemon. On some operating systems this means defining the ##DOCKER_HOST## environment variable in the environment XWiki is started in: without it the extension does not find Docker even though Docker itself is installed and running. | ||
| 5 | 1. Restart XWiki, then open the export dialog of any page. **PDF (LaTeX)** is now offered alongside the other formats.((( | ||
| 6 | {{image reference="pdf-latex-export-entry.png" size="large" alt="The Export dialog listing the export formats, with PDF (LaTeX) highlighted"/}} | ||
| 7 | |||
| 8 | Nothing else has to be configured: ##latex.pdf.export.hint## already defaults to ##docker##, and so do the image and the commands — [[Configuration Properties>>doc:documentation.extensions.admin.latex.configuration.WebHome]] lists them. | ||
| 9 | |||
| 10 | The restart is not optional: the extension [[checks the converter only when it starts>>doc:documentation.extensions.admin.latex.pdf-conversion.WebHome]]. | ||
| 11 | ))) | ||
| 12 | 1. Export a page to **PDF (LaTeX)** to confirm that the converter really compiles, and not just that the entry is there.((( | ||
| 13 | {{image reference="pdf-export-finished.png" size="large" alt="A finished PDF (LaTeX) export, reporting that the export can now be downloaded"/}} | ||
| 14 | |||
| 15 | Expect this first export to take a while, for the reason given in [[PDF Conversion>>doc:documentation.extensions.admin.latex.pdf-conversion.WebHome]]. | ||
| 16 | ))) |
