Installing an Agent

After downloading and expanding the installation package, open the installer_directory.

From the installer_directory run install-agent.bat (Windows) or install-agent.sh (Unix-Linux).

Note

If you install the agent as a Windows service, the user account must have the following privileges:

  • SE_INCREASE_QUOTA_NAME "Adjust memory quotas for a process"

  • SE_ASSIGNPRIMARYTOKEN_NAME "Replace a process level token"

  • SE_INTERACTIVE_LOGON_NAME "Logon locally"

The LOCAL SYSTEM account is on every Windows machine and automatically has these privileges. You might want to use it as it requires minimal configuration.

The uDeploy Installer is displayed and prompts you to provide the following information. Any default values suggested by the program (displayed within brackets) can be accepted by simply pressing Enter. If two options are given, such as Y/n, the capitalized option is the default value.

  1. Enter the directory where agent should be installed.. For example: C:\Program Files\urban-deploy\agent (Windows) or /opt/urban-deploy/agent (Unix). If the directory does not exist, enter Y to instruct the Installer to create it for you. If you enter an existing directory, the program will give you the option to upgrade the agent. For information about upgrading, see the section called “Upgrading uDeploy”.

    Note

    Any default values suggested by the program (displayed within brackets) can be accepted by simply pressing Enter. If two options are given, such as Y/n, the capitalized option is the default value.

  2. Please enter the home directory of the JRE/JDK used to run the agent. If Java has been previously installed, uDeploy will suggest the Java location as the default value. To accept the default value, press ENTER, otherwise override the default value and enter the correct path.

  3. Will the agent connect to a agent relay instead of directly to the server? The default value is N. If the agent will connect to an agent relay, see the section called “Connecting Agents to Agent Relays”.

  4. Enter the host name or address of the server the agent will connect to. The default value is localhost.

  5. Enter the agent communication port for the server. The default value is 7918.

  6. Does the server agent communication use mutual authentication with SSL?. Default value is Y.

    If you use SSL, turn it on for server too or the agent will not be able to connect to the server. This also applies if using mutual authentication. If you change the port numbers for agent communication, you need to provide them when installing the agents.

  7. Enter the name for this Agent. Enter a unique name; the name will be used by uDeploy to identify this agent. Names are limited to 256 characters and cannot be changed once connected.

  8. Do you want to install the Agent as Windows service? (Windows only). The default value is N. When installed as a service, uDeploy only captures the value for the PATH variable. Values captured during installation will always be used, even if you make changes later. For recent Windows versions, you will need to execute the command as Administrator.

Agents that will run on Unix machines can also be installed directly from the uDeploy web application, see the section called “Agents”

Note

If the agent is configured properly, uDeploy will recognize it automatically—you do not need to perform further actions in order to start using it.