Reverse Proxy Configuration
You can set up Hub to work behind a reverse proxy server.
The process that you use to enable this setup consists of the following steps:
- Configure Hub to point to the base URL of the proxy server.
- Configure the headers of your proxy server. This page includes guidelines for Apache, IIS, and Nginx servers and the Pound reverse proxy.
Change the Base URL of your Hub Server
You can use the following procedure to change the base URL for both ZIP and MSI distributions. To execute these commands in an MSI distribution, open the Command Prompt window as an administrator. Always execute the configure command on behalf of the OS user that runs the Hub service. This command creates configuration files and folders. The Hub service user should have sufficient permissions to access these files and folders.
To change the base URL of your Hub server:
- Stop the Hub service. For specific instructions, see Stop and Start the Hub Service.
- In a command-line interface, change the directory to
<hub_home>/bin. - Enter the following command:
hub.sh configure --listen-port 1111 --base-url http://hub.mydomain.com:2222 - Configure the headers in your proxy server. Follow the guidelines that are appropriate for your Apache, IIS, Nginx server, or Pound reverse proxy.
- Start the Hub service. For specific instructions, see Stop and Start the Hub Service.
Configure Proxy Server Headers
To configure the headers in your proxy server, follow the guidelines that are specific to your server. Configuration guidelines for Apache HTTP Server, IIS, Nginx, and Pound are provided below.
Apache HTTP Server Configuration
To use an Apache HTTP Server as a reverse proxy, you need to run an a2enmod script and add directives to a .conf file on your server.
To set up an Apache HTTP Server as a reverse proxy:
- Use the following
a2enmodscript to enableproxy_http,rewrite modules(and optionallyheadersif you want to use SSL):$ a2enmod headers $ a2enmod rewrite $ a2enmod proxy_http - Add the following directives to the
VirtualHostsection of a relevant.conffile:DefaultType none RewriteEngine on AllowEncodedSlashes on RewriteCond %{QUERY_STRING} transport=polling RewriteRule /(.*)$ http://127.0.0.1:1111/$1 [P] ProxyRequests off ProxyPass / http://127.0.0.1:1111/ ProxyPassReverse / http://127.0.0.1:1111/Replace
1111with the actual port number that your Hub server listens to. - To use SSL, add the following directives to the
VirtualHostsection:RequestHeader set X-Forwarded-Proto "https"
IIS Server Configuration
To use an IIS server as a reverse proxy, you need to use the Application Request Routing (ARR) extension.
To set up an IIS server as a reverse proxy:
- Download and install the Application Request Routing (ARR) extension from the Microsoft website.
- In IIS Manager, connect to the IIS server - in this case,
localhost. - Highlight the server in the Connections pane.
- Double-click URL Rewrite.
- Click View server variables in the right pane.
- Add the following server variables to the list:
HTTP_X_FORWARDED_HOST HTTP_X_FORWARDED_SCHEMA HTTP_X_FORWARDED_PROTO - Highlight the server in the Connections pane.
- Double-click Application Request Routing Cache.
- Click Server Proxy Settings under the Proxy heading in the Actions pane.
- Select the Enable proxy checkbox.
- Deselect the Reverse rewrite host in response headers checkbox, then click Apply.
- In the Connections pane, under Sites, select Default Web Site.
- Double-click the URL Rewrite feature, then click Add Rule(s) in the Actions pane.
- Add a reverse proxy rule with the server name:
localhost:1111(replace with the real location and port of your Hub service). - Open the rule, check the rewrite URL, and add the following server variables:
- Set the
HTTP_X_FORWARDED_HOSTvariable to{HTTP_HOST}. - Set the
HTTP_X_FORWARDED_SCHEMAvariable tohttps(if the IIS site is configured to use HTTPS, otherwise set the variable tohttp). - Set the
HTTP_X_FORWARDED_PROTOtohttps(if the IIS site is configured to use HTTPS, otherwise set the variable tohttp).
- Set the
- Make sure that anonymous authentication is enabled:
- (Optional) To access Hub over HTTPS, add a new SSL binding to the Default Web Site.
Nginx Server Configuration
Use the following guidelines to configure an Nginx server as a reverse proxy. The Nginx documentation provides a description of the server_name, proxy_set_header, and proxy_pass variables.
The following example shows you how to configure Nginx headers without SSL:
server {
listen 2222;
server_name localhost;
location / {
proxy_set_header X-Forwarded-Host $http_host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
proxy_pass http://hubmachine.domain.local:1111;
}
}Set the following variables to match your Hub configuration:
listen 2222is the port number that you specified in the--base-urlparameter.-
proxy_pass http://hubmachine.domain.local:1111is the path to your Hub server with the port that specified with the-–listen-portcommand.
The following example shows you how to configure Nginx headers with SSL:
server {
listen 443 ssl;
ssl_certificate <path_to_certificate>
ssl_certificate_key <path_to_key>
server_name localhost;
location / {
proxy_set_header X-Forwarded-Host $http_host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
proxy_pass http://hubmachine.domain.local:1111;
}
}If you use a Java KeyStore, you need to convert it to the PKCS12 format to use a Nginx server as an SSL-terminating proxy. The following procedure shows you how to convert the keystore using keytool and openssl.
To convert a Java KeyStore to PKCS12 format:
- Use keytool to convert your current
.jksfile to the PKCS12 key store format.p12:keytool -importkeystore -srckeystore oldkeystore.jks -destkeystore newkeystore.p12 -deststoretype PKCS12 Enter destination keystore password: [enter private key password from oldkeystore.jks, it will be password for newkeystore.p12] Re-enter new password: [same as above] Enter source keystore password: [enter password for oldkeystore.jks] ... Enter key password for <key alias name> [enter private key password from oldkeystore.jks] ...You will be required to enter a "destination keystore password". If your
.jkskeystore contains a private key with a password, then the "destination keystore password" should equal the password of the private key. - List the contents of the new key store file:
keytool -deststoretype PKCS12 -keystore newkeystore.p12 -list Enter keystore password: [enter password for newkeystore.p12 provided on step 1] ... - Extract the .pem file (certificate) from the
.p12key store:openssl pkcs12 -nokeys -in newkeystore.p12 -out certfile.pem Enter Import Password: [enter password for newkeystore.p12 provided on step 1] ... - Extract the unencrypted key file from the
.p12key store:openssl pkcs12 -nocerts -nodes -in newkeystore.p12 -out keyfile.key Enter Import Password: [enter password for newkeystore.p12 provided on step 1] ...
Pound Reverse Proxy Configuration
The following example shows you how to configure a Pound reverse proxy with SSL. This configuration is set in the /etc/pound/pound.cfg file.
## global options:
User "www-data"
Group "www-data"
## Logging: (goes to syslog by default)
LogLevel 1
## check backend every X secs:
Alive 30
# poundctl control socket
Control "/var/run/pound/poundctl.socket"
## forward all requests from HTTPS 0.0.0.0:8443 to HTTP hubmachine.domain.local:8080:
ListenHTTPS
Address 0.0.0.0
Port 8443
Cert "/home/user/cert.pem"
AddHeader "X-Forwarded-Proto: https"
## allow PUT and DELETE
xHTTP 1
Service
BackEnd
Address hubmachine.domain.local
Port 8080
End
End
End