What is PDFreactor?
PDFreactor is a powerful formatting processor that enables server-side PDF conversion from HTML 5 documents using CSS to define page layout and styles. You can dynamically generate PDF documents such as reports, invoices, statements and others on-the-fly.
By implementing the W3C specification for Paged Media and print, PDFreactor provides great control over the paged output via CSS. It is very easy to set page sizes, margins and pagination for specific elements, page headers and footers. It enables you to set PDF specific information, to generate outlines and links for your documents and even to add meta information about the author or keywords.
This docker image provides a ready-to-use PDFreactor Web Service, which can then be used to convert HTML to PDF via the REST API or one of the API wrappers available at www.pdfreactor.com.
This docker image is provides "as-is", without any warranty or support.
The software "PDFreactor" contained in this image is a commercial product and subject to the PDFreactor Software License Agreement. To use PDFreactor in a production environment, an appropriate license is required.
For more information about PDFreactor, please visit www.pdfreactor.com.
How to use this image
$ docker run -d -p 8080:9423 realobjects/pdfreactor
This will map the PDFreactor Web Service running in the docker container on port
9423 to port
var pdfReactor = new PDFreactor("http://yourhost.com:8080/service/rest");
$ docker run -d -p 8080:9423 -v /your/config:/ro/config realobjects/pdfreactor
We recommend mapping a volume from your host system to
/ro/config, since you can then use this volume to set the license, fonts and configuration of PDFreactor.
Setting a license key
PDFreactor will run in evaluation mode when no license key is used. By default, it will look for a license key in
/ro/config/licensekey.txt. You can mount a license key from your host volume to this path to set a license key for PDFreactor.
If you do not have a license key, you can obtain a free personal license for your personal, non-commercial license. For commercial projects, you can request an evaluation license or purchase a license.
PDFreactor looks for fonts in
/ro/config/fonts. If you would like to use any fonts that are not available by default in PDFreactor, you will need to place your fonts in the
fonts subdirectory of the
config volume you mapped. These fonts will then automatically be available to PDFreactor.
Additional server configuration
Additional configuration options for the server can be specified for the PDFreactor Web Service. These are either parameters the client should not or cannot influence, and they affect all conversions.
These parameters can be set by placing a file called
pdfreactorwebservice.config in the volume mapped as
/ro/config (or by mapping
In addition, the memory and Java system properties for the PDFreactor Docker container can also be specified by passing an environment variable called "JAVA_OPTIONS" to the "docker run" command when starting your PDFreactor container. For example:
$ docker run -d -p 8080:9423 -e JAVA_OPTIONS="-Xmx2g -Dcom.realobjects.pdfreactor.webservice.threadPoolSize=4" realobjects/pdfreactor
The example above shows how to specify a maximum memory heap size of 2g as well as well a "threadPoolSize" of 4 when running the PDFreactor container.
Note that if you are using Docker Compose, you can of course also specify the "JAVA_OPTIONS" environment variable using the "environment" key in your
version: '2' services: pdfreactor: container_name: pdfreactor ports: - "86:9423" image: "realobjects/pdfreactor" environment: JAVA_OPTIONS: "-Xmx2g -Dcom.realobjects.pdfreactor.webservice.threadPoolSize=4"
For details about the available server parameters, see the Server Parameters chapter in the manual.
The software "PDFreactor" contained in this image is a commercial product and subject to the PDFreactor Software License Agreement. To use PDFreactor, an appropriate license is required.
Further third-party licensing information is provided in the
/ro/pdfreactor/license directory in the PDFreactor image.
PDFreactor is a registered trademark of RealObjects GmbH.