PlantUML diagram server setup guide - PlantUML for Confluence
Introduction
AppsFoundry's PlantUML for Confluence app allows you to create and integrate UML diagrams into Confluence pages. Setting up a self-managed PlantUML server can enhance security and performance. This guide covers setting up both a PlantUML PicoWeb Server and a full PlantUML Server on a JEE 5 web server.
Requirements
PlantUML.jar file (for PicoWeb Server) or plantuml.war file (for JEE 5 server)
SSL certificate for HTTPS setup
Reverse proxy like Nginx (for PicoWeb Server)
Tomcat 10 (for JEE 5 server)
Steps for Setup
PlantUML PicoWeb Server Installation:
Download PlantUML.jar:
Obtain
plantuml.jar
from the PlantUML website.
Run PlantUML PicoWeb Server:
Open a command line interface.
Navigate to the
plantuml.jar
location.Start the server:
java -jar plantuml.jar -picoweb
Testing the Server Locally:
Access
http://127.0.0.1:8080
in a web browser.
Expose the Server to the Internet:
Utilize a reverse proxy like Nginx.
Configure HTTPS using your SSL certificate.
Customizing Server Configuration (Optional):
Modify port and bind address settings.
Interactive Interface and Diagram Generation:
Enter and submit diagram descriptions.
Generate PNG or SVG files.
PlantUML JEE Server Installation:
Download PlantUML.war:
Download
plantuml.war
from the PlantUML website.
Install on JEE 5 Web Server:
Copy
plantuml.war
into thewebapps
folder of your Tomcat 10 server.
Note on Compatibility:
PlantUML Server requires Tomcat 10 due to the transition from
javax.*
tojakarta.*
.It is not compatible with Tomcat 6/7/8/9.
Integration with PlantUML for Confluence App
Adjust the PlantUML for Confluence app settings to use your externally accessible, HTTPS-secured server by configuring the Custom URL in the apps settings, found under:Confluence Administration
→ PlantUML for Confluence
For more information, checkout Custom URL for diagram generation - PlantUML for Confluence
Source Code and Further Information
PlantUML Server is open source. The code for the server is available at PlantUML Server GitHub.
The information on this page is based on the official PlantUML documentation, found here:
Conclusion
Your self-managed PlantUML server, either through PicoWeb or a full JEE 5 server, is now ready for use with the PlantUML for Confluence app. This setup ensures better control over your UML diagrams' security and performance. For additional support, consult the respective documentation for PlantUML, AppsFoundry, Nginx, and Tomcat 10.