![PlantUML Server]()
PlantUML Server
Container
Web editor and rendering server for PlantUML, turning plain-text descriptions into sequence, class, component and other diagrams as PNG, SVG or ASCII, with a link for each one you can embed in docs and wikis. Source: https://github.com/plantuml/plantuml-server
Image details
Source details
Configuration
TypeContainerlinuxplantuml/plantuml-server:jetty8380:8080/tcpunless-stoppedTemplate by NotAFlightRisk
Report issueNotes
http://<your-host>:8380. There's no login and nothing saved on the server, since each diagram is encoded into its own address, so bookmark or share the page's address to keep one. The link above the editor renders it straight into a doc or wiki, and swapping /png/ for /svg/ gives you an SVG. PNGs get cut off at 4096 pixels across while SVGs don't, so for bigger ones add PLANTUML_LIMIT_SIZE (say 16384) to the container's environment. Includes work from public web addresses, but not from local files or your own network. Docs: plantuml.com/serverStandalone Install
Select an install method, to see config/commands for deploying PlantUML Server
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select PlantUML Server, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see plantuml/plantuml-server for app-specific guidance.
PlantUML Server
Official docker image of PlantUML server over Jetty or Tomcat.How to run the server with Docker
You can run Plantuml with jetty or tomcat containerdocker run -d -p 8080:8080 plantuml/plantuml-server:jetty
docker run -d -p 8080:8080 plantuml/plantuml-server:tomcatThe server is now listing to http://localhost:8080.
Serve PlantUML Server on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying plantuml-server.example.com to http://plantuml-server:8080
Add this to your Caddyfile
plantuml-server.example.com {
reverse_proxy http://plantuml-server:8080
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs plantuml-server - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8380 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8380 - Stop the other service, or pick a different host port. In
8380:8080only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:8380. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, plantuml-server can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 8380
Image won't pull
Test the pull directly on the host: docker pull plantuml/plantuml-server:jetty
- "manifest unknown" means the tag no longer exists.
- "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm64/v8 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect plantuml-server --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Data disappears when the container is recreated
This template doesn't define any volumes, so everything plantuml-server saves lives inside the container and is lost on update or recreate.
- Add a volume mapping for plantuml-server's data folder before storing anything you care about.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on plantuml/plantuml-server
- Template not working: Open an issue on NotAFlightRisk/portainer-templates-extras
- This website not working: Open an issue on lissy93/portainer-templates
A single container
PlantUML Server runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything PlantUML Server needs bundled into one download. This template pulls plantuml/plantuml-server:jetty, which Docker fetches once (about 424 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. PlantUML Server's comes from Docker Hub, published by plantuml.
Version tags
The bit after the colon in the image name is the version tag. This one pins jetty, so every redeploy gives you that exact build until you bump it yourself.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm64/v8, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 8380:8080 means it's reachable on port 8380 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8380 in a browser. It opens:
8380:8080, likely the web interface
No stored data
This template doesn't mount any storage, so whatever PlantUML Server writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.
Restart policy
The restart policy here is unless-stopped, so Docker restarts PlantUML Server after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so PlantUML Server sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container plantuml-server. That's what you'll spot in the containers list and use in commands like docker logs plantuml-server.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
PlantUML Server is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set PlantUML Server up. Add the template list to Portainer once, then deploying PlantUML Server is a click rather than a wall of config.