PDFreactor Server Parameter Documentation

adminKey

This parameter specifies a key for privileged access to the service.

Type: String

adminKeyPath

Similar to adminKey, but specifies the path to a file containing the admin key. If the path of this parameter indicates a directory, the contents of the file adminkey.txt are used, if present within the directory.

Type: Path

apiKeys

This parameter specifies a comma separated list of strings that are used as API keys.

Type: List<String>

apiKeysPath

Similar to apiKeys, but instead of a comma separated list it specifies the path to a file containing a JSON object with API keys as keys and a description as value. If the path of this parameter indicates a directory, the contents of the file apikeys.json are used, if present within the directory.

Type: Path

assetPackageFiles

This parameter limits the maximum number of files that an asset package may contain. A value of 0 or a negative value indicates that there is no file limit. The default value is 1000.

Type: Integer
Unit: Amount

assetPackageMaxSize

Limits the maximum size of the asset package (in bytes). A value of 0 or a negative value indicates that there is no size limit. By default, no maximum size is configured.

Type: Long
Unit: Bytes

callbackMaxTimeout

Callback timeouts with a negative or zero value are treated as an infinite timeout. If infinite timeouts are undesirable for your server, you can limit it to this value (in milliseconds). By default, no maximum timeout is configured.

Type: Integer
Unit: Milliseconds

callbackTimeout

When clients specify callbacks without a timeout, this value will be used as a default timeout (in milliseconds) for connections to the callback URL. The default value is 30000 (30 seconds).

Type: Integer
Unit: Milliseconds

cleanupInterval

This parameter specifies the interval (in days) at which the PDFreactor Web Service deletes asynchronous conversion results that have not been retrieved. The default value is 5.

Type: Integer
Unit: Days

conversionCacheSize

This parameter specifies the amount of conversions that are kept in memory (only their metadata, without the document). Otherwise they have to be reloaded from the file system.

Type: Integer
Unit: Amount

conversionTimeout

Specifies a timeout in seconds after which conversions automatically terminate. Specifying the value "0" means that there is no timeout. By default, no timeout is configured.

Type: Integer
Unit: Seconds

debugLocalDir

This specifies the directory where debug files will be dumped by PDFreactor in case debug mode is enabled and no converted document could be created.

Type: Path

disableDocTemp

If set to true, the Web Service will not use a temp folder. This also means that asynchronous conversions are not available. Synchronous conversions will be done in-memory, so make sure that the Web Service has sufficient amounts of memory available.

Type: Boolean

disableFontCache

If set to true, the Web Service will not use a file-based font cache. Generally, this is not recommended since the font cache will then have to be created for every conversion which is likely to have a significant performance impact. The default value is false.

Type: Boolean

disableFontRegistration

If set to true, font registration is disabled and any existing font cache will be ignored and the font directories will be scanned for font information. The default value is false.

Type: Boolean

disableSystemFonts

If set to true, PDFreactor will neither scan for nor use system fonts that are installed on the server. Only fonts specified via CSS and via the server parameter fontDirs as well as PDFreactor internal fonts will be used.

Type: Boolean

docTempDir

This parameter specifies the location of the Web Service's temporary folder which is used to store asynchronously converted documents. The pre-configured location is the pdfreactor/doctemp directory in the PDFreactor/jetty directory.

Type: Path

docTempRetentionPeriod

Asynchronous conversions create temporary files on the server, which are automatically deleted when they are read once. If results of asynchronous conversions are not accessed, these files remain on the server and are deleted after a certain amount of days equal to this parameter. The default value is 5 (days). A negative value means that abandoned temporary files will never be deleted.

Type: Integer
Unit: Days

docTempStructure

This parameter configures the structure of the directory where PDFreactor stores temporary documents. If set to flat (the default value), all documents are placed in the same directory. If set to datetime, temporary documents are placed in subfolders representing the date and hour when the conversion started. A flat structure is recommended when using a shared temporary document storage directory.

Type: Enum
Values: datetime | flat

fontCacheDir

This specifies the directory of the font cache, which will be created by PDFreactor. If no path is specified, the font cache will be created in PDFreactor/jetty/pdfreactor/fontcache.

