jackclub/node-webshot

Node-Webshot 镜像文档

镜像概述和主要用途

Node-Webshot是一个围绕webshot构建的Node.js网页截图服务镜像，提供轻量级的网页截图功能。该镜像运行一个Web服务，通过简单的HTTP请求即可截取指定网页的截图，适用于需要快速获取网页视觉内容的场景。

核心功能和特性

• 基于Node.js构建的网页截图服务
• 作为webshot工具的简单包装器，简化截图流程
• 支持通过HTTP GET请求触发截图操作
• 可自定义网页视口尺寸（宽度x高度格式）
• 默认运行在3000端口，易于部署和集成

使用场景和适用范围

• 网站预览图自动生成
• 网页内容监控与存档
• 文档或报告中嵌入网页截图
• 开发测试过程中快速验证网页渲染效果
• 需要程序化获取网页视觉内容的自动化流程

使用方法和配置说明

启动服务

运行容器以启动Node-Webshot服务：

shell
docker run -d -p 3000:3000 --name docker.xuanyuan.run/node-webshot node-webshot

服务将在容器内的3000端口启动，通过主机3000端口对外提供服务。

截取网页截图

通过发送GET请求到服务根路径/来获取网页截图，需提供以下参数：

• 必填参数：

  • url：需要截图的网页URL地址

• 可选参数：

  • viewport：网页视口尺寸，格式为[width]x[height]，例如1920x1080

请求示例

截取https://example.com在1920x1080视口下的截图：

http://localhost:3000/?url=https://example.com&viewport=1920x1080

许可证

本项目基于MIT许可证开源 - 详见LICENSE文件。

贡献

欢迎贡献！如有任何建议或改进，请提交issue或pull request。