Generate Document Cover

Generate Document Cover Processor #

Generates a cover image and a thumbnail for a document.

Note: For attachment cover generation, use generate_attachment_cover instead.

The generated cover and thumbnail are stored with the document and can be retrieved via the document API.

Supported formatNotes
PDFCover from the first page
PPTX / DOCX / XLSX and OpenDocument equivalentsCover from the first page
MarkdownRendered cover
ImageThumbnail of the image itself

Requirements/Dependencies #

ToolRequired for
pdftoppm (poppler-utils)PDF cover generation
LibreOffice (soffice)Office document cover generation
Chromium (headless)Markdown rendered cover

Configuration #

ParameterTypeRequiredDefaultDescription
message_fieldstringNomessagesPipeline context key for the input messages
output_queueobjectNonullQueue to push processed documents to

Example #

- generate_document_cover:
    output_queue:
      name: "documents_with_cover"
Edit Edit this page