Installation

Owned by Christoph Giess
Last updated: 19.09.2023 by Michael Griffel
2 min read

The PlantUML Confluence Plugin depends on the Graphviz package. Please ensure that you have installed the package on your Confluence system. The package must be installed on every node in the Confluence cluster.

Please note that not all versions of the Graphviz package are supported and that you maybe have to restart Confluence if you updated the Graphviz package after starting Confluence! 

The Plugin requires JRE 1.6.x or higher (see also Supported+Platforms).

After the installation of the plugin you should check if the plugin was successfully initialized by adding the PlantUML macro with the body "version". Have a look at the section 'Note to Users of Confluence 3 and 4' if you are running an older Confluence version.

This should result in a page that looks similar to the following output:

Note to Users upgrading from Confluence 7 of Confluence 8

The macros Macro database-info and Macro database-structure were removed because defining data sources using the JNDI context is outdated and causes some problems with Java 11.
The default output format is now SVG (instead of PNG). You can change that in the plugin configuration

Plugin Configuration cannot be read from previous installations! If you made some changes in the plugin configuration please export them before upgrading the plugin. The plugin configuration settings was changed because the ‘old BandanaManager-way’ did not work with Confluence 8 anymore.

  • Plugin for Confluence 7.x supports still Java 8 (and Java 11).
  • Plugin for Confluence 8.x requires Java 11!


Note to Users of Confluence 3 and 4

The PlantUML Confluence Plugin works with Confuence 3.1 and newer.

However, version 4 of the plugin adds some modules that require Confluence 4 (xhtml support). Version 5 of the plugin adds some modules that require Confluence 5 (blueprints).

You will notice that when you install or update the plugin. You will likely get an error message like This add-on has one or more modules with missing dependencies. If the plugin is not enabled after installation/update. try to enable it manually.

The following screenshots show the correct installation of the PlantUML Plugin 5.x in Confluence 3 and 4.

PlantUML Plugin installed in Confluence 3

PlantUML Plugin installed in Confluence 4