Agent Relay Installation Options

When prompted by the installer, specify the options according to the information in the following table. Where Windows and UNIX/Linux options differ, operating system-specific information is included.

Table 1. Agent Relay Configuration table

Installation Option	Description
Please enter the directory where you would like to install the agent relay.	Enter the directory where you want the agent relay installed. If it does not exist, you will be prompted on whether to create it. For example: Windows `C:\Program Files\Serena\agentrelay` Unix/Linux `/opt/Serena/agentrelay`
Please enter your java home.	Enter the directory where Java is installed. Ensure that the `JAVA_HOME` environment variable points to this directory. For example: Windows `C:\Program Files\Serena\common\jre\8.0` Unix/Linux `/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.71-1.b15.el6_7.x86_64/jre` Important: On Windows, JRE 8.0 is required for an agent relay to be installed as a service. On all platforms, to restrict the security protocols, you must use version Java 8.0.
Enter the name of this relay.	Enter the name of the agent relay. Each agent relay must have a unique name. The default name is `agent-relay`.
Enter the IP or hostname which this agent relay should use	Enter the IP address or hostname on which the agent relay will listen for HTTP requests coming from agents.
Enter the port which this agent relay should proxy HTTP requests on	Enter the port on which the agent relay will listen for HTTP requests coming from agents. The default is `20080`. Note: Agent relays can also communicate through HTTPS. To ensure this, you must configure the server to work through HTTPS and change the external agent link to use HTTPS. Agents will then automatically connect through HTTPS. Agent relays will automatically use HTTPS when agents request HTTPS links.
Port which this agent relay should use for communication.	Enter the port on which the agent relay will use for JMS-based communications with remote agents. The default is `7916`.
Connect the agent relay to a central server?	Specify whether you want the agent relay to connect to the Deployment Automation server as follows: Default: If you plan to use this agent relay in agent-initiated communication, or active mode, enter `Y`. See Agent-initiated HTTP Communication Using Agent Relays. If you plan to use this agent relay in server-initiated communication or passive mode, enter `n`. By doing this, you will have the option to select Server-Initiated for the agent relay in the user interface. See Server-initiated HTTP Communication Using Agent Relays. Note: If you aren't sure, take the default (`Y`). If you want to change it later, you can change this in the `agentrelay.properties` file located in the `relay_installation\conf` directory.
Enter the IP or hostname of your central server	If you selected `Y` in the option to connect the agent relay to the server, enter the IP or host name where the agent relay can contact the server.
Enter the port which the central server uses for communication	If you selected `Y` in the option to connect the agent relay to the server, enter the port the server uses to communicate with agents. The default is `7918`.
Use mutual authentication between the agent, relay and server.	If mutual authentication is required, enter `Y`. For more information, see Secure Socket Layer (SSL) Configuration.
Do you want to install the Agent Relay as Windows service?	If you are installing the agent relay on Windows, you can install it as a Windows service. The default value is `N`. If you specify `Y`, see the following table entries.
Enter a unique service name for the Agent Relay. No spaces please.	(Required for running as a Windows service) Enter a unique name for the service. The default is `agentrelay`.
Enter the user account name including domain path to run the service as (for local use '.\.' before login).	(Required for running as a Windows service) Enter an account name, including the domain path under which to run the service. For a local user, insert "`.\`" before the user name. The default is `.\localsystem`
Enter the password for the '.\localsystem' user account.	(Optional for running as a Windows service) Enter a password for the Windows service user account name. The default is no password.
Do you want to start the service automatically?	(Required for running as a Windows service) Specify whether or not (`y\|N`) you want the Windows service to be started automatically. The default is `N`.

Note: If you need to change the agent relay configuration, you can edit these properties in the agentrelay.properties file located in the relay_installation\conf directory. You can also do some agent relay management through the user interface. See Managing Agent Relays.