Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.14 KB

README.md

File metadata and controls

53 lines (37 loc) · 2.14 KB
Raw

plantuml-docker

Docker image Contributor Covenant

Docker image for running a PlantUML server.

Usage

Without cloning the repo

docker run --init --rm -p 8080:8080 ghcr.io/rakutentech/plantuml:main

Using a working copy of the repo

docker-compose up --build

Differences with the official image

The differences with plantuml/plantuml-server are:

  • Based on Alpine Linux, not Debian.
  • Runs on the Zulu OpenJDK.
  • PLANTUML_LIMIT_SIZE raised to 16384 so you can generate bigger diagrams.
  • Installs a plantuml.skin with a few overrides. (in beta, doesn't work well)
  • Installs a rakuten.pu library with a few definitions to get you started. Just include it with !include rakuten.pu at the start of your diagram.
  • Comes with a few fonts:
    • Mulish is installed and poses as the Rakuten Sans font, which it is visually similar to (and a decent fallback for when generating PNG diagrams). Generated SVG images correctly inject the font-family: 'Rakuten Sans' style, too.
    • Noto Sans and Noto Sans JP, recommended by the ReX typography guidelines. Noto Sans is set as the default sans-serif font.
    • Fira Code, set as the default monospace font.
    • Font Awesome 5 Free.

Example

@startuml
!include rakuten.pu

title Rakuten PlantUML Image

participant Browser
participant "PlantUML Server" as PlantUML

Browser -> PlantUML: FA(f542) Send diagram source
Browser <<-- PlantUML: Get SVG FA(f03e)
@enduml

example