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.

•	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).

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.

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.

Note: These changes will only become active after LISTSERV Maestro has been restarted, i.e. after you have performed all the steps described below, restart LISTSERV Maestro. (Except in those cases where it is explicitly noted that you need to perform the configuration step after the restart, not before.)

•	If you change the HTTP port on a server where it affects the Maestro User Interface component, then you also have to change the LUI Access URL for Users setting in the Administration Hub to reflect this port change.

This may affect the Default LUI Access URL for Users under Global Settings > Maestro User Interface > Default URL Settings and/or the individual LUI Access URL for Users setting on group or user level.

You may also have to change the LUI Access URL for Admin setting (on default level) and/or the Subscriber Access URL setting (on group or user level), if these settings do not inherit the LUI Access URL for Users setting.

•

If any LISTSERV Web Interface Links have been defined for the Maestro User Interface (in the Administration Hub), then these must be refreshed so that they are aware of the new HTTP port: In the Administration Hub, select Global Settings > Maestro User Interface > LISTSERV Web Interface Access > LISTSERV Web Interface Links. If you have any entries in the table, then you need to refresh each entry as follows (do this after applying all the other steps described here and after you have restarted LISTSERV Maestro):

Click the Edit link of the entry. On the next page, take note of the host name that is currently selected in the drop-down list at the top, then copy the access URL from the edit box at the bottom (for later paste). Then, click the [Delete Link] button. This deletes the old interface link and you are now back on the previous page. Now, click the [Create New Link] button. On the next page, select the same server as was used before from the drop-down list at then top, then paste the access-URL that you copied before into the edit box at the bottom. Click [OK] to re-create the link. You have deleted the old interface link and replaced it with an equivalent new one that is now aware of the new HTTP port used by LISTSERV Maestro.

Important: If the LISTSERV Web Interface (WA) is also being hosted by LISTSERV Maestro’s Tomcat, then the HTTP port change will also affect the WA, which means that also the access URL which you copied and pasted above needs to be changed (to reflect the new HTTP port). In this case, before you click “OK”, first edit the pasted access URL so that it contains the new HTTP port (this is not necessary if the WA is being hosted on a different server).

•	If you change the HTTP port on the server that affects the Maestro Tracker component, then you also have to change the Tracking URL setting in the Administration Hub to reflect this port change.

This may affect the Default Tracking URL setting under Global Settings > Maestro User Interface > Default URL Settings and/or the individual Tracking URL setting on group or user level.

•	If you change the HTTP port on a server where it affects the Administration Hub component, then you also have to change the HUB Access URL for Users setting in the Administration Hub to reflect this port change.

This may affect the Default HUB Access URL for Users setting under Global Settings > Maestro User Interface > Default URL Settings and/or the individual HUB Access URL for Users setting on group or user level.

You may also have to change the HUB Access URL for Admin setting (on default level), if it does not inherit the HUB Access URL for Users setting.

•

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.

Important: 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.

Note: If you change any of the access URLs in the HUB as described above (to allow for a non-standard port), and you make a mistake so that now the wrong access URL is submitted, then this may have the effect that users may no longer be able to login to LUI. This may even affect the admin login to LUI and HUB, in which case the admin can not even login normally to correct the mistake. See Section 31 Emergency Admin HUB Access for how to login in to the HUB anyway in such a case, to be able to correct the mistake.

Note: If you have several LISTSERV Maestro components installed on the same server, then all of them will be affected by this change. This means that it is not possible to use different HTTPS ports for each of the components, if the components are installed on the same server. However, if the components are installed on different servers, then they can use different HTTPS ports.

When changing the HTTPS port, you need to be aware of the same issues (for example adjusting certain HUB settings), as when changing the HTTP port. Please see Section 14.2.1 Configuring the HTTP Port about what those issues are (only applied to HTTPS instead of HTTP).

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.

[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.

[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).

[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.

[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

[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.

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 on the Global Settings menu, select Maestro Tracker, and then select General Administration. Edit the port number. Click [OK] to save. The change will be effective immediately.

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:

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:

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.