octoleo
/
plantuml-server
mirror of https://github.com/octoleo/plantuml-server.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Add first env var description in readme

This commit is contained in:
David Ducatel 2017-09-26 09:40:42 +02:00
parent 6ad05008c4
commit a3b1eba470
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -44,6 +44,32 @@ docker run -d -p 8080:8080 plantuml/plantuml-server:tomcat
The server is now listing to [http://localhost:8080](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`
Alternate: How to build your docker image
======================================================