Plugins Directory » plantuml

18883 Author: Michael Skrynski
Website: https://github.com/dkd/plantuml
Code repository: https://github.com/dkd/plantuml
Registered on: 2015-08-05 (almost 7 years ago)
Current version: 0.4.1
Compatible with: Redmine 3.4.x, 3.3.x, 3.2.x, 3.1.x
User ratings:   (9)

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

Changelog

0.4.1 (2017-08-01)

Compatible with Redmine 3.4.x, 3.3.x, 3.2.x, 3.1.x.

Sanitize input to prevent the inclusion of any file on the system

0.3.0 (2015-08-13)

Compatible with Redmine 3.1.x, 3.0.x, 2.6.x.

0.2.0 (2015-08-05)

Compatible with Redmine 3.0.x, 2.6.x.

User ratings

  by shawn freeman 12 months ago

We used to use this all the time (old Redmine server), but it doesn't work anymore. Any plans for a 4.x update/version?

Thanks!

  by Stephen Bennett almost 4 years ago

Windows: plantuml.bat:

"C:\Program Files (x86)\Common Files\Oracle\Java\javapath\java.exe" -Djava.io.tmpdir="C:\Bitnami\redmine-3.4.6-0\apps\redmine\htdocs\plugins\plantuml\tmp" -Djava.awt.headless=true -jar "\plantuml.jar" %*

  by 峰 王 almost 5 years ago

How to use it on Windows?

  by holly chen about 5 years ago

great plugin, great plantuml!
works fine on 3.3

  by Anton Titkov over 5 years ago

Great tool!!
Works perfect on redmine 3.3.1 (I have removed limitation of versions from init.rb)

  by Ricard Siliuk almost 6 years ago

Great plugin, using in for a while now.
And someone should update it to work with Redmine 3.3. Changed init.rb to allow newest version, works without hiccups in test environment. Good work!

  by Alejandro Ramirez about 6 years ago

The Plug-In sounds really good. but there are no Windows installation instructions. Does someone have detailed instructions of how to install it ? Thank you!

  by Amir S almost 7 years ago

Thank you!! Great work!

  by Martin Hartung almost 7 years ago

A really helpful little plugin if you already work with plantUML diagrams anyway.