Skip to main content
Version: 9.0

Proxy

If the webPDF server needs to retrieve external contents, it normally does so directly. However, there are cases in which webPDF is run on a server that does not have access to external resources or URLs, meaning that it cannot retrieve any content from other servers or from the Internet. However, this access is required, for instance, in order to convert various file formats (e.g., e-mails) when they reference external resources.

In order to make it possible to have this access, you can configure the use of a proxy in webPDF, in which case webPDF will attempt to run all external requests through this proxy in order to retrieve the necessary content.

The proxy’s use is configured at the server level, i.e., it applies to the entire server and all web services.

The easiest way to configure the proxy is to do so in the Admin Portal, in the "Proxy" section.

Optionally, you can also configure the proxy directly in the application.xml file.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>  
<server xmlns="http://schema.webpdf.de/1.0/configuration/application">
<!-- ... -->
<proxies>
   <proxy host="http://proxy-server.example.com" port="8081" scheme="http" userName="" password=""/>
   <proxy host="http://proxy-server.example.com" port="8443" scheme="https" userName="" password=""/>
</proxies>
<!-- ... -->
</server>

All the proxies need to be entered under the proxies element.

host = Proxy server address
port = Proxy server port
scheme = The scheme that should be used for the proxy server ("http" and "https" are the only options allowed as of this writing)

If the server requires authentication, you can set up the corresponding information with userName and password.

After you change the configuration, you will have to restart the server.