PlantUML Server 技术文档

1. 安装指南

系统要求

• Java运行环境（JRE）/Java开发工具包（JDK）11或更高版本
• Apache Maven 3.0.2或更高版本

推荐配置

• Jetty服务器 11或更高版本
• Tomcat服务器 10或更高版本

2. 项目的使用说明

PlantUML Server是一个Web应用程序，能够实时生成UML图。

如何运行服务器

在命令行中执行以下命令以启动服务器：

mvn jetty:run

服务器将监听http://localhost:8080/plantuml。可以通过指定jetty.http.port参数来改变监听的端口：

mvn jetty:run -Djetty.http.port=9999

3. 项目API使用文档

PlantUML Server的配置和使用可以通过环境变量进行。以下是一些可用的环境变量：

• BASE_URL：设置PlantUML的基础URL路径，默认值为ROOT。
• PLANTUML_SECURITY_PROFILE：设置PlantUML的安全配置文件。如果需要访问除80（http）和443（https）之外的端口或访问本地文件，请考虑使用允许列表功能。默认值为INTERNET。
• PLANTUML_PROPERTY_FILE：设置PlantUML系统属性文件路径，默认值为null。
• PLANTUML_CONFIG_FILE：设置PlantUML配置文件的本地路径，默认值为null。
• PLANTUML_LIMIT_SIZE：限制图片的宽度和高度，默认值为4096。
• PLANTUML_STATS：设置为on以启用统计报告，默认值为off。
• HTTP_AUTHORIZATION：当调用proxy端点时，用于设置HTTP授权头。
• HTTP_PROXY_READ_TIMEOUT：当调用proxy端点时，设置连接的读取超时时间，默认值为10000（10秒）。

如何设置环境变量

如果直接运行jar包，可以如下设置环境变量：

java -jar target/dependency/jetty-runner.jar --config src/main/config/jetty.xml --port 9999 --path /plantuml target/plantuml.war

或者通过Maven命令行参数设置：

mvn jetty:run -D THE_ENV_VARIABLE=THE_ENV_VALUE -Djetty.http.port=9999

使用Docker运行时，可以使用-e标志设置环境变量：

docker run -d -p 9999:8080 -e THE_ENV_VARIABLE=THE_ENV_VALUE plantuml/plantuml-server:jetty

4. 项目安装方式

使用Docker安装

可以通过以下命令使用Docker安装并运行PlantUML Server：

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

要使用只读文件系统模式运行Jetty容器，可以使用以下命令：

docker run -d -p 8080:8080 --read-only -v /tmp/jetty plantuml/plantuml-server:jetty

若要更改基础URL，可以修改docker-compose.yml文件：

environment:
  - BASE_URL=plantuml

然后执行docker-compose up。

构建War包

要构建War包，请在项目根目录下执行以下命令：

mvn package

War包将在target/目录下生成。如果需要包含apache-jsp构件，请使用以下命令：

mvn package -Dapache-jsp.scope=compile

如果希望以Java 8为目标版本构建War包，请删除src/test目录，并使用pom.jdk8.xml：

rm -rf src/test
mvn package -f pom.jdk8.xml [-Dapache-jsp.scope=compile]