octoleo/plantuml-server
1
0
Fork 0
mirror of https://github.com/octoleo/plantuml-server.git synced 2024-12-22 08:48:54 +00:00
Code Issues Releases Wiki Activity
PlantUML Online Server
249 Commits 5 Branches 70 Tags 12 MiB
Java 73.4%
JavaScript 21.1%
CSS 4.4%
HTML 0.7%
Shell 0.4%
c4ace921cd
Go to file
morotti c4ace921cd build the war file with travis. 
automatically add the generated war to github releases.
split the docker build in stages to run in parallel and only if the build succeeded.
2019-03-30 23:45:15 +00:00
screenshots Add a screenshot 2015-03-29 18:59:42 +01:00
src version 1.2019.4 2019-03-29 21:53:36 +01:00
.dockerignore Keep the Docker build context small 2018-11-15 21:29:32 +09:00
.gitignore [TASK] Ignore eclipse checkstyle plugin file 2014-02-15 19:20:30 +01:00
.travis.yml build the war file with travis. 2019-03-30 23:45:15 +00:00
COPYING Add GPLv3 License 2014-11-27 10:06:30 +01:00
Dockerfile Add new docker images 2017-04-28 10:53:11 +02:00
Dockerfile.armv8a add Dockerfile for armv8a 2017-08-27 17:24:06 +08:00
Dockerfile.jetty Use ROOT as the BASE_URL 2018-12-03 18:54:18 +09:00
Dockerfile.tomcat Use ROOT as the BASE_URL 2018-12-03 18:54:18 +09:00
pom.xml version 1.2019.4 2019-03-29 21:53:36 +01:00
README.md Fix typo 2017-12-18 14:34:23 +01:00

README.md

PlantUML Server

Build Status Docker Pull PlantUML Server is a web application to generate UML diagrams on-the-fly.

To know more about PlantUML, please visit http://plantuml.com/.

Requirements

  • jre/jdk 1.6.0 or above
  • apache maven 3.0.2 or above

How to run the server

Just run:

mvn jetty:run

The server is now listing to http://localhost:8080/plantuml. In this way the server is run on an embedded jetty server.

You can specify the port at which it runs:

mvn jetty:run -Djetty.port=9999

How to run the server with Docker

You can run Plantuml with jetty or tomcat container

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty
docker run -d -p 8080:8080 plantuml/plantuml-server:tomcat

The server is now listing to http://localhost:8080.

How to set PlantUML options

You can apply some option to your PlantUML server with environement variable.

If you run the directly the jar, you can pass the option with -D flag

java -D THE_ENV_VARIABLE=THE_ENV_VALUE -Djetty.contextpath=/ -jar target/dependency/jetty-runner.jar target/plantuml.war

or

mvn jetty:run -D THE_ENV_VARIABLE=THE_ENV_VALUE -Djetty.port=9999

If you use docker, you can use the -e flag:

docker run -d -p 8080:8080 -e THE_ENV_VARIABLE=THE_ENV_VALUE plantuml/plantuml-server:jetty

You can set all the following variables:

  • PLANTUML_LIMIT_SIZE
    • Limits image width and height
    • Default value 4096
  • GRAPHVIZ_DOT
    • Link to 'dot' executable
    • Default value /usr/local/bin/dot or /usr/bin/dot
  • PLANTUML_STATS

Alternate: How to build your docker image

This method uses maven to run the application. That requires internet connectivity. So, you can use following command to create a self-contained docker image that will "just-work".

Note: Generate the WAR (instructions further below) prior to running "docker build"

docker image build -t plantuml-server . 
docker run -d -p 8080:8080 plantuml-server

The server is now listing to http://localhost:8080/plantuml.

You may specify the port in -p Docker command line argument.

How to generate the war

To build the war, just run:

mvn package

at the root directory of the project to produce plantuml.war in the target/ directory.