How to set up Sapho Server to work with a proxy server

Audience: System administrators installing and configuring Sapho Server

Sapho Server’s connectors use web services to call SaaS services and use Amazon Simple Notification Service for push notification delivery. In order for these features to work, Sapho Server requires access outside of corporate networks. If your corporate network uses a proxy for access to the Internet, configure your Tomcat server according to the instructions below.

Steps for UNIX systems

  1. Open up the catalina.sh file on your Tomcat server.
  2. Add following command to the beginning of the file:
    export _JAVA_OPTIONS="$_JAVA_OPTIONS
    -Dhttps.proxyPort=yourproxyport
    -Dhttps.proxyHost=yourproxyserverurl.com
    -Dhttps.proxyUser=yourproxyuser
    -Dhttps.proxyPassword=yourproxypassword"

    Note: Depending on whether your proxy is https, you can use either
    -Dhttps.proxyHost=yourproxyserverurl.com or
    -Dhttp.proxyHost=yourproxyserverurl.com
  3. Restart your Tomcat server.

Steps for Windows systems

  1. Open up the catalina.bat file on your Tomcat server.
  2. Add the following command to the beginning of the file:
    set _JAVA_OPTIONS="%_JAVA_OPTIONS%
    -Dhttps.proxyHost=yourproxyserverurl.com
    -Dhttps.proxyPort=yourproxyport
    -Dhttps.proxyUser=yourproxyuser
    -Dhttps.proxyPassword=yourproxypassword"

    Note: Depending on whether your proxy is https, you can use either
    -Dhttps.proxyHost=yourproxyserverurl.com or
    -Dhttp.proxyHost=yourproxyserverurl.com
  3. Restart your Tomcat server.

Alternatively, you can adjust the settings using Tomcat Monitor:

  1. Right-click on Tomcat Monitor in your system tray, choose 'Configure', and switch to the 'Java' tab.
  2. Append the following to the to the bottom of the Java options:
    -Dhttps.proxyHost=yourproxyserverurl.com
    -Dhttps.proxyPort=yourproxyport
    -Dhttps.proxyUser=yourproxyuser
    -Dhttps.proxyPassword=yourproxypassword

    Note: Depending on whether your proxy is https, you can use either
    -Dhttps.proxyHost=yourproxyserverurl.com or
    -Dhttp.proxyHost=yourproxyserverurl.com
    image__4_.png
  3. Restart your Tomcat server.

Checking Proxy Settings in Sapho Builder

You can confirm the settings of your proxy server in Sapho Builder. To do this, simply navigate to the Settings page and then click on Proxy in the menu on the left side of the screen. Please note that these values are read-only.

Proxy1.png