zenato/puppeteer-renderer

基于Puppeteer的网页渲染器

基于https://github.com/GoogleChrome/puppeteer%EF%BC%88Chrome%E6%97%A0%E5%A4%B4%E8%8A%82%E7%82%B9API%EF%BC%89%E7%9A%84%E7%BD%91%E9%A1%B5%E6%B8%B2%E6%9F%93%E5%99%A8%EF%BC%8C%E9%80%9A%E8%BF%87%E4%BB%A3%E7%90%86%E5%AE%9E%E7%8E%B0%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%B8%B2%E6%9F%93%EF%BC%8C%E6%94%AF%E6%8C%81%E8%BE%93%E5%87%BAHTML%E3%80%81PDF%E5%92%8CPNG%E6%A0%BC%E5%BC%8F%E6%88%AA%E5%9B%BE%E3%80%82

概述和主要用途

本镜像提供了一个基于Puppeteer的网页渲染服务，主要用于服务端渲染（SSR）场景。通过简单的API调用，可将目标网页渲染为HTML、PDF文档或PNG截图，适用于需要在服务端处理网页内容的应用场景。

核心功能和特性

• 基于Puppeteer（Chrome无头浏览器API），渲染效果与Chrome一致
• 支持三种输出格式：HTML、PDF、PNG截图
• 提供简单易用的HTTP API接口
• 可通过Docker快速部署，无需本地安装Chromium
• 支持与现有服务集成（如Express中间件）

使用场景和适用范围

• 需要服务端渲染动态网页以改善SEO的应用
• 生成网页内容的PDF报告或截图
• 自动化网页内容抓取和处理
• 测试环境中模拟浏览器行为

环境要求

• 可运行Chromium的环境，或已安装Docker

快速开始

安装依赖（本地运行）

bash
npm install

启动服务（本地运行，需可运行Chromium）

bash
npm start

服务端口：3000

使用Docker启动服务（无法运行Chromium时）

bash
docker run -d --name renderer -p 8080:3000 zenato/puppeteer-renderer

浏览器测试

在浏览器中输入以下URL：

http://localhost:{port}/?url=https://www.google.com

若能看到HTML代码，则服务运行正常（{port}替换为实际端口，本地运行时为3000，Docker运行时为8080）。

与现有服务集成

如果已有活跃服务，可通过中间件配置代理。以下是Express框架的集成示例（详见puppeteer-renderer-middleware）：

js
const renderer = require('puppeteer-renderer-middleware');
const express = require('express');

const app = express();

app.use(renderer({
  url: 'http://已部署的puppeteer-renderer服务URL',
  // userAgentPattern: /My-Custom-Agent/i,  // 自定义User-Agent匹配模式
  // excludeUrlPattern: /*.html$/i          // 排除URL匹配模式
  // timeout: 30 * 1000,                    // 超时时间（毫秒）
}));

// 你的业务逻辑...

app.listen(8080);

API接口说明

PDF文件名生成规则

生成的PDF文件会通过Content-disposition响应头提示浏览器下载，文件名根据目标URL生成，规则如下：

许可协议

MIT

版权所有 (c) 2017年至今, Yeongjin Lee