Differences

This shows you the differences between two versions of the page.

--- kb:common:plantuml [2022/03/17 14:19] – alexander.elbert
+++ kb:common:plantuml [2025/03/19 10:09] (current) – alexander.elbert
@@ Line 1: / Line 1: @@
 ====== PlantUML ======
+===== RAT Integration ===
+== Java ==
+  * https://www.java.com/en/download/
+== GraphViz ==
+//GraphViz is an open-source graph visualization software. It provides a program called dot. This dot program is able to generate a directed graph from a textual description.//
+You will need to add the path to the Graphviz ''bin'' directory to the ''PATH'' variable.
+{{:code:commercial:rat:install:graphviz-path.png?direct&600|}}
+<WRAP left round important 100%>
+Optionally, create an environment variable called ''GRAPHVIZ_DOT'' that points to the DOT executable.
+</WRAP>
+<WRAP left round download 100%>
+The latest release of GraphViz tested to be compatible with RAT (v4.1.1, March. 2025) is \\
+**[[https://graphviz.org/download/|windows_10_cmake_Release_graphviz-install-11.0.0-win64.exe]]** \\
+Fallback: [[https://download.hampel-soft.com/_install/graphviz-2.38.msi |graphviz-2.38.msi]] (download provided via HSE's server)
+(12.2.1 was tested and was **not** working!)
+</WRAP>
+----
+<WRAP left round tip 100%>
+For setting environment variables like ''PATH'', see the our [[kb:common:shell|**Shell dokuwiki page**]].
+</WRAP>
+----
+===== PlantUML Server via Docker (the easy way!) =====
+  - [[https://docs.docker.com/get-docker/|Install Docker]] (Linux) or Docker-Desktop (Windows). If not included, [[https://docs.docker.com/compose/install/|install Docker Compose]].
+  - Clone the "HSE PlantUML Server" docker compose script with ''git clone git@gitlab.com:hampel-soft/hse-labs/hse-plantuml-server.git''.
+  - Open a terminal in the project folder.
+  - Execute ''docker-compose up -d'' (für Compose v2: ''docker compose up -d'')
+  - Open a browser and type in ''http://localhost:8123''. The PlantUML site with an input field and some example code should be displayed.
 ===== Synology NAS Docker =====
@@ Line 8: / Line 56: @@
   - create firewall rule for that port in synology DS
   - [create port forwarding rule for that port in router]
+===== VS Code integration =====
+  - Install the extension "PlantUML".
+  - Go to the extension settings and make the following changes:
+    * **Renderer**: "PlantUMLServer"
+    * **Server**: "http://localhost:8123" (or another server URL).
+  - Open a new file and add a PlantUML script. Open the preview windows by pressing ''Alt + D''.
 ===== Notepad++ integration =====