Configuration Properties
Last modified by Vincent Massol on 2026/10/21 19:09
Content
Reference
The PlantUML Macro is configured in xwiki.properties and in the "PlantUML" section of the wiki administration. What these settings control is explained in PlantUML.
Properties in xwiki.properties
Changes apply after XWiki is restarted.
| Property | Default | What it does |
|---|---|---|
| plantuml.server | None | URL of the PlantUML server generating the diagrams, used when the "PlantUML" administration section has no server. |
| plantuml.format | png | Default output format of the diagrams: png, svg or txt. An unknown value means png. The format parameter of the macro overrides it. |
| plantuml.securityProfile | SANDBOX | PlantUML Macro 2.5+ PlantUML security profile used when XWiki generates the diagrams itself, for example ALLOWLIST. An unknown value means SANDBOX. |
| plantuml.server.connectTimeout | 10 | PlantUML Macro 2.5+ Seconds to wait for the connection to the PlantUML server. |
| plantuml.server.responseTimeout | 30 | PlantUML Macro 2.5+ Seconds to wait for data from the PlantUML server. |
| plantuml.server.maxResponseSize | 10485760 (10 MB) | PlantUML Macro 2.5+ Maximum size, in bytes, of a diagram returned by the PlantUML server. |
For example:
plantuml.server=https://plantuml.example.com
plantuml.format=svg
plantuml.server.responseTimeout=60Administration Section
| Field | Default | What it does |
|---|---|---|
| "PlantUML Server" | Empty | URL of the PlantUML server generating the diagrams of the current wiki. Takes precedence over plantuml.server. Stored in the hidden page PlantUML.PlantUMLConfig, which only wiki administrators can edit. |
FAQ
Why does the macro display "PlantUML uses the security profile [...] instead of the configured one"?
Another extension started PlantUML first, with another profile, and PlantUML reads its profile only once. Restart XWiki, or use a PlantUML server.
Why does the macro display "exceeds the maximum allowed size"?
The diagram returned by the PlantUML server is larger than plantuml.server.maxResponseSize. Raise that property.
