README.md

#PlantUML Redmine plugin

This plugin will allow adding PlantUML diagrams into Redmine.

##Requirements

• Java
• PlantUML binary

Installation

• create a shell script in /usr/bin/plantuml

#!/bin/bash
/usr/bin/java -Djava.io.tmpdir=/var/tmp -Djava.awt.headless=true -jar /PATH_TO_YOUR_PLANTUML_BINARY/plantuml.jar ${@}

• copy this plugin into the Redmine plugins directory

Usage

• go to the plugin settings page and add the PlantUML binary path /usr/bin/plantuml
• PlantUML diagrams can be added as follow:

{{plantuml(png)
  Bob -> Alice : hello
}}

{{plantuml(svg)
  Bob -> Alice : hello
}}

• you can choose between PNG or SVG images by setting the plantuml macro argument to either png or svg

TODO

• add image caching