User Tools

Site Tools


kb:common:plantuml

PlantUML

Local Rendering

For local rendering of PlantUML diagrams into image files (eg. from our Release Automation Tools), additional tools are required. One option is using Graphviz.


Notepad++ Integration

The following paragraphs use npp as an abbreviation for Notepad + +

Installing PlantUML for //npp//

   @echo off
   java -jar Z:\plantUML\plantuml.jar -charset UTF-8 -o "C:\Users\Public\Pictures" %1
  1. Menu execute –> run external program
    1. insert cmd PathToYour\PlantUML\plantuml.bat “$(FULL_CURRENT_PATH)”

Previewing Diagrams

PlantUmlViewer: A plugin to generate, view and export PlantUML diagrams.

  • Use the built-in Plugins Admin to install it directly.
  • Just open npp and navigate to Plugins > Plugins Admin.
  • Here under the Available tab, search for PlantUML Viewer.
  • After checking the corresponding box, click Install at the top right corner of the window.

Syntax Highlighting

PlantUML_Notepad-_UDL: A user defined language (UDL) for npp to support the PlantUML language syntax.

  1. Download UDL from URL above
  2. move UDL to folder for import
    1. %AppData%\Notepad++\userDefineLangs
  3. restart npp

VS Code Integration

  1. Install the extension “PlantUML”.
  2. Go to the extension settings and make the following changes:
  3. Open a new file and add a PlantUML script.
  4. Open the preview windows by pressing Alt + D.

PlantUML Server

Docker locally (the easy way!)

  1. Install Docker (Linux) or Docker-Desktop (Windows). If not included, install Docker Compose.
  2. Clone the “HSE PlantUML Server” docker compose script with git clone git@gitlab.com:hampel-soft/hse-labs/hse-plantuml-server.git.
  3. Open a terminal in the project folder.
  4. Execute docker-compose up -d (für Compose v2: docker compose up -d)
  5. Open a browser and type in http://localhost:8123. The PlantUML site with an input field and some example code should be displayed.

Docker on Synology NAS

  1. in docker webinterface register & download plantuml/plantuml-server
  2. under image start image
  3. configure a local port
  4. create firewall rule for that port in synology DS
  5. [create port forwarding rule for that port in router]
kb/common/plantuml.txt · Last modified: 2026/07/14 15:57 by joerg.hampel