document-preview-microservice

README

Generate document previews micro service

A micro service for generating Generate document previews. The most common document and image formats are supported!

Build

docker build -t generate_document_previews .

Run

docker run -p 3030:3030 -e KEY=access_key -it --rm generate_document_previews

/api/preview

• Method: POST
• Body: Multipart form
• Form data fields:
  • document: File
  • height: Number
  • width: Number
• Required headers:
  • Authorization: Bearer $KEY
• Supported file types
  • image/png, image/jpeg, image/gif, image/webp
  • application/pdf, application/x-pdf, application/x-bzpdf, application/x-gzpdf (requires pdftocairo from poppler OR soffice from openoffice)
  • word, powerpoint and excel like files supported by openoffice (requires soffice from openoffice)
• responses
  • 200: Image of content type image/webp
  • 500: Error string of type text/plain
  • 401: Unauthorized of type text/plain

Env:

• $KEY Required: The Bearer key
• $SOFFICE_PATH: If the soffice binary is not in the path you can set it in here
• $PORT: Change the default port number (3030)