holowinski/plantuml

PlantUML Docker镜像（基于Alpine）

镜像概述

本镜像为PlantUML的Docker化部署版本，基于Alpine Linux构建，包含最新稳定版PlantUML及其运行依赖（如Graphviz）。PlantUML是一款开源工具，支持通过简单文本描述生成各类UML图表，本镜像旨在提供轻量、高效的UML图表生成环境，简化本地依赖配置，便于快速集成到开发、文档编写等工作流中。

核心功能与特性

• 轻量高效：基于Alpine Linux，镜像体积小（通常<100MB），启动速度快，资源占用低。
• 版本同步：保持与PlantUML官方最新稳定版同步，支持最新语法和图表类型。
• 全面支持：覆盖类图、时序图、用例图、活动图、状态图等20+种UML图表类型。
• 易于集成：可直接通过命令行调用，或集成到CI/CD流程、Markdown文档工具（如MkDocs）、代码注释系统等。
• 零配置启动：内置所有运行依赖，无需本地安装PlantUML或Graphviz，开箱即用。

使用场景与适用范围

• 开发团队文档编写：开发人员通过文本快速生成UML图表，嵌入技术设计文档或API文档。
• 自动化图表生成：集成到CI/CD流程，在代码提交或文档更新时自动生成/更新图表。
• Markdown文档集成：配合Markdown渲染工具（如GitLab/GitHub），通过文本描述直接在文档中生成图表。
• 教学与培训：讲师或培训师快速创建UML示例图表，用于课程材料或演示。

使用方法与配置说明

基本使用（单文件生成）

通过docker run命令生成单个UML图表，需挂载本地目录实现文件输入输出：

bash
# 生成PNG格式图表（示例：当前目录input.puml -> output目录input.png）
docker run --rm -v $(pwd):/data docker.xuanyuan.run/plantuml/alpine -t png -o /data/output /data/input.puml

参数说明：

• --rm：容器运行结束后自动删除，避免残留临时容器。
• -v $(pwd):/data：将本地当前目录挂载到容器内/data目录，实现文件共享。
• -t png：指定输出格式（支持png/svg/pdf/eps/txt等，默认svg）。
• -o /data/output：指定输出目录（容器内路径，需映射到本地目录，如未指定则输出到输入文件同级目录）。
• /data/input.puml：输入的PlantUML文本文件（容器内路径，对应本地./input.puml）。

批量图表生成

如需处理目录下多个.puml文件（含子目录），可指定目录作为输入：

bash
# 处理./puml目录下所有文件，输出SVG格式图表到./output目录
docker run --rm \
  -v $(pwd)/puml:/data/input \  # 本地输入目录映射
  -v $(pwd)/output:/data/output \  # 本地输出目录映射
  plantuml/alpine \
  -t svg -o /data/output /data/input  # 输出格式、目录及输入目录

docker-compose配置示例

创建docker-compose.yml简化常用命令，适合固定目录结构的场景：

yaml
version: '3'
services:
  plantuml:
    image: docker.xuanyuan.run/plantuml/alpine
    volumes:
      - ./puml:/data/input  # 本地输入目录（存放.puml文件）
      - ./output:/data/output  # 本地输出目录（存放生成的图表）
    command: -t png -o /data/output /data/input  # 默认生成PNG格式到output目录

运行方式：

bash
# 生成默认配置的图表
docker-compose run --rm plantuml

# 临时修改输出格式（如生成SVG）
docker-compose run --rm plantuml -t svg -o /data/output /data/input

注意事项

• 文件权限：输出目录需提前创建，避免因权限问题导致生成失败（临时测试可通过chmod 777 output解决，生产环境建议配置与容器内用户一致的权限）。
• 语法验证：输入的.puml文件语法需正确，可通过PlantUML在线编辑器提前验证。
• 自定义配置：如需自定义主题、字体等，可将配置文件（如plantuml.conf）挂载到容器内/etc/plantuml目录。