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.
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 |
The API exposes the following functions:
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
- odt
curl -v -H "Content-Type: application/vnd.oasis.opendocument.text" -o lorem.pdf http: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 http: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 http: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 http:https://localhost:4000/api/v1/pdf --data-binary @samples/lorem.docx-
odt
- Simple document:
ab -n 1000 -c 10 -T 'application/vnd.oasis.opendocument.text' -p samples/lorem.odt http:https://localhost:4000/api/v1/pdf - Complex document:
ab -n 1000 -c 10 -T 'application/vnd.oasis.opendocument.text' -p samples/0116GS3-OpenSourceStandardsDoc.odt http:https://localhost:4000/api/v1/pdf
- Simple document:
-
docx
- Simple document:
ab -n 1000 -c 10 -T 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' -p samples/lorem.docx http:https://localhost:4000/api/v1/pdf - Complex document:
ab -n 1000 -c 10 -T 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' -p samples/demo.docx http:https://localhost:4000/api/v1/pdf
- Simple document:
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
- ODF Mime Types: https://www.openoffice.org/framework/documentation/mimetypes/mimetypes.html
- MS Office Mime Types: http:https://blogs.msdn.com/b/vsofficedeveloper/archive/2008/05/08/office-2007-open-xml-mime-types.aspx
- LibreOffice Filters: https://ask.libreoffice.org/en/question/59186/what-are-the-5x-impress-importexport-filters/
- Reading streaming data with Werkzeug: http:https://blog.pelicandd.com/article/80/streaming-input-and-output-in-flask
- Official reference for HTTP return codes: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
- OpenOffice Connection URL: https://www.openoffice.org/udk/common/man/spec/uno-url.html
- Starting multiple LibreOffice processes concurrently: https://ask.libreoffice.org/en/question/42975/how-can-i-run-multiple-instances-of-sofficebin-at-a-time/
- Adding request IDs to Flask: http:https://blog.mcpolemic.com/2016/01/18/adding-request-ids-to-flask.html