1
0
mirror of https://github.com/octoleo/plantuml-server.git synced 2024-09-27 22:49:03 +00:00
PlantUML Online Server
Go to file
Clément Moyroud 163863ac0b Allow running on the Openshift platform
A few changes are necessary for the best out-of-the-box experience on Docker-based application
platforms such as OpenShift:
1. For security purposes, they run the containers as non-root. Before this change, the user was
   trying to write to the home dir, which is set to /root by default.
2. Deploy time is limited, and the download of dependencies by Jetty at start-up time, while
   convenient for testing, causes timeouts when deploying. a WAR is now created during
   Docker image creation, and as a result starting up the container is really fast now.

In addition, it is now possible to enable debug logging for Jetty by uncommenting the
relevant line in the Dockerfile.
2017-04-25 16:18:11 -07:00
screenshots Add a screenshot 2015-03-29 18:59:42 +01:00
src Running PlantUML as ROOT.war 2017-04-21 22:38:08 +02:00
.gitignore [TASK] Ignore eclipse checkstyle plugin file 2014-02-15 19:20:30 +01:00
.travis.yml [TASK] Travis-ci.org configuration file added 2013-10-16 23:52:22 +02:00
COPYING Add GPLv3 License 2014-11-27 10:06:30 +01:00
Dockerfile Allow running on the Openshift platform 2017-04-25 16:18:11 -07:00
Dockerfile.tomcat8 renamed file to match instructions 2017-04-23 22:03:38 -04:00
pom.xml Allow running on the Openshift platform 2017-04-25 16:18:11 -07:00
README.md Fixed typo in docker command 2017-04-24 12:16:12 -04:00

PlantUML Server

Build Status

PlantUML Server is a web application to generate UML diagrams on-the-fly.

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

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

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

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

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

Alternate: How to run the server with Tomcat + Docker?

Above method uses maven to run the application. That requires internet connectivity. That is undesireable in a corporate environment with firewalls. 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 build -t plantuml-server:tomcat8 -f Dockerfile.tomcat8 . 
docker run -d -p 8080:8080 plantuml-server:tomcat8

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

You may specity 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.