From a3b1eba470a9674a41c4039f973b49c04719320b Mon Sep 17 00:00:00 2001 From: David Ducatel Date: Tue, 26 Sep 2017 09:40:42 +0200 Subject: [PATCH] Add first env var description in readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index d20c24d..b072f97 100644 --- a/README.md +++ b/README.md @@ -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 ======================================================