HTTP Proxy Support with Authentication

The TIBCO Cloud™ API Management - Local Edition installer can be run from behind an HTTP proxy server with authentication.

The example uses the following sample information:

Parameter Value
HTTP proxy host 10.250.1.40
HTTP proxy user name squiduser
HTTP proxy password squidpwd
API Management - Local Edition installer Docker host 10.250.1.42

To run the Local Edition installer from behind an HTTP proxy with authentication, an administrator must set up the HTTP proxy in the Docker host, as well as in the Local Edition installer, as follows:

Set up an HTTP Proxy in the Docker Host

This involves setting up the HTTP proxy at the operating system level, as well as in the Docker service.

  • HTTP proxy settings on operating system level - On Linux, set up the HTTP proxy in the /etc/environment file. The following is an example:
    http_proxy="http://squiduser:squidpwd@10.250.1.40:3128"
    https_proxy="http://squiduser:squidpwd@10.250.1.40:3128"
    no_proxy="127.0.0.1, localhost"
  • HTTP proxy settings for the Docker service - This varies from one Linux distribution to another. The following are HTTP proxy settings for a Docker Service on CentOS 7:
    1. Create folder /etc/systemd/system/docker.service.d.
    2. Create an http-proxy.conf file in the folder created in step 1 and add the following content:
      [Service]
      Environment="HTTP_PROXY=http://squiduser:squidpwd@10.250.1.40:3128/" "NO_PROXY=localhost,127.0.0.1,10.250.1.*"
    3. Restart the Docker service.

Set up an HTTP Proxy in the Local Edition Installer

After the Local Edition installer distribution package is extracted, set up the HTTP proxy settings in the tml-installer.env file. The following is an example:

TERM=xterm
# HOST_IP is the IP of docker host, loopback address does not work
HOST_IP=10.250.1.42
 
# http proxy, i.e. http://10.250.1.40:3128
http_proxy=http://squiduser:squidpwd@10.250.1.40:3128

# https proxy, it is usually the same as HTTP_PROXY
https_proxy=http://squiduser:squidpwd@10.250.1.40:3128

# no proxy, i.e. 127.0.0.1, localhost
no_proxy=127.0.0.1, localhost

Once you set up an HTTP proxy in the installer, you must start the installer. To completely add an HTTP Proxy Authentication support, follow the steps specified in Setting up HTTP Proxy Authentication in Installer Jenkins.