pspdfkit/document-engine

Document Engine Docker镜像文档

镜像概述和主要用途

Document Engine Docker镜像是一款企业级文档处理解决方案，旨在替代PSPDFKit Processor和Server产品。该镜像提供开箱即用的文档处理能力，支持通过API接口实现PDF及多格式文档的转换、编辑、OCR识别、电子签名等功能，适用于构建云原生文档服务、集成到业务系统或部署为独立的文档处理引擎。

核心功能和特性

• 多格式文档处理：支持PDF、Office文档（Word、Excel、PowerPoint）、图片（JPG、PNG）等格式的解析与格式转换。
• PDF高级操作：提供文档合并/拆分、页面旋转/重组、压缩优化、加密/解密、水印添加等功能。
• OCR文字识别：集成光学字符识别引擎，支持多语言文本提取，可将扫描件转换为可搜索PDF。
• 电子签名与批注：支持添加数字签名、批注、注释及表单填写功能，符合PDF/A标准。
• RESTful API接口：提供标准化HTTP API，支持同步/异步任务处理，易于与第三方系统集成。
• 水平扩展支持：无状态服务设计，可通过容器编排工具实现集群部署，满足高并发场景需求。

使用场景和适用范围

• 企业文档管理系统：集成到内部DMS系统，实现文档自动化处理与格式标准化。
• SaaS应用集成：为云服务提供嵌入式文档处理能力，如在线协作平台、CRM系统的附件处理。
• *****/*行业：用于合同文档的电子签名、合规性检查及存档处理。
• 教育/出版领域：实现课件转换、扫描教材OCR识别、电子书生成等场景。
• 开发者工具链：作为后端服务支撑应用内文档预览、编辑功能开发。

详细的使用方法和配置说明

系统要求

• Docker Engine 20.10+ 或 Docker Desktop 4.0+
• 最低配置：2 CPU核心、4GB内存、10GB磁盘空间
• 网络要求：可访问外部资源（首次启动需下载依赖组件）

获取镜像

bash
docker pull pspdfkit/document-engine:latest

基础使用（docker run）

快速启动命令

bash
docker run -d \
  --name document-engine \
  -p 8080:8080 \
  -v $(pwd)/data:/data \
  -e API_KEY="your-secure-api-key" \
  pspdfkit/document-engine:latest

参数说明

• -p 8080:8080：映射容器8080端口到主机，用于API访问
• -v $(pwd)/data:/data：挂载主机目录到容器，用于文档输入/输出持久化
• -e API_KEY：设置API访问密钥（必填，用于请求鉴权）

高级部署（docker-compose）

docker-compose.yml配置

yaml
version: '3.8'

services:
  document-engine:
    image: pspdfkit/document-engine:latest
    container_name: document-engine
    restart: always
    ports:
      - "8080:8080"
    volumes:
      - ./data/input:/data/input      # 待处理文档目录
      - ./data/output:/data/output    # 处理结果输出目录
      - ./config:/etc/document-engine # 自定义配置文件目录
      - ./logs:/var/log/document-engine # 日志持久化
    environment:
      - PORT=8080                     # 服务监听端口
      - API_KEY=${API_KEY}            # API密钥（通过.env文件传入）
      - LOG_LEVEL=info                # 日志级别：debug/info/warn/error
      - MAX_PARALLEL_TASKS=5          # 最大并发任务数
      - OCR_LANGUAGES=eng,chi_sim     # 启用的OCR语言包（英文、简体中文）
      - CORS_ALLOWED_ORIGINS=*        # CORS允许的源地址
    resources:
      limits:
        cpus: '2'
        memory: 4G

.env文件配置

env
API_KEY=your_secure_api_key_here

启动服务

bash
docker-compose up -d

配置参数说明

环境变量配置

目录挂载说明

API使用示例

文档格式转换（DOCX转PDF）

bash
curl -X POST http://localhost:8080/api/v1/convert \
  -H "Authorization: Bearer your_secure_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "input_path": "/data/input/sample.docx",
    "output_path": "/data/output/sample.pdf",
    "format": "pdf",
    "options": {
      "compress_images": true,
      "image_quality": 80
    }
  }'

OCR文字识别（扫描件转可搜索PDF）

bash
curl -X POST http://localhost:8080/api/v1/ocr \
  -H "Authorization: Bearer your_secure_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "input_path": "/data/input/scan.pdf",
    "output_path": "/data/output/ocr_result.pdf",
    "languages": ["eng", "chi_sim"],
    "output_format": "searchable_pdf"
  }'

注意事项

• 安全建议：生产环境中API_KEY需使用强密钥并定期轮换，避免使用CORS_ALLOWED_ORIGINS=*，限制为具体域名。
• 性能优化：处理大型文档（>100MB）时，建议增加内存资源限制（至少4GB）并降低并发任务数。
• OCR语言包：首次启用新语言包时，服务会自动下载对应资源（约50-200MB/语言），可能导致首次请求延迟。
• 数据备份：定期备份/data/output目录，避免容器重建导致处理结果丢失。
• 版本管理：生产环境建议使用具体版本号（如pspdfkit/document-engine:2.1.0）而非latest标签，确保环境一致性。

相关资源

• 官方产品页面
• 完整API文档
• 使用指南
• 常见问题解答