Wiki source code of Use a PlantUML Server
Last modified by Vincent Massol on 2026/10/21 20:29
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Make a PlantUML server generate the diagrams of the wiki instead of XWiki itself. To decide whether you need one, read [[PlantUML>>doc:documentation.extensions.admin.plantuml.WebHome]]. | ||
| 2 | |||
| 3 | 1. Install a [[PlantUML server>>https://plantuml.com/starting]] that XWiki can reach, for example with Docker:((( | ||
| 4 | {{code language="bash"}} | ||
| 5 | docker run -d -p 8081:8080 plantuml/plantuml-server:jetty | ||
| 6 | {{/code}} | ||
| 7 | ))) | ||
| 8 | 1. Add the domain of the server to the trusted domains in ##xwiki.properties##, and restart XWiki:((( | ||
| 9 | {{code language="properties"}} | ||
| 10 | url.trustedDomains=plantuml.example.com | ||
| 11 | {{/code}} | ||
| 12 | ))) | ||
| 13 | 1. Open the wiki administration, go to the "PlantUML" section, added by the [[PlantUML Administration>>doc:extensions:Extension.PlantUML.PlantUMLAdministration.WebHome]] extension, enter the URL of the server in "PlantUML Server" and click "Save".((( | ||
| 14 | {{image reference="administration-plantuml-server.png" size="extra" alt="PlantUML section of the wiki administration with the PlantUML Server field highlighted"/}} | ||
| 15 | ))) | ||
| 16 | 1. View a page holding a PlantUML diagram. The diagram is generated by the server.((( | ||
| 17 | {{image reference="server-dot-diagram.png" size="large" alt="GraphViz diagram generated by the PlantUML server, with three nodes linked by arrows"/}} | ||
| 18 | ))) |
