fpurchess/preview-service

preview-service

镜像概述和主要用途

preview-service是一个超轻量级Web服务，通过简单的HTTP API为多种文件生成缩略图，支持文档（PDF、ODT、DOC、DOCX）、视频（MP4、FLV、WebM等）、3D文件（PLY、OBJ、STL）等格式。该服务基于https://github.com/algoo/preview-generator开发，可快速集成到需要文件预览功能的应用中。

核心功能和特性

• 多格式支持：覆盖文档、视频、3D文件等多种类型，完整支持列表见https://github.com/algoo/preview-generator#supported-file-formats
• 轻量级设计：资源占用低，部署简单
• HTTP API接口：提供简洁的接口实现缩略图生成和缓存访问
• 缓存机制：可通过挂载卷持久化缩略图缓存，提升重复请求效率
• 文件存储：支持自定义上传文件的临时存储路径

使用场景和适用范围

• 文件管理系统：为上传的各类文件提供预览缩略图
• 内容管理平台：生成文档、视频等内容的预览图
• 开发测试环境：快速集成缩略图生成功能，无需自行实现复杂转换逻辑
• 任何需要批量或实时生成文件缩略图的Web应用

使用方法和配置说明

基本部署

启动服务：

bash
docker run -p 8000:8000 docker.xuanyuan.run/fpurchess/preview-service

生成缩略图

使用curl上传文件并指定缩略图尺寸（宽x高）：

bash
curl -o thumbnail.jpeg -F 'file=@file_to_preview.pdf' http://localhost:8000/preview/100x100

上述命令将生成file_to_preview.pdf的100x100像素JPEG缩略图，并保存为thumbnail.jpeg。

可选卷挂载

• /tmp/cache/：挂载此目录以持久化缩略图缓存
• /tmp/files/：存储上传的临时文件，挂载可自定义路径

完整示例（带卷挂载）：

bash
docker run -p 8000:8000 -v /本地路径/cache:/tmp/cache -v /本地路径/files:/tmp/files docker.xuanyuan.run/fpurchess/preview-service

API详细说明

GET /

服务健康检查接口，返回200 OK表示服务正常运行。

POST /preview/{width}x{height}

功能：生成指定尺寸的缩略图
请求格式：multipart/form-data，表单字段名为file（需上传文件）
响应：成功时返回生成的缩略图文件

示例：

bash
curl -o thumbnail.jpeg -F 'file=@example.mp4' http://localhost:8000/preview/200x150

生成200x150像素的视频缩略图。

GET /cache/<cached-file>

功能：获取缓存的缩略图文件
参数：<cached-file>为缓存文件名
响应：若缓存存在，返回缓存文件；否则返回404

致谢

感谢https://github.com/algoo/及https://github.com/algoo/preview-generator的所有贡献者。

许可证

详见LICENSE文件