https://github.com/dkd/plantuml
PlantUML Plugin for Redmine
https://github.com/dkd/plantuml
plantuml redmine redmine-plugin
Last synced: 5 months ago
JSON representation
PlantUML Plugin for Redmine
- Host: GitHub
- URL: https://github.com/dkd/plantuml
- Owner: dkd
- License: mit
- Created: 2015-08-05T12:20:07.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-16T17:42:47.000Z (over 3 years ago)
- Last Synced: 2025-10-03T01:33:12.845Z (8 months ago)
- Topics: plantuml, redmine, redmine-plugin
- Language: Ruby
- Size: 29.3 KB
- Stars: 51
- Watchers: 25
- Forks: 42
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PlantUML Redmine plugin
This plugin will allow adding [PlantUML](http://plantuml.sourceforge.net/) 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](http://localhost:3000/settings/plugin/plantuml) 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`
## using !include params
Since all files are written out to the system, there is no safe way to prevent editors from using the `!include` command inside the code block.
Therefore every input will be sanitited before writing out the .pu files for further interpretation. You can overcome this by activating the `Setting.plugin_plantuml['allow_includes']`
**Attention**: this is dangerous, since all files will become accessible on the host system.
## Known issues
- PlantUML diagrams are not rendered inside a PDF export, see https://github.com/dkd/plantuml/issues/1
## TODO
- add image caching