dockette/rendertron

Rendertron Docker镜像文档

镜像概述

Rendertron是由Google开发的Headless Chrome渲染解决方案，旨在动态渲染和序列化网页。该Docker镜像提供即开即用的服务，帮助渐进式Web应用（PWA）向不渲染或执行JavaScript的爬虫提供正确内容，解决PWA在搜索引擎索引中的内容可见性问题。服务通过Headless Chrome渲染请求页面，自动检测PWA加载完成状态后将响应序列化返回。

核心功能与特性

• 基于Puppeteer构建：利用Google Chrome的Puppeteer库实现Headless Chrome渲染能力
• SEO优化：为不执行JavaScript的爬虫提供预渲染内容，提升网站在搜索引擎中的索引效果
• 多中间件支持：兼容Express.js、Firebase Functions、ASP.net Core等多种中间件，便于集成到现有应用
• 状态码保留：保留原始请求的HTTP状态码，支持通过meta标签自定义返回状态码
• Web组件兼容：支持Web Components，需配合Shady DOM或相关polyfill使用
• 灵活配置：可自定义渲染超时时间、视口尺寸、服务端口等参数

使用场景

• PWA应用SEO优化：解决单页应用（SPA）在不支持JS的爬虫环境下内容无法被索引的问题
• 动态内容预渲染：为动态生成内容的网站提供服务端渲染能力，确保搜索引擎抓取完整内容
• 跨设备渲染测试：通过调整视口参数（宽度、高度、移动模式）测试页面在不同设备上的渲染效果

使用方法

本地运行（非Docker方式）

通过npm全局安装并启动：

bash
npm install -g rendertron
rendertron

Docker部署

官方未提供Dockerfile，建议基于Puppeteer的Docker部署指南构建镜像。基本运行示例：

bash
# 假设已构建包含Rendertron和Puppeteer依赖的镜像，镜像名为rendertron
docker run -d -p 3000:3000 --name rendertron-service rendertron

API使用说明

渲染页面

GET /render/<url>

参数：

• mobile：可选，默认false，传递?mobile启用移动版视图

示例：

GET http://localhost:3000/render/https://example.com/?mobile

生成截图

GET /screenshot/<url>
POST /screenshot/<url>

GET参数：

• width：默认1000，视口宽度
• height：默认1000，视口高度
• mobile：默认false，启用移动版视图

POST请求：可在请求体中传递JSON格式的额外截图参数（参考https://github.com/GoogleChrome/puppeteer/blob/v1.6.0/docs/api.md#pagescreenshotoptions%EF%BC%89%EF%BC%8C%E4%B8%8D%E6%94%AF%E6%8C%81%60type%60%E5%92%8C%60encoding%60%E5%8F%82%E6%95%B0%E3%80%82

配置参数

通过在镜像根目录放置config.json文件进行配置，支持以下选项：

注意事项

• URL编码：传递带查询参数的URL时需使用encodeURIComponent编码，例如：https://render-tron.appspot.com/render/http://my.domain/%3Fpage%3Dhome
• Web组件处理：Web Components v0需启用Shady DOM；Web Components v1需设置wc-inject-shadydom=true查询参数
• 渲染超时：默认10秒超时，需确保页面在超时前完成渲染
• 状态码自定义：通过<meta name="render:status_code" content="404" />可自定义返回状态码

故障排除

Headless Chrome运行异常时，参考https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md