paulgueltekin/officeconverter

WAT

Offers a (i think production ready) REST service to convert files like PDF, docx,xlx .. odt .. you get it.. to other formats like pdf, png, doc, pdt, html. This project is basically an extended version of jodconverter-sample-rest

You can use this project as is using docker with eugenmayer/kontextwork-converter or build it here yourself.

Build

local java build, when you have all the build tools present + libreoffice locally installed

./gradlew build
# you find the artifact in /tmp/gradle-officeconverter/builds/libs/officeconverter-*.jar
# the jar file is a full tomcat bundled app, so just start it like that
java -jar /tmp/gradle-officeconverter/build/libs/officeconverter-*.jar

or better use the docker image with all included, no dev tools/LO needed locally

# this builds the source a
make build

make start-prod # or `make start` for the variant with swagger

# alternativly
docker run --memory 512m --name converter-prod --rm -p 8080:8080 eugenmayer/kontextwork-converter:production
# or dev mode with swagger and a debugger on 5001
docker run --memory 512m --name converter-dev --rm -p 5001:5001 -p 8080:8080 eugenmayer/kontextwork-converter:development

You can no connect to the 5001 remote debugger port, just use the existing IntelliJ task if you like

Tests

You can run the tests locally (you will need libreoffice installed)

./gradlew itTest

Or in the docker-container

make test

Development

You can either use the IDE task or the local gradle

./gradlew -Pdev bootRun

Or even better, use the development container. You will not need any LibreOffice/Gradle installed locally

 make start-src # basically just docker-compose up

This fires up a docker container, mounts your source. To auto-rebuild and auto-restart he app very quick do this

 make watch
 # or just run ./watch.sh localy

Debugging

Of course you can just start using your IDE and debug that, but if you want to debug inside the docker container

make start

And now connect(attach) to localhost 5001 for debugging eugenmayer/kontextwork-converter:development has a default remote debugging port enabled on 5001

REST endpoints

Start the project and access http://localhost:8080/swagger-ui.html to browse, inspect and try the REST endpoints. You find all the docs there.

Release

Adjust the VERSION and increment the version

# this will build the docker images, tag the repo and the image and push the repo and the images
make build tag push

# or
make release

Configuration

You can configure the docker images by mounting /etc/app/application.properties and put whatever you like into them.

For example if you like to have 2 LibreOffice instances, you would put into the file

# amount of libreOffice instances to start - one for each given port. So this means 2
jodconverter.local.port-numbers: 2002, 2003
# change the tmp folder
jodconverter.local.working-dir: /tmp
# change upload sizes
spring.servlet.multipart.max-file-size: 5MB
spring.servlet.multipart.max-request-size: 5MB
# change the server port (where the REST app is listenting
server.port=8090

Adding addition document formats

You can edit the src/resources/document-formats.json and add new custom formats. The original can be found at (https://github.com/sbraconnier/jodconverter/blob/master/jodconverter-core/src/main/resources/document-formats.json)[jodconverter-core].

We already added support for dotx/xltx for example.

Internals

state of the art springboot 2.3 application exposing a classic rest service to convert office document
using jodconverter-spring-boot-starter for wiring jodconverter-local services
build on/for Java 11 for better Docker support

Credits

A lot of credits go to jodconverter by jodconverter - we completely base on his work. Cheer him up!

paulgueltekin / officeconverter

WAT