How to deploy PlantUML Server on Kubernetes?

Use the provided Docker images (jetty or tomcat) and create a Kubernetes deployment YAML, setting environment variables for configuration. Examples in the GitHub repository show reverse proxy setups that can be adapted.

PlantUML Server vs running PlantUML locally with CLI?

PlantUML Server offers a web interface and shared access for teams, while local CLI is better for individual scripting. Server adds deployment overhead but provides accessibility and integration via HTTP endpoints.

Can I use PlantUML Server with GitLab CI for automated diagrams?

Yes, by deploying the server and using its endpoints in CI scripts to generate diagrams from text. However, it requires self-hosting the server, which adds infrastructure management compared to cloud services.

How to secure PlantUML Server in production?

Set the PLANTUML_SECURITY_PROFILE to INTERNET and use allowlists for additional access. Avoid lowering the security profile below INTERNET, and configure reverse proxies with authentication if needed.

PlantUML Server performance issues with large diagrams?

Performance can be limited by the PLANTUML_LIMIT_SIZE setting (default 4096). Increase this via environment variables, but note that very complex diagrams may slow down generation due to Java processing overhead.

How to customize the PlantUML Server web interface?

The web UI is built-in and not highly customizable out of the box. For major changes, you would need to modify the source code or use external tools to skin the output, as the README focuses on configuration rather than UI tweaks.

Open-Awesome

Plantuml

GPL-3.0Javav1.2026.6

A web application that generates UML diagrams from text descriptions on-the-fly.

Visit Website GitHub

2.2k stars572 forks0 contributors

What is Plantuml?

PlantUML Server is a web application that generates UML diagrams from text-based descriptions in real-time. It solves the problem of manually creating and updating diagrams by automating the process through a simple web interface. The server renders diagrams on-the-fly, making it easy to integrate into documentation or development workflows.

Target Audience

Software developers, architects, and technical writers who need to create and maintain UML diagrams as part of their design documentation or codebase.

Value Proposition

Developers choose PlantUML Server for its ease of deployment, self-hosting capabilities, and seamless integration with existing tools via a web interface. It eliminates the need for standalone diagramming software by providing a lightweight, server-based solution.

Overview

PlantUML Online Server

Use Cases

Best For

Generating UML diagrams directly from text descriptions in documentation
Self-hosting a diagramming service for internal team use
Integrating UML generation into CI/CD pipelines or automated workflows
Creating diagrams in restricted environments using read-only Docker containers
Visualizing software architecture during design discussions
Embedding dynamic diagrams in wikis or internal tools via reverse proxy

Not Ideal For

Projects requiring real-time collaborative diagram editing with multiple users simultaneously
Environments where Java runtime is unavailable or prohibited due to licensing or resource constraints
Use cases needing diagram types beyond UML, such as complex custom graphics or interactive diagrams
Teams seeking a fully managed, cloud-based diagramming service without self-hosting maintenance

Pros & Cons

Pros

Web-Based Interface

Provides a user-friendly web UI for creating and editing PlantUML diagrams directly in the browser, with examples and features documented in the docs/WebUI directory.

Docker Deployment Flexibility

Supports deployment via Docker containers with Jetty and Tomcat options, including a read-only mode for restricted environments like OpenShift, as shown in the Docker run commands.

Configurable Security Profiles

Implements security through the PLANTUML_SECURITY_PROFILE environment variable, with default internet-safe settings and allowlist features for controlled access, detailed on plantuml.com/security.

Customizable via Environment Variables

Allows setting various options like BASE_URL, PLANTUML_LIMIT_SIZE, and proxy settings through environment variables, enabling easy integration and customization for different deployments.

Cons

Java and Maven Dependency

Requires jre/jdk 17 or above and Apache Maven for local builds and runs, adding setup complexity compared to purely containerized or lightweight alternatives.

Breaking Changes in Updates

Has experienced breaking changes, such as the removal of ALLOW_PLANTUML_INCLUDE in version v1.2023.9, which can disrupt existing deployments and require migration efforts.

Limited to PlantUML Syntax

Specifically designed for PlantUML, so if users need unsupported diagram types or advanced graphical editing beyond text-based generation, they must use additional tools.

Frequently Asked Questions

Related Projects

Architecture_Decision_Record

Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation

Stars16,509

Forks2,780

Last commit12 days ago

vscode-drawio

This unofficial extension integrates Draw.io (also known as diagrams.net) into VS Code.

Python Module Dependency graphs

Stars2,105

Forks134

Last commit4 days ago

cpp-dependencies

Tool to check C++ #include dependencies (dependency graphs created in .dot format)

Stars779

Forks85

Last commit6 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub