Section 14 Using Non-Standard Ports

The components of LISTSERV Maestro use a number of ports to communicate with each other and with the external world. The ports used are standard ports and will work well under most circumstances. Under certain conditions, it may be desirable to change one or several of the ports to other ports for example, if another application installed on the same server already uses one of the ports LISTSERV Maestro is set to use. Changing ports may require editing certain INI files. For more information on editing LISTSERV Maestro INI files, see Section 20 Editing LISTSERV Maestro INI Files.

14.1 Ports Used by LISTSERV Maestro

This list contains the individual ports used (by default) by each of the LISTSERV Maestro components.

14.1.1 Ports Used by the Administration Hub

The Administration Hub uses three different ports:

         For HTTP access to the Administration Hub user interface (using a web browser), the Administration Hub uses the standard HTTP port 80 (or 443 for HTTPS).

         For internal communication with the other components, the Administration Hub uses port 1099.

         For shutdown of the application server, the Administration Hub uses port 8007.

14.1.2 Ports Used by the Maestro User Interface

The Maestro User Interface uses four different ports:

         For HTTP access to the Maestro User Interface (using a web browser), the Maestro User Interface uses the standard HTTP port 80 (or 443 for HTTPS).

         For internal communication with the Administration Hub, the Maestro User Interface uses port 1099.

         For the internal database connection, the Maestro User Interface uses port 3306.

         For shutdown of the application server, the Maestro User Interface uses port 8007.

14.1.3 Ports Used by Maestro Tracker

Maestro Tracker uses four different ports:

         To collect the tracking events from mailings sent with the Maestro User Interface, Maestro Tracker uses the standard HTTP port 80 (you cannot use HTTPS for Tracker).

         For internal communication with the Administration Hub, the Maestro User Interface uses port 1099.

         To transfer the tracking events to the Maestro User Interface, Maestro Tracker, uses port 7000.

         For shutdown of the application server, Maestro Tracker uses port 8007.

14.2 Configuring Port Usage

If any of the ports described in the previous sections are already in use on the server where the LISTSERV Maestro component is installed, it is possible to change the use of this port. Note that some components make use of the same port as other components. This is not a problem between the different components of LISTSERV Maestro. If there are several components on the same server, then the components share usage of these ports (port 80 for HTTP access and port 1099 for internal communication, for example). It is not necessary or even possible to configure one component to use a different port than the other while the components are on the same server.

14.2.1 Configuring the HTTP Port

To configure the HTTP port, edit the Port entry in the Tomcat INI file:

[maestro_install_folder]/conf/tomcat.ini

Example: Port=8080

If you do not configure the Port entry, then the default port (80 for HTTP or 443 for HTTPS) will be used.

If there are several LISTSERV Maestro components installed on the same server, then they will all be affected by this change. It is not possible to use different HTTP ports for each of the components if the components are installed on the same server. However, if the components are installed on different servers, they can use different HTTP ports. These changes will only be effective after a restart of the component in question.

When changing the HTTP port, there are a few issues of which to be aware:

  If the HTTP port is changed on a server that houses the Maestro User Interface component, then it is also necessary to change the External Host Name setting for Hosted Datasets and Hosted Lists in the Administration Hub. Do so by editing the Hosted Data Settings on either the global component level or the group or single user level. See Section 7 Settings for the Maestro User Interface.

         If the HTTP port is changed on a server that houses the Maestro User Interface component, then it is also necessary to make some changes to the INI file of the Maestro User Interface component. On the server with the Maestro User Interface installed, locate the lui.ini file:

     [maestro_install_folder]/lui/lui.ini

Edit or add the entry ExternalHTTPPort. (If the entry is not defined, it defaults to port 80 if HTTP is used and port 443 if HTTPS is used.) See Section 20 Editing LISTSERV Maestro INI Files.

  If the HTTP port is changed on the server that houses the Maestro Tracker component, then it is also necessary to change the Tracking URL HTTP Port settings in the Administration Hub by editing the Global Component Settings and any group or single user level settings that are defined. See Section 7 Settings for the Maestro User Interface.

         If the HTTP port is changed on the server that houses the Administration Hub component, then it is necessary to edit the Maestro User Interface INI file. On the server where the Maestro User Interface component is installed, locate the lui.ini file:  [maestro_install_folder]/lui/lui.ini

Edit or add the entry HubExternalHTTPPort. (If the entry is not defined, it defaults to port 80 if HTTP is used and port 443 if HTTPS is used.) See Section 20 Editing LISTSERV Maestro INI Files.

         The Maestro User Interface and the Administration Hub User Interface are both accessed using an HTTP port. This implies that if this port is changed, it will no longer be possible to access these interfaces by entering the default URL into the location field of a browser. Instead, it is necessary to add the port number (with a colon :) to the URL. For example, if the HTTP port is changed to 8080, then the access URL will need to include the port number as shown below:

