Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw


PlantUML PicoWeb Server

Many plugins take advantage of the online web server to generate images.

For some reasons (security, performance...) you may need to use your own local server instead. This is possible thanks to the PlantUML Server which is available here.

However, installing and configuring a full webserver may be too complex for some users so we have decided to integrated a tiny webserver inside plantuml.jar.

This means that you only need a Java Runtime Environment and plantuml.jar to run this very simple web server.

Running the server

Running the server is pretty simple. You just have to launch:

java -jar plantuml.jar -picoweb

By default, this server runs on port 8080. You can change the port this way:

java -jar plantuml.jar -picoweb:8000

The server is really basic. It only understand GET requests with following patterns:

  • /plantuml/png/xyz....
  • /plantuml/svg/xyz....

Those GET requests are used by various PlantUML plugins. Once you have launched your server, you can simply test it. With any web browser, you just have to point to: http://127.0.0.1:8080.

This way, you can very easily any plugin which needs some PlantUML HTTP server without the official online server.


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.