4teamwork/weasyprint

weasyprint

镜像概述与主要用途

weasyprint镜像是一个Docker化的Web服务，基于WeasyPrint构建。WeasyPrint是一款专注于Web打印标准的HTML和CSS可视化渲染引擎，可将HTML内容导出为PDF。该镜像将WeasyPrint封装为Web服务，提供HTTP端点用于接收HTML文件、可选CSS文件及附件上传，处理后返回生成的PDF文件。服务采用Python aiohttp框架开发，支持异步请求处理。

核心功能与特性

• HTML转PDF：基于WeasyPrint引擎，支持HTML+CSS内容渲染为高质量PDF
• 资源管理：支持多类型文件上传
  • asset.前缀：用于HTML中引用的资源文件（如图像、样式表）
  • attachment.前缀：用于需附加到PDF的文件
• 灵活配置：可通过JSON参数覆盖WeasyPrint默认选项（如PDF变体、页面设置等）
• 安全控制：默认禁止外部资源访问，可通过环境变量配置允许的外部URL规则

使用场景与适用范围

适用于需要通过Web服务动态生成PDF的场景，包括：

• 业务系统动态生成报告、发票、合同等文档
• 网页内容转PDF下载功能实现
• 需要包含图片、样式等资源的PDF生成需求
• 需附加额外文件到生成PDF的应用场景

使用方法与配置说明

启动服务

使用以下命令启动Web服务：

bash
docker compose up

服务默认监听3000端口。

上传与生成PDF

通过multipart/form-data格式向服务端点发送请求，必须包含html部分（主HTML内容），可选包含资产文件和附件。

基础使用示例

上传HTML文件和图片资源生成PDF：

bash
curl -F "html=@tests/index.html" -F "asset.universe.jpg=@tests/universe.jpg" http://localhost:3000 -o test.pdf

自定义PDF生成选项

通过名为options的JSON格式参数，可覆盖weasyprint.DEFAULT_OPTIONS中的配置，需指定type=application/json。

选项配置示例

设置PDF变体为PDF/A-3b标准：

bash
curl -F "html=@tests/index.html" -F "asset.universe.jpg=@tests/universe.jpg" -F 'options={"pdf_variant": "pdf/a-3b"};type=application/json' http://localhost:3000 -o test.pdf

外部资源访问配置

出于安全考虑，默认禁止加载外部URL资源。如需允许访问特定外部资源，设置环境变量WEASYPRINT_ALLOWED_URLS_PATTERN为匹配目标URL的正则表达式。

环境变量配置示例

允许访问指定域名的外部资源：

bash
WEASYPRINT_ALLOWED_URLS_PATTERN="^https://fonts\.example\.com.*|^https://logos\.example\.com.*"

在Docker Compose中配置：

yaml
services:
  weasyprint:
    image: weasyprint
    environment:
      - WEASYPRINT_ALLOWED_URLS_PATTERN=^[***]\.example\.com.*|^[***]\.example\.com.*
    ports:
      - "3000:3000"