KB-1698 How to modify existing ports in an self-managed Appian installation

Purpose

Starting from Appian 17.3, Appian has default ports configured based on the Port Usage documentation. These default ports can be modified in an self-managed Appian installation.

Instructions

Follow the steps provided below to modify default ports in an self-managed Appian installation:

Default Configuration

All the default ports for the components mentioned above apart from the Service Manager port can be modified from the appian-topology.xml file.

<topology port="5000">
  <search-cluster port="<NEW_SEARCH_SERVER_PORT>">
    <search-server/>
  </search-cluster>
  <kafkaCluster>
    <broker host="localhost" port="<NEW_KAFKA_PORT>"/>
  </kafkaCluster>
  <zookeeperCluster>
    <zookeeper host="localhost" port="<NEW_ZOOKEEPER_PORT>"/>
  </zookeeperCluster>
  <data-server-cluster>
    <data-server host="localhost" port="<NEW_DATA_SERVER_PORT>" rts-count="1"/>
  </data-server-cluster>
</topology>

Service Manager

The default port for the Service Manager can be modified by specifying the following property in the custom.properties file.

serviceManager.topology.adminPort=<NEW_SERVICE_MANAGER_PORT>

After making these changes, restart the environment to propagate the changes.

Note:

1. Make sure that none of the new ports are the default ports of other components.
2. Data Server port configuration is only available from Appian running 18.1 or later.
3. If the environment is a distributed installation or running on a highly available configuration, ensure the appian-topology.xml file is the same on all servers.

Affected Versions

This article applies to Appian 17.3 and later.

Last Reviewed: September 2018