elestio/ws-screenshot.slim

ws-screenshot 镜像文档

镜像概述和主要用途

ws-screenshot 是一个快速的 WebSocket + REST API 截图服务器，提供高效的网页截图功能。通过简单的 API 调用，用户可以生成指定网页的截图，支持自定义分辨率、输出格式及全页面截图，适用于需要自动化或实时获取网页截图的场景。

核心功能和特性

• 双 API 支持：同时提供 REST API 和 WebSocket API，满足不同使用需求
• 自定义分辨率：可指定截图宽度（resX）和高度（resY）
• 多种输出格式：支持 jpg、png 和 pdf 格式
• 全页面截图：支持滚动页面生成完整页面截图（isFullPage 参数）
• 轻量部署：通过 Docker 容器化部署，快速启动和集成

使用场景和适用范围

• 自动化测试：生成网页测试截图
• 监控系统：实时获取网页状态截图
• 内容存档：保存网页快照
• 开发调试：快速预览网页在不同分辨率下的显示效果

详细使用方法和配置说明

安装镜像

通过 Docker 拉取镜像：

bash
docker pull elestio/ws-screenshot.slim

运行容器

单次运行

bash
docker run -p 3000:3000 -it elestio/ws-screenshot.slim

作为服务运行（后台持久化）

bash
docker run -d --restart always -p 3000:3000 -it elestio/ws-screenshot.slim

测试服务

容器启动后，在浏览器中访问：

http://<您的IP地址>:3000/

API 使用方法

REST API

通过 GET 请求调用，参数通过 URL 查询字符串传递：

/api/screenshot?resX=1280&resY=900&outFormat=jpg&isFullPage=false&url=https://vms2.terasp.net

WebSocket API

通过 WebSocket 发送事件对象调用，示例事件对象：

javascript
var event = { 
  cmd: "screenshot", 
  url: url, 
  originalTS: (+new Date()), 
  resX: resX, 
  resY: resY, 
  outFormat: outFormat, 
  isFullPage: isFullPage 
};

可参考镜像中的 /public/js/client.js 和 /public/index.html 获取完整调用示例。

支持的参数说明

• url：必填，待截图的完整 URL，必须以 http:// 或 https:// 开头
• resX：可选，截图宽度，整数，默认值：1280
• resY：可选，截图高度，整数，默认值：900
• outFormat：可选，输出格式，可选值：jpg、png、pdf，默认值：jpg
• isFullPage：可选，是否全页面截图，布尔值（true/false），默认值：false

更多信息

详细文档和源码请参考 GitHub 仓库：https://github.com/elestio/ws-screenshot/