acsone/kwkhtmltopdf

kwkhtmltopdf

基于wkhtmlpdf的服务端与兼容客户端，用于将HTML转换为PDF文件。

镜像概述

该镜像提供wkhtmltopdf的专用服务端和客户端工具，旨在解决应用部署中wkhtmltopdf及其依赖的问题，将内存密集型的PDF转换任务委托给专用服务，降低应用Pod的内存需求，并支持运行时灵活选择wkhtmltopdf版本。

核心功能

1. 服务端（kwkhtmltopdf_server）：采用Go编写的Web服务器，接受wkhtmlpdf参数和待转换文件（以multipart表单数据形式）。
2. 客户端（kwkhtmltopdf_client）：兼容原生wkhtmlpdf的替代工具，通过环境变量KWKHTMLTOPDF_SERVER_URL调用服务端。提供Go（推荐）和Python（依赖requests库）两种版本。

使用场景

• 应用需要HTML转PDF功能，但不想在自身镜像中部署wkhtmltopdf及其依赖。
• 需要将内存密集的PDF转换任务分离到专用Pod，优化应用资源占用。
• 需灵活切换不同版本的wkhtmltopdf而无需修改应用配置。

配置说明

• 服务端默认监听8080端口。
• 客户端需设置环境变量KWKHTMLTOPDF_SERVER_URL指定服务端地址。

快速部署示例

运行服务端

bash
# 使用Docker运行服务端
docker run --rm -p 8080:8080 acsone/kwkhtmltopdf
# 或直接用Go运行（需本地安装Go环境）
go run server/kwkhtmltopdf_server.go

服务端将在http://localhost:8080监听请求。

运行客户端

Go客户端

bash
# 编译Go客户端
go build -o client/go/kwkhtmltopdf_client client/go/kwkhtmltopdf_client.go
# 设置服务端地址并转换示例页面
env KWKHTMLTOPDF_SERVER_URL=http://localhost:8080 \
    client/go/kwkhtmltopdf_client https://wkhtmltopdf.org /tmp/test.pdf

Python客户端

bash
# 设置服务端地址并转换示例页面（需安装requests库）
env KWKHTMLTOPDF_SERVER_URL=http://localhost:8080 \
    client/python/kwkhtmltopdf_client.py https://wkhtmltopdf.org /tmp/test.pdf

执行后将生成/tmp/test.pdf文件（wkhtmltopdf官网页面的PDF版本）。

测试方法

1. 启动服务端。
2. 设置并导出KWKHTMLTOPDF_SERVER_URL环境变量。
3. 运行tox命令，将对原生wkhtmltopdf、Go客户端和Python客户端进行测试。

路线图

详见GitHub仓库的https://github.com/acsone/kwkhtmltopdf/issues%E5%8F%8A%E6%BA%90%E4%BB%A3%E7%A0%81%E4%B8%AD%E7%9A%84TODO%E6%B3%A8%E9%87%8A%E3%80%82

发布流程

1. 推送master分支并确保Travis CI测试通过。
2. 创建并推送Git标签。
3. Travis将生成包含客户端和服务端二进制文件的GitHub release。
4. Docker Hub将自动构建镜像。

credits

作者：***
贡献者：Nils Hamerlinck

许可证

MIT