Configuring Iris to Use a Proxy Server

Note: If your computer is not behind a proxy server, you can skip this section and move to the next section: Launching Volt MX Iris

When your system is a part of an internal network and connects to the Internet using a proxy server, you need to modify the Iris configuration settings to bypass the proxy server and access the Internet.

You can use one of the following methods to configure Iris to use a proxy server:

Basic Proxy: Provides steps to configure your basic proxy settings to allow Volt MX Iris access the Internet.
NTLM Proxy: Provides steps to configure your NTLM proxy settings to allow Volt MX Iris access the Internet.
Custom NTLM Proxy: Provides steps to customize and configure your NTLM proxy settings to allow Volt MX Iris access the Internet.

Basic Proxy

To configure Iris to use a Basic proxy, follow these steps:

Navigate to the VoltMX Iris installation folder > Config folder (ex. /Applications/VoltMXIris/Config).
Open the proxy_config.js file.

Edit the following details. between the comments : "USER EDITIABLE SECTION START" and "USER EDITIABLE SECTION END":

//To enable proxy, change the following value to true.

    var ENABLE_PROXY = false; 

//Type Proxy IP address.

    var PROXY_IP = 'XXX.XXX.XXX.XXX'; 

//Provide null value.

    var NTLM_DOMAIN = 'abc.com'; 

//Provide Basic server port number.

    var PROXY_PORT = 8080; 

//Provide your Username.

    var PROXY_USER = 'username'; 

//Provide your password.

    var PROXY_PWD = 'password';

    var PROXY_TYPE = PTYPE.BASIC_PROXY;

Note: For proxy related information, check with your network administrator.

Save the proxy_config.js file.

NTLM Proxy

To configure Iris to use an NTLM proxy, follow these steps:

Navigate to the VoltMX Iris installation folder > Config folder (ex. /Applications/VoltMXIris/Config).
Open the proxy_config.js file.

Edit the following details between the USER EDITABLE SECTION START and USER EDITABLE SECTION END.

//USER EDITABLE SECTION START

 /

In case of NTLM custom config only PROXY_TYPE and CNTLM_PORT ProxyConfig paramaters 
are required. Rest can be left undefined.

Custom CNTLM config can also be generated by using cntlmconf.sh on mac

 e.g.

./cntlmconf.sh -u NTLMUSER -d DOMAIN -s PROXY-IP:PROXY-PORT

/

//To enable proxy, change the following value to true.

var ENABLE_PROXY = false; 

//Type Proxy IP address.

var PROXY_IP = 'XXX.XXX.XXX.XXX'; 

//Type NTLM Domain name.

var NTLM_DOMAIN = 'XXXXXXX.com'; 

//Type NTLM server port number.

var PROXY_PORT = 8080; 

//Type your Username. Note: If your user name is user@domain.com, then enter the username as useronly. Domain name is not required. 

var PROXY_USER = 'XXXXXX'; 

//Type your password.

var PROXY_PWD = 'XXXXXX';

var PROXY_TYPE = PTYPE.NTLM_PROXY;
//USER EDITABLE SECTION END

Save the proxy_config.js file.

Custom NTLM Proxy

To configure Iris to use a custom NTLM proxy, follow these steps:

Navigate to the VoltMX Iris installation folder > Config folder (ex. C:\Program Files\VoltMXIris\config).
Open the proxy_config.js file.

Edit the following details between the USER EDITABLE SECTION START and USER EDITABLE SECTION END.

//USER EDITABLE SECTION START

 /

In case of NTLM custom config only PROXY_TYPE and CNTLM_PORT ProxyConfig paramaters are 
required. Rest can be left undefined.

Custom CNTLM config can also be generated by using cntlmconf.sh on mac

 e.g.

./cntlmconf.sh -u NTLMUSER -d DOMAIN -s PROXY-IP:PROXY-PORT

/

//To enable proxy, change the following value to true.

var ENABLE_PROXY = false; 

//Type Proxy IP address.

var PROXY_IP = 'XXX.XXX.XXX.XXX'; 

//Type NTLM Domain name.

var NTLM_DOMAIN = 'XXXXXXX.com'; 

//Type NTLM server port number.

var PROXY_PORT = 8080; 

//Type your Username. Note: If your user name is user@domain.com, then enter the username as useronly. Domain name is not required. 

var PROXY_USER = 'XXXXXX'; 

//Type your password.

var PROXY_PWD = 'XXXXXX';
//If the type of proxy used is basic, replace NTLM_PROXY with BASIC_PROXY.

var PROXY_TYPE = PTYPE.NTLM_PROXY;

//Change the value to false

var GENERATE_NTLM_CONF = false;

//USER EDITABLE SECTION END

Save and close the proxy_config.js file.
Navigate to the VoltMX Iris installation folder > nw folder> nw-win folder (ex. C:\Program Files\VoltMXIris\nw\nw_win).

Note: For some NTLM v1 and v2 configurations, the default generated cntlm.ini file may not work. In such cases, you need to customize your proxy settings.
Open the cntlm.ini file.

Modify the following parameters:

//Type user name

    Username    my_proxy_user;

    //Type Domain name

    Domain my_proxy_domain.com;

    //Type the Proxy address:portnumber

    Proxy my_proxy_server:8080;

Save and close the cntlm.ini file.
To generate the profile, follow these steps:
1. Open a Command Prompt window in the current folder.
2. Execute cntlm.exe -c cntlm.ini -I -M http://xxxx.com.
3. Type your NTLM password, if requested, to generate a profile.
4. Copy the generated profile.
Reopen the cntlm.ini file.

Append the profile details (copied from step 9). A portion of the cntlm.ini file after appending the parameters is shown:

Username    my_proxy_user

      Domain      my_proxy_domain.com

      Proxy       my_proxy_server:8080

      NoProxy     localhost, 127.0.0., 10., 192.168.*

      Gateway     no

      Listen      3128

      Auth            NTLMv2

      PassNTLMv2      XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Save the cntlm.ini file.
Move the cntlm.ini file to User Profile folder/user name/VoltMXIris/irisdata (for example, /Users/<User name>/VoltMXIris/irisdata).