Skip to main content
Language Selector

  1. Other Languages

    (machine translation)

Planview Customer Success Center

Does Hub support the use of port forwarding/reverse proxies?

  1. Last updated
  2. Save as PDF

Last Updated: August 1,   |  Applicable Hub Versions: All

Answer

Port forwarding and reverse proxy are two techniques that we are equipped to provide limited support for given their widespread use. However, we recommend exercising caution and only applying them in limited scenarios to maintain controlled access for web applications.

Port Forwarding

To provide access to Hub through https://hub.server.domain, see the instructions below. 

Prerequisites

  • Hub should have a valid SSH certificate installed and should be configured correctly using the SSL Certificate Installation instructions. 

  • The Hub domain, hub.server.domain, should be configured to direct the Hub server correctly. 

Instructions

  1. Open the Hub server’s router.

  2. Create a new port forwarding rule:

    • External port:443 

    • Internal IP address: the IP address for Hub server 

    • Internal port 8443 

Reverse Proxies

To provide access to Hub through proxy server at https://proxyServerName, see the instructions below.

Prerequisites

  • Hub should have a valid SSH certificate installed and should be configured correctly using the SSL Certificate Installation instructions. 

  • The Hub server and proxy server network connection should be working.

  • Proxy server has configured with all required X-Forwarded and X-Forwarded-* headers. For details on setting these headers, consult the documentation for your reverse proxy. 

Instructions

  1. Edit the hosts file on the machine so that the incoming URL resolved to localhost IP address as the proxy server is not accessible 

  1. Edit the tasktop-hub.properties file to set keycloak.custom.auth-server-url=https://proxyServerName:8443/auth 

  1. Edit the Tomcat server.xml file is in Planview Hub's data directory (default: C:\ProgramData\Tasktop\, or the location where Hub is installed on Linux) undercontainer/conf/server.xml. to add the following in the SSL Connector setting: proxyname="proxyServerName" proxyPort="443"

    • Note: Changes made directly on server.xml won’t be persisted when upgrading Hub. Please ensure to keep the copy of the server.xml and restore the configuration after upgrading. 

  1. Restart Hub.

Note: If Hub is running behind a reverse proxy, it may result in HTTP 413 Payload Too Large errors if the reverse proxy is configured with a maximum payload size. In this case, we recommend configuring the reverse proxy without a maximum size.