mirror of
https://github.com/octoleo/plantuml-server.git
synced 2024-11-05 20:37:53 +00:00
58 lines
1.3 KiB
Markdown
58 lines
1.3 KiB
Markdown
PlantUML Server
|
|
===============
|
|
[](https://travis-ci.org/plantuml/plantuml-server)
|
|
|
|
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](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](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.
|