mermaid.ink

实时演示

想查看 mermaid.ink 的实际效果？请访问此 https://freeslugs.github.io/mermaid-converter/%EF%BC%8C%E5%AE%83%E5%B1%95%E7%A4%BA%E4%BA%86 mermaid.ink 如何将 Mermaid 图表转换为图像。

快速开始

git clone https://github.com/jihchi/mermaid.ink.git
cd mermaid.ink
pnpm install
DEBUG=app:* pnpm start

访问 http://localhost:3000

启动容器

有关支持的标签，请参见 https://github.com/jihchi/mermaid.ink/pkgs/container/mermaid.ink%E3%80%82

docker run --cap-add=SYS_ADMIN -p 3000:3000 ghcr.io/jihchi/mermaid.ink

访问 http://localhost:3000

[!IMPORTANT] 通常，不建议使用 --cap-add=SYS_ADMIN 启动容器。请参考 https://github.com/Zenika/alpine-chrome?tab=readme-ov-file#3-ways-to-securely-use-chrome-headless-with-this-image%E4%B8%BA%E6%82%A8%E7%9A%84%E5%9C%BA%E6%99%AF%E9%80%89%E6%8B%A9%E6%9C%80%E5%90%88%E9%80%82%E7%9A%84%E8%A7%A3%E5%86%B3%E6%96%B9%E6%A1%88%E3%80%82

不使用 --cap-add=SYS_ADMIN

您可以改用 https://github.com/Zenika/alpine-chrome/blob/master/chrome.json%EF%BC%9A

wget https://raw.githubusercontent.com/jfrazelle/dotfiles/master/etc/docker/seccomp/chrome.json
docker run --security-opt seccomp=$(pwd)/chrome.json ghcr.io/jihchi/mermaid.ink

如果启动过程中遇到核心转储错误（更多详情参见 https://github.com/jihchi/mermaid.ink/issues/496%EF%BC%89%EF%BC%8C%E6%82%A8%E5%8F%AF%E8%83%BD%E9%9C%80%E8%A6%81%E5%9C%A8%E4%B8%8D%E4%BD%BF%E7%94%A8%E9%BB%98%E8%AE%A4 seccomp 配置文件的情况下运行。

不使用默认 seccomp 配置文件

您可以在不使用 seccomp 配置文件的情况下启动容器：

docker run --security-opt seccomp=unconfined ghcr.io/jihchi/mermaid.ink

环境变量

Properties protocolTimeout | | QUEUE_CONCURRENCY | 1 | 设置并发渲染作业的最大数量。 | | QUEUE_ADD_TIMEOUT | 3000 | 定义渲染作业的超时持续时间（以毫秒为单位）。 | | ENABLE_DATABASE | | 启用 PostgreSQL 数据库缓存。设置为 'true' 以启用，否则禁用。 | | PGHOST | | PostgreSQL 服务器主机名。例如：'localhost'。 | | PGPORT | | PostgreSQL 服务器端口。例如：5432。 | | PGDATABASE | | PostgreSQL 数据库名称。例如：'postgres'。 | | PGUSERNAME | | PostgreSQL 用户名。例如：'postgres'。 | | PGPASSWORD | | PostgreSQL 密码 |

故障排除

收到 HTTP 431 Request Header Fields Too Large 错误

[!WARNING] 注意：如果增加 --max-http-header-size，可能会遇到 DoS ***！

感谢 https://github.com/ryepup 的分析和解决方法（https://github.com/jihchi/mermaid.ink/issues/12%EF%BC%89

• 如果在本地运行，在 package.json 的启动脚本中添加 --max-http-header-size

  • 例如："start": "node --max-http-header-size=102400000 src/index.js"

• 如果通过 Docker 运行，使用 NODE_OPTIONS 增加 --max-http-header-size

  • 例如：docker run --rm -it -e 'NODE_OPTIONS="--max-http-header-size=102400000"' -p 3000:3000 ghcr.io/jihchi/mermaid.ink

或者，如果在本地运行，执行 NODE_OPTIONS="--max-http-header-size=102400000" npm start 以增加 --max-http-header-size

贡献者

非常感谢您的帮助！

贡献者图像由 contrib.rocks 生成。