Configuring AIP Console and AIP Nodes to use a proxy

Created by James Hurrell on Nov 21, 2022

Summary: this page describes how to configure Console and Nodes to use a proxy server if your organization requires this.

This information is valid only for Console ≤ 1.14.x. If you are using ≥ 1.15.x, proxy settings are provided in Complete start-up wizard - v. 1.x, Complete start-up wizard - v. 2.x and the Administration Center.

Introduction

If your organization requires internet connections to pass through a proxy server, then you will need to configure Console and Node to use this proxy server. At the current time, it is not possible to configure the Console and Node Windows Services to use a proxy, instead you must launch Console and your Nodes with the .bat/.sh files provided during the installation process.

Configuration instructions are listed below.

Step 1 - Modify .bat / .sh files

runAIPConsole.bat (Console installed on Microsoft Windows)

Edit the following file with a text editor:

<installation_folder>\AipConsole\tools\runAIPConsole.bat

Locate the following line:

start "AIP Console" /D "%CONSOLE_FOLDER%" java -jar -Xmx1024m -Xms256m "bin/aip-console-app.jar" --spring.config.location="data/aipConsole.properties"

Modify as follows by adding -Dhttps.proxyHost and -Dhttps.proxyPort options configured with your proxy host name/IP address and port number - please use the exact order of values specified below:

start "AIP Console" /D "%CONSOLE_FOLDER%" java -jar -Xmx1024m -Xms256m -Dhttps.proxyHost=<proxy_hostname_or_IP_address> -Dhttps.proxyPort=<proxy_port> "bin/aip-console-app.jar" --spring.config.location="data/aipConsole.properties"

Save the file.

runAIPConsole.sh (Console installed on Linux)

Edit the following file with a text editor:

<installation_folder>\AipConsole\tools\runAIPConsole.sh

Locate the following line:

JAVA_OPTS="-Xmx1024m -Xms256m"

Modify as follows by adding -Dhttps.proxyHost and -Dhttps.proxyPort options configured with your proxy host name/IP address and port number - please use the exact order of values specified below:

JAVA_OPTS="-Xmx1024m -Xms256m -Dhttps.proxyHost=<proxy_hostname_or_IP_address> -Dhttps.proxyPort=<proxy_port>"

Save the file.

runAIPNode.bat (available on all Nodes)

Edit the following file with a text editor - you will need to do this on ALL Nodes managed with Console:

<installation_folder>\AipNode\tools\runAIPNode.bat

Locate the following line:

java -jar -Xmx1024m -Xms256m "bin/aip-node-app.jar" --spring.config.location="data/aip-node-app.properties"

Modify as follows by adding -Dhttps.proxyHost and -Dhttps.proxyPort options configured with your proxy host name/IP address and port number - please use the exact order of values specified below:

java -jar -Xmx1024m -Xms256m -Dhttps.proxyHost=<proxy_hostname_or_IP_address> -Dhttps.proxyPort=<proxy_port> "bin/aip-node-app.jar" --spring.config.location="data/aip-node-app.properties"

Save the file.

Step 2 - Stop / disable running services

Ensure that Console and your Nodes are stopped (whether running through a Windows Service, or through a batch/sh file).

If Console and your Nodes are running via a Windows Service, please ensure that these services are disabled to prevent them from running at startup:

Step 3 - Run modified .bat / .sh files to start Console / Nodes

Finally restart Console and your Nodes using the modified .bat or .sh files.