Skip to content
This repository has been archived by the owner on Oct 5, 2024. It is now read-only.

Latest commit

 

History

History
87 lines (63 loc) · 4.39 KB

README.md

File metadata and controls

87 lines (63 loc) · 4.39 KB
Raw

ODF2PDF

ODF2PDF is a server based on Flask that receives open document files and returns converted PDF files. The initial implementation focus on .odt (word processing) documents with .docx as an optional support.

The server should be called through HTTP.

Configuration

Application configuration is controlled through environment variables.

Variable Description Default value
ODF2PDF_LOG_DIR Location in the filesystem where logs will be saved. Default path where the application is located
ODF2PDF_HOST Host from which application requests will be served. 0.0.0.0
ODF2PDF_PORT Default port number. 4000
ODF2PDF_WAIT_FOR_START How long the worker should wait for LibreOffice in seconds. 10
ODF2PDF_WORKERS How many workers will be instantiated. Each worker is bound to a LibreOffice server instance. One worker per processor core.
ODF2PDF_REQUEST_CHUNK_SIZE Size of the byte buffer that will be used to read requests from the API caller in bytes. 40960 bytes

API methods

The API exposes the following functions:

/api/v1/pdf

Converts a document to PDF.

Input parameters:

  • (Header) Content-Type: MIME type of the document. Supported content types:
    • application/vnd.oasis.opendocument.text (odt)
    • application/vnd.openxmlformats-officedocument.wordprocessingml.document (docx)
  • (Header) X-Request-Id: optional header, associate a particular ID to the request.
  • (Body) Request body: binary file to be conveted Output parameters:
  • (HTTP Code) HTTP result code: 200 OK
  • (Body) Response body: conversion result

HTTP Return Codes:

  • 200: document converted successfully
  • 411: input document has zero length
  • 415: input document format not supported
  • 500: internal application error

Testing

  • odt
curl -v -H "Content-Type: application/vnd.oasis.opendocument.text" -o lorem.pdf https://localhost:4000/api/v1/pdf --data-binary @samples/lorem.odt
curl -v -H "Content-Type: application/vnd.oasis.opendocument.text" -H "X-Request-Id: my_req_id" -o lorem.pdf https://localhost:4000/api/v1/pdf --data-binary @samples/lorem.odt
  • docx
curl -v -H "Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document" -o lorem.pdf https://localhost:4000/api/v1/pdf --data-binary @samples/lorem.docx
curl -v -H "Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document" -H "X-Request-Id: my_req_id"_-o lorem.pdf https://localhost:4000/api/v1/pdf --data-binary @samples/lorem.docx

Benchmarking

  • odt

    • Simple document: ab -n 1000 -c 10 -T 'application/vnd.oasis.opendocument.text' -p samples/lorem.odt https://localhost:4000/api/v1/pdf
    • Complex document: ab -n 1000 -c 10 -T 'application/vnd.oasis.opendocument.text' -p samples/0116GS3-OpenSourceStandardsDoc.odt https://localhost:4000/api/v1/pdf

  • docx

    • Simple document: ab -n 1000 -c 10 -T 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' -p samples/lorem.docx https://localhost:4000/api/v1/pdf
    • Complex document: ab -n 1000 -c 10 -T 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' -p samples/demo.docx https://localhost:4000/api/v1/pdf

Fonts

For best results, install the following packages:

  • MS Core Fonts: apt-get install ttf-mscorefonts-installer)
  • Carlito and Caladea (to replace Calibri and Cambria): apt-get install fonts-crosextra-carlito fonts-crosextra-caladea
  • PowerPoint Viewer 97 fonts: https://gist.github.com/maxwelleite/10774746

References