http://your_host:8080/lui

         The shortcuts to access the Maestro User Interface and the Administration Hub User Interface that are installed in the Windows start menu do not include any port information. They expect the user interfaces to be accessible on the standard port 80. If this port is changed, then it is necessary to edit these shortcuts and add :yourPort to the URL, as described above.

         Changing the HTTP port also affects the CompileAll command (this command is a tool to pre-compile all pages before first use see the Installation Manual for details). Usually this command is only executed once, right after installation. However, if CompileAll needs to be run again (for example after an upgrade installation), and the HTTP access port has been changed for the LISTSERV Maestro installation, the following files must be edited:

[maestro_install_folder]/commands/compile/hub.host

[maestro_install_folder]/commands/compile/lui.host

         The hub.host file is located on the server where the Administration Hub component is installed, while the lui.host file is located on the server where the Maestro User Interface component is installed. If both components are on the same server, then the two files will be as well.

         The file can be edited with any text editor. It contains a single line, comprised of the access-URL (including host-name and port) for the Administration Hub and the Maestro User Interface component, respectively. Change it so that it contains the new HTTP port with a colon : after the host name (or leave out port and colon if the port is the standard port 80). For example, if the HTTP port was changed to 8888, then the Maestro User Interface entry must look like this:

http://yourhost.domain.etc:8888/lui

The entry for the Administration Hub will look similar, only with /hub at the end. 

If the port is changed back to the standard 80, then either include :80 instead of the :8888 shown above, or just leave out the port and the colon.

http://yourhost.domain.etc/lui

         If LISTSERV Maestro is installed behind a firewall (which is advisable) and the Maestro User Interface and/or the Administration Hub User Interface needs to be accessible from a computer outside the firewall, the firewall must be configured to allow access on the configured port instead of the standard HTTP port.

         Similarly, if the Maestro Tracker component is installed behind a firewall, then the firewall must be configured to give all outside users access to the server where Maestro Tracker is installed on the port that is configured for HTTP access. This is normally port 80, but can be a different port if the port was changed as described above.

         The whole tracking mechanism of LISTSERV Maestro will not work if the Maestro Tracker component is installed behind a firewall in a way such that outside clients do not have access to its configured HTTP port.

Important: Maestro Tracker will work most effectively if it uses port 80. Many sites have firewalls that prevent their users from connecting to other ports for HTTP connections, which would not only prevent them from being tracked, but from reaching the actual Web pages whose access is being tracked.

14.2.2 Configuring the Internal Communication Port

This port can be configured independently for each component. However, if the components are installed on the same server, then they must all use the same internal communications port.

         To configure the communication port for the Administration Hub component, edit the following file:

[maestro_install_folder]/hub/hub.ini

Edit or add the entry RMIPort. If the entry is not present or is commented out, the component defaults to port 1099. For example: RMIPort=5310

In addition, it is necessary to edit the INI-file of each component that works together with this Administration Hub component. This is usually one Maestro User Interface and one Maestro Tracker component.

         For the Maestro User Interface component, edit the file:

[maestro_install_folder]/lui/lui.ini

Edit the entry HubRMIPort (if this entry is not present or is commented out, it defaults to port 1099).

         For the Maestro Tracker component, edit the file:

[maestro_install_folder]/trk/tracker.ini

Similarly, in this example, edit the entry HubRMIPort in the same way as described above for the Maestro User Interface component.

         To configure the communication port for the Maestro User Interface, edit the following file:

[maestro_install_folder]/lui/lui.ini

Edit or add the entry RMIPort. If the entry is not present or is commented out, the component defaults to port 1099. Example: RMIPort=5310

         To configure the communication port for Maestro Tracker, edit the following file:

[maestro_install_folder]/trk/tracker.ini

Edit or add the entry RMIPort. If the entry is not present or is commented out, the component defaults to port 1099. Example: RMIPort=5310

         In addition, edit the Maestro User Interface INI file that communicates with the Maestro Tracker component. On the server where the Maestro User Interface is installed, edit the file:

[maestro_install_folder]/lui/lui.ini

Edit or add the entry TrackerRMIPort.

14.2.3 Configuring the Tracker Communications Port

This port is only used by the Maestro User Interface (LUI) to communicate with Maestro Tracker component (TRK). It can easily be configured using the Administration Hub. Simply enter the Administration Hub, click the Global Component Settings icon, and then Maestro Tracker. Edit the port number. Click [OK] to save. The change will be effective immediately.

14.2.4 Configuring the Internal Database Connection Port

LISTSERV Maestro comes with an internal database that can be used as the system database. The Internal Database Connection port is only used by the Maestro User Interface component when it is configured to use this internal database. To configure it, edit the following file:

[maestro_install_folder]/lui/database/my.ini

In this file, find the entry port both in the [client] and [mysqld] sections. Edit the value of both of these entries to change the database connection port. In addition, edit the following file:

[maestro_install_folder]/lui/lui.ini

Edit the MySQLConnectorJDriverPlugin.databasePort entry or the MySQLDriverPlugin.databasePort entry (whichever is present) to point to the same port number. These changes will only be effective after restarting the Maestro User Interface component.

14.2.5 Configuring the Application Server Shutdown Port

To configure the Server Shutdown port, you need to edit the ShutdownPort entry in the Tomcat INI file:

[maestro_install_folder]/conf/tomcat.ini

Example: ShutdownPort=90

If this entry is not configured, then the default port 8007 will be used.