Type: Path

fontDirs

This parameter takes a colon or semicolon separated list of directories that PDFreactor should scan for fonts.

Type: List<Path>

ignoreClientPriority

If set to true, the Web Service will ignore any priority specified via the priority property in the client's Configuration object.

Type: Boolean

licenseKeyPath

Specifies a file system path, either directly to the license key file or to a directory where the license key file is located.

Type: Path

licenseKeyUrl

Specifies a URL where the license key file is located.

Type: URL

overrideConfig

A URL or path to a file containing a server-side configuration which is used to override any properties in the configuration send by clients. The file must be a Configuration object in JSON format.

Type: URL

overrideConfigMergeMode

The merge mode used when specifying an overrideConfig. The default mode is shallow, which means that the overrideConfig and the client config are shallow-merged, i.e. top-level properties of the overrideConfig completely override those in the client config. When using the mode deep, the two configs are deep-merged.

Type: Enum
Values: deep | shallow

securitySettings.allowExternalXmlParserResources

This parameter specifies whether the XML parser will process external XML resources during parsing, e.g. DTDs, entities, XInlcudes. This does not affect HTML5 document processing.

Type: Boolean

securitySettings.allowRedirects

This parameter specifies whether to allow automatic URL redirects when PDFreactor receives appropriate status codes.

Type: Boolean

securitySettings.connectionRules

A URL or path to a file containing a list of rules that PDFreactor evaluates and then either denies or allows connections to a particular resource. The file must be a JSON array of ConnectionRule objects in JSON format.

Type: URL

securitySettings.defaults.allowAddresses

This parameter specifies a list of address types to where PDFreactor is allowed to connect.

Type: List<Enum>
Values: link_local | local | private | public

securitySettings.defaults.allowFileSystemAccess

This parameter specified whether to allow document resources such as CSS or JavaScript file system access.

Type: Boolean

securitySettings.defaults.allowProtocols

This parameter specifies a list of allowed URL protocols. URLs with protocols not in this list will be blocked. Note that "file" protocols are handled by securitySettings.defaults.allowFileSystemAccess instead.

Type: List<String>

securitySettings.defaults.allowSameBasePath

This parameter specifies whether to allow loading of document resources that have the same base path as the document.

Type: Boolean

securitySettings.hideVersionInfo

Specifies whether PDFreactor will include version information in the PDF metadata or in response headers.

Type: Boolean

securitySettings.untrustedApi

Specifies whether the PDFreactor configuration object is considered an untrusted context for the purpose of security. If it is a trusted context, URLs that are specified in the configuration object are not vetted against the security settings and are always allowed. If it is not trusted, the same security settings that are used for document resources apply to all configuration resources (including the document) as well.

Type: Boolean

serverLogLevel

This parameter configures the log level of the server's log. The following levels are available:

severe (least verbose)
warning
info
config
fine
finer
finest (most verbose)

The level off disables server logging. The default value is config.

Type: Enum
Values: all | config | fine | finer | finest | info | off | severe | warning

serverLogMode

This parameter configures the log mode of the server. If set to bulk (the default value), the entire log output of a PDF conversion is dumped after the conversion is finished. This can also be set to live which outputs log entries directly. However if there are multiple conversions in parallel, log entries from other conversions may be written out at the same time, so there is no guarantee that you will receive a coherent log of a single conversion (contrary to bulk). The mode off disables the server-side logging of all conversions.

Type: Enum
Values: bulk | live | off

systemdLogLevel

This parameter configures Systemd logging. If this parameter is configured, log messages will be logged to the Systemd log in addition to the server log file. Available values are SEVERE, WARNING, CONFIG, and INFO. Systemd logging is only supported for Linux system that support Systemd. You can access PDFreactor logs through their identifier, e.g. journalctl -t pdfreactor

Type: Enum
Values: config | info | severe | warning

threadPoolSize

This parameter determines the number of parallel conversions that can be performed by the PDFreactor Web Service. Please note that while there is no maximum value for this, only a thread pool size that is lower as or equal to the system's maximum amount of threads will increase performance when converting documents in parallel. The default value is calculated from the system's number of processors.

Type: Integer
Unit: Amount