tofandel/node-headless-chrome

Node Headless Chrome 镜像文档

镜像概述

本镜像提供了一个预装 Headless Chrome（无头浏览器）的 Node.js 运行环境。专为需要在服务器端或容器环境中运行浏览器自动化、网页抓取和前端测试的任务而设计。镜像通过不同的标签（Tag）支持多个 Node.js 和 npm 版本，以满足不同项目的依赖需求。

核心功能和特性

• 预装 Headless Chrome：内置配置好的无头浏览器环境及系统依赖，开箱即用。
• 多版本支持：
  • v16 标签：包含 Node.js v16 和 npm v8.1.0。
  • v15 标签：包含 Node.js v15 和 npm v7。
• 生态兼容：完美兼容 Puppeteer、Playwright 等主流浏览器自动化库。
• 容器化优化：针对 Docker 环境进行了参数和依赖优化，适合在 CI/CD 流水线及生产环境中稳定运行。

使用场景和适用范围

• 网页抓取与爬虫：渲染动态 JavaScript 网页并提取数据。
• 自动化测试：在 CI/CD 环境中运行前端端到端（E2E）测试。
• PDF/截图生成：将网页内容转换为 PDF 文件或生成页面截图。
• 服务端渲染（SSR）：为单页应用（SPA）提供搜索引擎优化（SEO）预渲染服务。

版本标签说明

使用方法与部署示例

1. 使用 Docker Run 运行

以下示例展示如何使用 v16 标签运行一个 Node.js 脚本（假设脚本名为 scrape.js，位于当前目录）：

bash
docker run --rm --shm-size="1g" -v "$PWD":/usr/src/app -w /usr/src/app <镜像名>:v16 node scrape.js

注：请将 <镜像名> 替换为实际的镜像仓库地址。

2. 使用 Dockerfile 构建自定义镜像

如果需要安装额外的依赖（如 puppeteer），可以基于此镜像构建：

dockerfile
FROM docker.xuanyuan.run/<镜像名>:v16

# 设置工作目录
WORKDIR /usr/src/app

# 复制 package.json 并安装依赖
COPY package*.json ./
RUN npm install

# 复制项目代码
COPY . .

# 运行脚本
CMD ["node", "index.js"]

3. 使用 Docker Compose

在 docker-compose.yml 中配置自动化测试或爬虫服务：

yaml
version: '3.8'
services:
  scraper:
    image: docker.xuanyuan.run/<镜像名>:v16
    shm_size: '1gb'
    volumes:
      - .:/usr/src/app
    working_dir: /usr/src/app
    command: node index.js
    environment:
      - NODE_ENV=production
      - PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true

配置与注意事项

Headless Chrome 启动参数

在容器环境中运行 Chrome 时，必须在 Puppeteer 或 Playwright 中传递特定的启动参数以确保稳定性并避免权限问题：

javascript
const browser = await puppeteer.launch({
  headless: true,
  args: [
    '--no-sandbox',
    '--disable-setuid-sandbox',
    '--disable-dev-shm-usage', // 克服 /dev/shm 空间不足导致的崩溃问题
    '--disable-gpu'
  ]
});

共享内存限制 (shm-size)

Docker 默认的 /dev/shm 大小较小（通常为 64MB），在处理复杂页面时极易导致 Chrome 崩溃。强烈建议在运行容器时增加共享内存大小（如上述示例中的 --shm-size="1g" 或 shm_size: '1gb'）。