abulka/pynsource

update help instructions re local plantuml installation

abulka opened this issue · 1 comments

With info re win10 and updated java technique.

To install a plantuml server locally please follow the instructions in the pynsource help file viz.

Windows 10

Install Java.
Maven works OK under Windows.
And the normal instructions work.

git clone https://github.com/plantuml/plantuml-server.git
cd plantuml-server
mvn jetty:run

Mac

install brew see https://brew.sh/

install java

old way:

brew tap adoptopenjdk/openjdk
brew cask install adoptopenjdk8

new way:

brew install --cask temurin

install maven, clone the repo and run

brew install maven
git clone https://github.com/plantuml/plantuml-server.git
cd plantuml-server
mvn jetty:run

verify by visiting your local page

http://localhost:8080/plantuml/

Linux

Install Java then pretty much the same thing:

sudo apt install maven
git clone https://github.com/plantuml/plantuml-server.git
cd plantuml-server
mvn jetty:run

Increase size of diagrams

Set the environment variable PLANTUML_LIMIT_SIZE=8192.

Contribution from Ivan:

Use Command prompt (cmd.exe) for all commands. First run of Maven (mvn jetty:run) quickly generates a lot of commands (log attached).

For large UML diagrams run set PLANTUML_LIMIT_SIZE=8192 in Command prompt.

Use Ctrl-C to stop JETTY. Don’t forget to add PATHs for Java, Git and Maven.