Skip to content

karfau/plantuml-docker

Repository files navigation

plantuml-docker

Provides the source code for the karfau/plantuml docker image.

It offers the ability to use plantuml as a cli tool based on docker. The changelog of plantuml is at https://plantuml.com/changes

To build the image you need to have java installed, since we are making use of gradle to manage the plantuml dependency. Renovate is configured to update dependencies in an automated manner.

Usage

&TLDR;

You should be able to replace java -jar plantuml.jar in a command with docker run karfau/plantuml[:VERSION] in your script.

More details:

As you can see in test-docker.sh running the above command without any arguments renders the help output that can also be read online at the end of this page

Input and output of course follows the docker rules, and there is currently no mount point prepared to make working with files easier (PRs welcome!). So either you mount a directory yourself and provide the related parameters,

or you use -p[ipe] argument to use stdin and stdout (as in test-docker.sh): pipe sequence

or you make use of the new -picoweb[:port] option together with -encode and -decode.

If you found a way how to use the image, feel free to provide a PR that modifies test-docker.sh so it's part of the tests. I will also do that alongside making use of the image.

Contribute

To build the image run ./build-docker.sh and make sure JAVA_HOME is set for the gradle wrapper to work (can be set in .env if needed on your system). Run ./test-docker.sh to see if everything still works as expected.

Related

Source of inspiration for the docker image:

Planning to use this in https://github.com/karfau/xstate-plantuml