I created this fork years ago because I had to do some changes to the original project and decided to share my work with the community.
What you want to know...
- Documentation: The JODConverter documentation (work in progress) can be found here.
- jodconverter-local module dependencies. This fork does not depend on SIGAR. JODConverter only needs to retrieve office processes (PIDs) and kill office processes (using PID). It should work just fine without SIGAR with the actual process managers created from an older version of JODConverter. But I added the ability to use any process manager you would like to implement if none of the provided managers can be used. See the processManager configuration option.
- jodconverter-remote module dependencies.
- jodconverter-spring module dependencies.
- jodconverter-spring-boot-starter module dependencies.
- Tests: JODConverter is supposed to work just fine on recent versions of Windows, MacOS and Unix/Linux. Any confirmation would be welcome so we could build a list of official supported OS distributions.
Usage for local conversions
<dependency> <groupId>org.jodconverter</groupId> <artifactId>jodconverter-local</artifactId> <version>4.3.0</version> </dependency>
Building the Project
Build default, JODConverter is built using the OpenOffice libraries. See here to know why. Bu you can build the project using the LibreOffice libraries with the
With OpenOffice libraries:
gradlew clean build -x test
With LibreOffice libraries:
gradlew clean build -x test -PuseLibreOffice
Building Cli Executable
gradlew clean build -x test distZip
JODConverter Gitter Community , growing FAQ.
How to contribute
- Check for open issues, or open a new issue to start a discussion around a feature idea or a bug.
- If you feel uncomfortable or uncertain about an issue or your changes, feel free to contact me on Gitter using the link above.
- Fork this repository on GitHub to start making your changes.
- Write a test showing that the bug was fixed or that the feature works as expected.
- Note that the repository follows the Google Java style. You can format your code to this format by typing gradlew spotlessApply on the subproject you work on (e.g,
gradlew :jodconverter-local:spotlessApply), by using the Eclipse plugin, or by using the Intellij plugin.
- Create a pull request, and wait until it gets merged and published.
Here are my favorite/inspiration forks/projects:
- XWiki fork: Nice choice if you can afford using the SIGAR tools (which I couldn't sadly). The filter package is strongly inspired by this project.
- Nuxeo fork: Nice choice if you don't want to use SIGAR and don't came across an unresponsive office process following a timeout exception that drives you crazy.
- documents4j project: Nice choice if you want 100% perfect conversion using MS Office. But work only on Windows out of the box (Local implementation) and not totally free (since MS Office is not free). The new "job" package is strongly inspired by this project.
A special thanks to:
@michelole who created a pull request in these two forks with a stress test that made my office process to crash every times! My first commit was when I was able to build my things with his stress test on!!
JODConverter (Java OpenDocument Converter) automates document conversions using LibreOffice or OpenOffice.org.
If this project helps you, please consider a donation. I have to pay for the jodconverter web site (domain and hosting) every year. I also sit on my chair in front of a monitor a lot instead of being outside drinking a beer to improve this project