yuzutech/kroki

Kroki

将纯文本图表转换为图像！

Kroki提供统一API，支持BlockDiag（BlockDiag、SeqDiag、ActDiag、NwDiag、PacketDiag、RackDiag）、BPMN、Bytefield、C4（带PlantUML）、D2、DBML、Ditaa、Erd、Excalidraw、GraphViz、Mermaid、Nomnoml、Pikchr、PlantUML、SvgBob、Symbolator、UMLet、Vega、Vega-Lite、WaveDrom等多种图表类型，以及更多即将支持的类型！

快速开始

前提条件

运行此容器需要安装Docker。

• Windows
• OS X
• Linux

使用方法

另请参阅Kroki文档中的安装配置章节。

启动Kroki实例

$ docker run --name some-kroki -d yuzutech/kroki

此镜像包含EXPOSE 8000（Kroki服务端口），标准容器链接会使其自动对链接容器可用。若需将容器内8000端口映射到主机端口，可使用--publish或-p参数：

$ docker run -p8000:8000 --name some-kroki -d yuzutech/kroki

连接配套容器

推荐使用docker-compose连接配套容器，如https://hub.docker.com/r/yuzutech/kroki-bpmn%E3%80%81https://hub.docker.com/r/yuzutech/kroki-excalidraw%E5%92%8Chttps://hub.docker.com/r/yuzutech/kroki-mermaid%EF%BC%9A

yaml
services:
  core:
    image: yuzutech/kroki
    environment:
      - KROKI_MERMAID_HOST=mermaid
      - KROKI_BPMN_HOST=bpmn
      - KROKI_EXCALIDRAW_HOST=excalidraw
    ports:
      - "8000:8000"
  mermaid:
    image: yuzutech/kroki-mermaid
    ports:
      - "8002:8002"
  bpmn:
    image: yuzutech/kroki-bpmn
    ports:
      - "8003:8003"
  excalidraw:
    image: yuzutech/kroki-excalidraw
    ports:
      - "8004:8004"

若不使用docker-compose，可通过环境变量配置各配套容器的主机和端口：

环境变量

Kroki镜像使用多个环境变量，虽非必需，但有助于更好地使用镜像。详情请参阅Kroki文档中的配置章节。

版本控制

我们使用语义化版本进行版本控制。

许可证

本项目基于MIT许可证授权。