How to check your Port numbers are not conflicting

Background

From time to time, partners may experience a failure to launch the dashboard (Error Occurred), or it will launch but cannot be accessed (Oops something went wrong) or it could be that certain pieces of functionality do not complete their tasks as you might expect – all can sometimes be caused by a conflict of Port Number configuration.

Configuration

Port numbers are configured on the initial installation, using the Configuration Tool, Docker Compose file or the admin.exe tool. Here is a link to the Installation Guide.

Through the Configuration Tool, a standard local installation will set default ports;

What Can Cause A Conflict?

Should you have multiple versions of the dashboard running at the same time (as shown below), or if you have an existing application using one of the ports the dashboard is trying to use:

Each port must be unique as shown in the example below;

Tomcat (App)	8224	18224	8225	8226	8227
Admin	8005	18005	8006	8007	8008
Repository	9910	19110	9911	9912	9913
AJP Connector	8009	18009	8010	8011	8012
Internal Port	28748	28749	28750	28751	28752
Renderer Port	9915	19915	9919	9923	9927
Excel Reader	9916	19916	9920	9924	9928
Scheduler Port	9917	19917	9921	9925	9929
Analytics Port	9918	19918	9922	9926	9930

How To Check For Any Conflicts

You can check the ports are in use/available using the Command Prompt, use the Run as administrator option

Enter netstat -a -n -o | find “portnumber”

… you can check each of your Port numbers, and you should get a response similar to below if the ports are active and listening.

Within the installation directory “installation location”/Dashboard/Dashboard, open the production.json file – the ports used in the installation are populated in this file.

How can they be resolved?

There are a few different methods to change the port numbers, but the best practice approach is to re-launch the Configuration Tool, and change the port number there, before restarting the services for these to take effect.

Alternative Methods

You can manually adjust the values in the production.json file, and restart the dashboard services.
If you are using Docker Compose files, you can adjust the Port Variables, and restart the services (if it doesn’t restart automatically)
Through the PortSelector Admin.exe tool (for older versions of the dashboard)

It is possible to use non-default port values, however this will also require the System Variables to be updated, you can find more information on this HERE.