Skip to main content

Set up a proxy configuration

Setting up a proxy configuration for your on-premises installation lets you integrate Contrast with tools that exist inside your network (and don’t require a proxy) and outside of your network (which require web proxy access).

Set up methods

You can use either of these methods to set up a proxy configuration:

  • JVM arguments in the contrast-server.vmoptions file.

  • The proxy settings in the Contrast Web interface.

    JVM arguments in the options file override settings in the Contrast web interface.

Steps

  • Use JVM arguments (prerferred method)

    1. In the Contrast bin directory, c:/Program Files/Contrast/bin or the default directory /opt/Contrast/bin ,open contrast-server.vmoptions.

    2. Add these JVM arguments to the file (for security purposes, https arguments are preferred):

      • https.proxyHost or http.proxyHost

        The host name of the proxy server. Use this argument for communication with externally-hosted software.

      • https.proxyPort or http.proxyPort

        The port number on which the proxy server listens for traffic.

      • http.nonProxyHosts

        A list of hosts, separated by a vertical bar (|), which you connect to directly, bypassing the proxy server. This argument works for both https and http configurations.

        Use this argument to exclude on-premise hosts that are deployed in the same network as your Contrast installation.

        For example, if you have an on-premises Jira installation as well as an integration for MS Teams in the cloud, you can use the http.nonProxyHosts argument to exclude the Jira integration from using the proxy server, as shown in the following example:

        -Dhttps.proxyHost=89.148.22.17 
-Dhttps.proxyPort=3128 
-Dhttp.nonProxyHosts=jira.mycompany.com|*.internal.mycompany.com

        In this example, the proxy host is 89.148.22.17, listening for traffic on port 3128. This configuration bypasses the proxy server when communicating with the host for jira.mycompany.com as well as hosts matching *.internal.mycompany.com.

  • Use the Contrast web interface:

    1. In the user menu, select SuperAdmin.

    2. Select System settings.

    3. Under Internet settings, select Proxy.

      Image shows the Proxy toggle as selected.

    4. Specify the proxy host name, the port number, the username for the proxy server, and the password for the proxy server.

      ProxySettings.png

    5. Select Save.

In this section: