Summary: How to change the port on which the internal services are configured to run when using a traditional Microsoft Windows installation (not involving Docker).

Introduction

Note that you should always check that the new port you intend to use is not ALREADY being used by some other service.
See also the following documentation if you wish to reconfigure the front-end service (port 80) to run on port 443 or another custom port:
- Reconfiguring the front end imaging-fe Windows service to use an alternative unsecure port
- Reconfiguring the front end service to use a secure port

CAST Imaging has several internal services that are preconfigured to run on specific ports as detailed below:

Windows Service name	Docker container name	Description	Default Listening Port	Notes
CAST Imaging System - imaging-ETL	etl	CAST Imaging application management service.	9001	-
CAST Imaging System - Frontend service	nginx	CAST Imaging front-end web service.	80 (≤ 2.0.0-beta5) 8083 (≥ 2.0.0-beta6) For ≥ 2.0.0-beta6, if port 8083 is not free, the next available port will be used.	From 2.1.0-funcrel this image is no longer pushed. Merged into "server".
CAST Imaging System - imaging-service	server	CAST Imaging back-end web service.	9000	-
CAST Imaging System - login service	login	CAST Imaging login and authentication service.	8084	From 2.1.0-funcrel this image is no longer pushed. Merged into "server".
CAST Imaging System - sourcecode service	sourcecode	CAST Imaging sourcecode service.	9980	From 2.1.0-funcrel this image is no longer pushed. Merged into "server".
CAST Imaging System - Neo4j Graph Database	neo4j	Neo4j Graph Database instance.	6362, 7473, 7474, 7687	-

The port numbers for the majority of these services (except the Neo4j Graph Database service) can be changed if you have other services already running on these ports - the process is described below.

Microsoft Windows via traditional installer

Note that the files described below are located in the protected %PROGRAMFILES% location, therefore you must open the files with elevated permission (this is usually achieved by right clicking your text editor in the Windows start menu and selecting Run as administrator):

Microsoft Windows

CAST Imaging System - imaging-ETL

This service runs on port 9001. To change this port to something else, replace all instances of 9001 with your custom port number in the following files:

%APPDATA%\CAST\ImagingSystem\imagingservice\imagingetl.json ≥ 2.17
%APPDATA%\CAST\ImagingSystem\imagingservice\imagingetl.bat ≤ 2.16
%APPDATA%\CAST\ImagingSystem\login\application.properties

Save the files and ensure that you restart the CAST Imaging System - imaging-ETL Windows service.

CAST Imaging System - imaging-service

This service runs on port 9000. To change this port to something else, replace all instances of 9000 with your custom port number in the following files:

%APPDATA%\CAST\ImagingSystem\imagingservice\imagingservice.json ≥ 2.17
%APPDATA%\CAST\ImagingSystem\imagingservice\imagingservice.bat ≤ 2.16
%APPDATA%\CAST\ImagingSystem\nginx\nginx.conf
%APPDATA%\CAST\ImagingSystem\login\application.properties
%PROGRAMFILES%\CAST\ImagingSystem\imagingservice\create-admin-user.bat

Save the files and ensure that you restart the CAST Imaging System - imaging-service Windows service.

CAST Imaging System - sourcecode service

This service runs on port 9980. To change this port to something else, replace all instances of 9980 with your custom port number in the following files:

%APPDATA%\CAST\ImagingSystem\sourcecode\application.properties
%APPDATA%\CAST\ImagingSystem\login\application.properties

Save the files and ensure that you restart the CAST Imaging System - sourcecode service Windows service.

CAST Imaging System - login service

This service runs on port 8084. To change this port to something else, replace all instances of 8084 with your custom port number in the following files:

%APPDATA%\CAST\ImagingSystem\login\application.properties
%APPDATA%\CAST\ImagingSystem\nginx\nginx.conf

Save the files and ensure that you restart the CAST Imaging System - login service Windows service.

Next, if you are using ≥ 2.8.1-funcrel you will need to modify the following file:

%APPDATA%\CAST\ImagingSystem\imagingservice\imagingetl.json ≥ 2.17
%APPDATA%\CAST\ImagingSystem\imagingservice\imagingetl.bat ≤ 2.16

In this file, find the line containing HTTP_ENDPOINT and change the port 8084 to the custom port you are using.

-HTTP_ENDPOINT="http://localhost:8084"

Save the file and ensure that you restart the CAST Imaging System - imaging-ETL Windows service in order for the new configuration to be taken into account.

Docker for Windows/Linux

You can modify the ports used by the etl (9001), server (9000), login (8084) and sourcecode (9980) containers. Edit the following file:

Docker Installer extension (located in the folder created when unzipping the extension):
.env

For example, to change the default etl port from 9001 to 9002, change the port number on the ETL_PORT line:

SERVER_PORT=9000
ETL_PORT=9002
LOGIN_PORT=8084
SOURCECODE_PORT=9980

Save the file and ensure that you stop and then start CAST Imaging using the following commands (issuing a restart will not cause the port number change to be taken into account):

---Stop CAST Imaging:
 
Docker Installer extension (ensure you run the commands from the folder created when unzipping the extension):
Linux: ./imaging -s stop
Microsoft Windows: imaging.exe -s stop
 
---Start CAST Imaging:
 
Docker Installer extension (ensure you run the commands from the folder created when unzipping the extension):
Linux: ./imaging -s start
Microsoft Windows: imaging.exe -s start

Next, if you are using ≥ 2.8.1-funcrel and you have changed the LOGIN_PORT to use a custom port (i.e. not 8084), you will need to modify the following file located in the folder created when unzipping the extension:

etl/app.config

In this file, find the line containing HTTP_ENDPOINT and change the port 8084 to the custom port you are using.

-HTTP_ENDPOINT="http://localhost:8084"