You are currently reviewing an older revision of this page.

How to modify existing ports on your on-premise Appian installation

Purpose

Starting from Appian 17.3, Appian has default ports configured to your setup based on the Port Usage documentation. These default ports can be modified on an on-premise Appian installation.

Instructions

Follow the steps provided below to modify default ports on your on-premise Appian installation:

Default Configuration

Component Default Port
Service Manager 7070
Zookeeper 2181, 2888, 3888
Kafka 9092
Search Server 9300
Data Server 5400-5405

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>

Once you have modified the default ports, please restart your on-premise Appian environment for the changes to take effect.

Note:

  1. Please 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 you have a Distributed Installation or a High-Availability Setup, please make sure you have the same appian-topology.xml file across all your servers.

Affected Versions

This article applies to all versions of Appian running 17.3 or later.

Last Reviewed: September 2018