msokk/electron-render-service

electron-render-service

![Build Status]([] ![npm]([] ![Dependency Status]([***]

简单的PDF/PNG/JPEG渲染服务，接受网页URL并返回相应资源。

Docker使用方法

基于官方https://hub.docker.com/_/debian/%E9%95%9C%E5%83%8F%EF%BC%8C%E4%BD%BF%E7%94%A8%E6%9C%80%E6%96%B0%E7%89%88https://github.com/atom/electron%E3%80%82

1. docker run -t -e RENDERER_ACCESS_KEY=secret -p 3000:3000 msokk/electron-render-service
2. wget -o out.pdf http://<node_address>:3000/pdf?url=https://github.com/msokk/electron-render-service&accessKey=secret

注意：如果处理复杂页面，请设置更大的共享内存大小 --shm-size=Xm（默认值：64m）。 注意：添加 --security-opt seccomp:unconfined 以抑制 libudev: udev_has_devtmpfs: name_to_handle_at on /dev: Operation not permitted 警告。

在Debian系统上使用Node.js安装

sh
# 启用contrib软件包
sed -i 's/main/main contrib/g' /etc/apt/sources.list

# 安装运行时所需的软件包
apt-get update && apt-get install -y xvfb libgtk2.0-0 ttf-mscorefonts-installer libnotify4 libgconf2-4 libnss3 dbus-x11

# 从NPM安装
npm install -g electron-render-service

# 在虚拟帧缓冲区中运行
RENDERER_ACCESS_KEY=secret xvfb-run --server-args="-screen 0 1024x768x24" electron-render-service

wget -o out.pdf http://localhost:3000/pdf?url=https://github.com/msokk/electron-render-service&accessKey=secret

接口端点

GET /pdf - 渲染PDF

查询参数（https://github.com/atom/electron/blob/master/docs/api/web-contents.md#webcontentsprinttopdfoptions-callback%EF%BC%89%EF%BC%9A

• accessKey - 认证密钥。
• url - 要渲染的完整网页URL。
• pageSize - PDF页面大小（默认：A4）。
• marginsType - 边距类型（默认：0）。
• printBackground - 是否打印CSS背景（默认：true）。
• landscape - 是否横向（默认：false）。
• removePrintMedia - 是否移除打印样式表（默认：false）。
• delay - 渲染前等待时间（默认：0）。
• waitForText - 等待页面出现指定文本后再渲染（默认：false）。

GET /png|jpeg - 渲染图片

查询参数：

• accessKey - 认证密钥。
• url - 要渲染的完整网页URL。
• quality - JPEG质量（默认：80）。
• delay - 渲染前等待时间（默认：0）。
• waitForText - 等待页面出现指定文本后再渲染（默认：false）。
• browserWidth - 浏览器窗口宽度（默认：1024，最大：3000）。
• browserHeight - 浏览器窗口高度（默认：768，最大：3000）。
• 裁剪矩形（需同时设置四个参数）：
  • clippingRect[x]
  • clippingRect[y]
  • clippingRect[width]
  • clippingRect[height]

GET /stats - 查看渲染池统计

查询参数：

• accessKey - 必需的认证密钥。

环境变量

必需

• RENDERER_ACCESS_KEY/RENDERER_ACCESS_KEY_<suffix> - 访问限制密钥，带后缀的密钥用于日志调试。

可选

• CONCURRENCY - 并行渲染窗口数量（默认：1）。
• TIMEOUT - 请求超时时间（默认：30秒）。
• WINDOW_WIDTH - 默认窗口宽度（默认：1024）。
• WINDOW_HEIGHT - 默认窗口高度（默认：768）。
• HOSTNAME - 服务监听地址（默认：0.0.0.0）。
• PORT - 服务端口（默认：3000）。

最新Electron的渲染问题

• PDF中box-shadow显示为黑色：可添加 -webkit-filter: blur(0); 保留阴影（但会栅格化图层），或直接隐藏阴影。
• border-radius 会产生无圆角的双倍宽度边框。

延迟渲染

部分内容（如websocket加载的数据）不会随DOM立即加载。可通过以下方式延迟渲染：

1. 设置delay参数指定等待时间；
2. 设置waitForText参数，等待页面出现指定文本后再渲染（超时前未找到则失败）。