L-Soft Sweden AB
Installation Manual for
LISTSERV® Maestro for Mac OS® X
May 2, 2011
This document describes the installation of the Version 4.0 Build 16 release of LISTSERV® Maestro for Mac OS® X with a build date of May 2, 2011.
The information furnished in this document is meant as an introduction to installing and administering a LISTSERV Maestro installation. For further in-depth information that may be helpful before initiating an installation, please see the LISTSERV Maestro Administrator’s Manual (available at http://www.lsoft.com/manuals.html).
Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. L-Soft Sweden AB does not endorse or approve the use of any of the product names or trademarks appearing in this document.
Permission is granted to copy this document, at no charge and in its entirety, provided that the copies are not used for commercial advantage, that the source is cited, and that the present copyright notice is included in all copies so that the recipients of such copies are equally bound to abide by the present conditions. Prior written permission is required for any commercial use of this document, in whole or in part, and for any partial reproduction of the contents of this document exceeding 50 lines of up to 80 characters, or equivalent. The title page, table of contents and index, if any, are not considered part of the document for the purposes of this copyright notice, and can be freely removed if present.
All Rights Reserved Worldwide.
LISTSERV is a registered
trademark licensed to L-Soft international, Inc.
ListPlex, CataList, and EASE are service marks of L-Soft international, Inc.
UNIX is a registered trademark of X/Open Company Limited.
AIX and IBM are registered trademarks of International Business Machines Corporation.
Alpha AXP, Ultrix and VMS are trademarks of Digital Equipment Corporation.
OSF/1 is a registered trademark of Open Software Foundation, Inc.
Microsoft is a registered trademark and Windows, Windows NT, Windows 2000, Windows XP and Windows 95 are trademarks of Microsoft Corporation.
HP is a registered trademark of Hewlett-Packard Company.
Sun is a registered trademark of Sun Microsystems, Inc.
Solaris is a registered trademark of Sun Microsystems, Inc.
Mac and Mac OS are registered trademarks of Apple Computer, Inc.
IRIX is a trademark of Silicon Graphics, Inc.
PMDF is a registered trademark of Innosoft International.
Pentium and Pentium Pro are registered trademarks of Intel Corporation.
All other trademarks, both marked and not marked, are the property of their respective owners.
Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j/
This product includes code licensed from RSA Security, Inc.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
All of L-Soft's manuals are available on the World Wide Web at the following URL: http://www.lsoft.com/manuals.html
L-Soft invites comment on its manuals. Please feel free to
send your comments by
e-mail to: MANUALS@LSOFT.COM
Table of Contents
For a complete installation of LISTSERV Maestro 4.0-16, several components are required that may be installed on one server, or distributed over several servers. The following sub-sections give a quick overview of how to install each of these components when doing a fresh installation of LISTSERV Maestro. For more in depth information, or for information on upgrading an existing LISTSERV Maestro installation, please see the later sections of this document.
If you already have such a LISTSERV instance installed, you may use it for LISTSERV Maestro.
If you do not have a LISTSERV instance installed, or want to use a freshly installed instance, install a new LISTSERV 16.0 with the corresponding LISTSERV installation package (see the LISTSERV installation manual for instructions).
Only necessary if you do not want to use the internal database that is deployed together with LISTSERV Maestro 4.0-16 (an instance of MySQL 4.1.13, see Appendix B for details). In this case, you need an external database that LISTSERV Maestro can use as its system database.
Supported databases are:
· IBM DB2® V7.2 and V8.2 (and compatible versions, see note below)
· Microsoft® SQL Server 2000, 2005, and 2008 (and compatible versions, see note below)
· MySQL™ 3.23.42 (and later), 4.0, 4.1, 5.0, 5.1 (and compatible versions, see note below)
· Oracle® 8i, 9i and 10g (and compatible versions)
If you already have an instance of such a database installed, you may use it as the LISTSERV Maestro system database.
If you do not have a database installed, or want to use a freshly installed database, install the database of your choice with the corresponding installation package provided by the database vendor.
Important: See the LISTSERV Maestro Administrator’s Manual for details about each database, and the specific requirements made by LISTSERV Maestro .
SQL Server Note: SQL Server 7.0 is also supported for backwards compatibility with existing installations but is not recommended to be used with new installations and existing installations are strongly recommended to be upgraded to a newer SQL Server version or to switch to one of the other supported databases.
MySQL Note: For MySQL, version 4.1 or later is recommended because some versions of 4.0 may cause problems.
LISTSERV Maestro 4.0-16 consists of three components:
· The Maestro User Interface component is the actual user interface for mail jobs, tracking data, and recipient lists.
· The Maestro Tracker component is the component that collects the tracking events that are generated by recipients of mail that was sent with the Maestro User Interface component.
· The Administration Hub component is a central component that stores registry and account information both for the Maestro User Interface and for Maestro Tracker.
For a complete LISTSERV Maestro 4.0-16 installation, each of the above components must be installed, and each of them only once. However, the components do not have to be installed on the same server, they can be distributed over several servers.
On each server where you want to install one or several of the components, execute the LISTSERV Maestro installation package:
Execute the setup application by double-clicking the “LISTSERV Maestro 4.0-16 Setup” application icon.
Before you actually perform the installation, please see Appendix C for more details about Mac OS X specific installation issues.
Once started, the Setup wizard will guide you through all the necessary setup steps. During this process, you will be queried for the target folder into which LISTSERV Maestro shall be installed.
You will also be asked which kind of setup you want to perform:
· Standard Setup: When performing a Standard Setup, all three LISTSERV Maestro components plus the internal MySQL database will be installed on the current server. Default values will be assumed for most of the configuration settings.
· Custom Setup: When performing a Custom Setup, you will have the choice of which LISTSERV Maestro components you actually want to install on the current server. You will also have to specify more configuration settings than during a Standard Setup.
Note: All settings can be changed at a later time either in the Administration Hub or by editing the corresponding configuration file. Please see the LISTSERV Maestro Administrator’s Manual for details.
Note: Setup will query only those settings which it can not determine automatically, depending on the current configuration of the server and the choices you make in the wizard. Therefore, during different installations you may be queried for different values and generally you will be queried for more values during a Custom Setup than during a Standard Setup.
To upgrade an existing installation of LISTSERV Maestro to the current version 4.0-16, do as follows:
On all hosts to be upgraded, log in with the account which is currently configured as the run-user (see Appendix C for details) and execute the setup application by double-clicking the “LISTSERV Maestro 4.0-16 Setup” application icon.
Before you actually perform the installation, please see Appendix C for more details about Mac OS X specific installation issues.
Once started, the setup wizard will guide you through all the necessary upgrade steps. When it queries you for the target folder, supply the name of the folder in which your current LISTSERV Maestro instance is installed. Setup will then recognize the existing installation and will ask you if you want to upgrade it to the current version of LISTSERV Maestro 4.0-16.
The Setup wizard will upgrade exactly the components that are already installed on this server. Setup will upgrade the installation in the folder where it is currently installed.
Caution: Upgrading an installation is an invasive process during which files of the current installation are replaced, removed or modified and new files are added. Since any such operation may potentially abort unexpectedly (power outage, disk/computer crash, other error), there is a potential for an unexpected and incomplete termination of the upgrade process that would leave the data in a partially upgraded state, from which no consistent state could be recovered. It is therefore strongly recommended that you make a backup copy of the old installation folder before you run the upgrade.
This section explains how to modify an existing installation of LISTSERV Maestro 4.0-16 on a certain server by either adding new components that had previously not been installed on this server, or by removing some of the installed components.
Important: If you modify an existing installation in the course of moving a component from one server to a different server, please do first consult the LISTSERV Maestro Administrator’s Manual about other important steps that need to performed when moving components!
To perform a modify, log in with the account which is currently configured as the run-user (see Appendix C for details) and start the Setup wizard by executing the file:
[Maestro installation folder]/setup-data/setup.sh
The Setup wizard will recognize the existing installation and will allow you to add or remove LISTSERV Maestro components.
To completely uninstall LISTSERV Maestro from the server, do not execute the Setup wizard as described above, but instead simply delete the LISTSERV Maestro installation folder.
Also, if you have configured the Startup Item for the LISTSERV Maestro background process (see Appendix C for details), you will have to delete this item too, otherwise you will get error messages during system startup (delete the folder “/Library/StartupItems/LISTSERVMaestro”).
LISTSERV Maestro can be run either as a background process or as a terminal application in a terminal window.
Running as a background process has the advantage that LISTSERV Maestro is running silently in the background (it cannot be stopped accidentally by closing the terminal window), that it will start automatically when the server is booted up, and that it will continue running when the current user logs off. This should be the normal run mode for a production environment.
Running in a terminal window has the advantage that you can see LISTSERV Maestro’s output in the window directly, and not just indirectly by looking at the log files. This run mode is normally used only when trying to diagnose problems with the server.
To start LISTSERV Maestro as a background process, you need to be logged in either as the configured run-user (see Appendix C for details) or as the root user (or if you are logged in with an administrator account, issue the following command with “sudo”).
Execute the following command:
[Maestro installation folder]/commands/StartServerInBackground.sh
This will start LISTSERV Maestro as a background process (which will remain running even if you log out), using the configured run-user as the executing user (even if the command is issued by the root user or with “sudo”).
To start LISTSERV Maestro as a terminal application, you need to be logged in either as the configured run-user (see Appendix C for details) or as the root user (or if you are logged in with an administrator account, issue the following command with “sudo”).
Execute the following command:
[Maestro installation folder]/commands/StartServerInTerminal.sh
This will start LISTSERV Maestro with all output directly visible in a terminal window, using the configured run-user as the executing user (even if the command is issued by the root user or with “sudo”).
Remember that if you start LISTSERV Maestro in a terminal, then it will automatically stop running when you log out. If you want LISTSERV Maestro to continue running even after you log out, then you must start it as a background process.
After starting LISTSERV Maestro, you can send a remote version query to each component to verify that your installation is up and running. Open a compatible browser and type each of the URLs listed below into the address field (where you replace the correct server name in each URL). The result of the query will be displayed in the browser.
· To query LUI: http://LUISERVER/lui/build
· To query LUI’s “list” context: http://LUISERVER/list/build
· To query HUB: http://HUBSERVER/hub/build
· To query TRK: http://TRKSERVER/trk/build
To stop LISTSERV Maestro (no matter if it is running as a background process or in a terminal window), you need to be logged in either as the configured run-user (see Appendix C for details) or as the root user (or if you are logged in with an administrator account, issue the following command with “sudo”).
Execute the following command:
[Maestro installation folder]/commands/StopServer.sh
To access LISTSERV Maestro, open a web browser and access the URL:
This URL provides access both to the Maestro User Interface (for normal users and the administrator) and to the Administration Hub (for the administrator only).
In the URL above, you need to replace “<YOUR_USER_INTERFACE_HOST>” with the hostname of the server running the Maestro User Interface component (LUI). In addition, if the server uses a different HTTP-port than the standard port “80”, then you need to include this different port with the host name, separated with a colon “:”, like this: “http://HOSTNAME:PORT/lui”.
Access to the Maestro User Interface and Administration Hub requires a web browser running on the client computer. For this, only the browser versions and client operating systems listed below are supported. Other browsers, browser versions or operating systems are not officially supported and should not be used.
· Microsoft Internet Explorer 5.5 or later (Windows only)
· Apple Safari 2.0 Build 412 or later (Mac OS X only)
· Mozilla 1.0.0 or later (Windows, Linux, or Mac OS X)
and any other browser on Windows, Linux, or Mac OS X which is based on a compatible Mozilla version, such as:
· Firefox 1.0 or later
· Netscape 7.0 or later
Note: The client does not necessarily have to use the same operating system as the LISTSERV Maestro server. You may for example use a Linux client to access LISTSERV Maestro on a Windows server or any other combination.
The following subsections discuss steps that you need to perform in order to prepare a fresh installation of LISTSERV Maestro for first use. If you have already provided default values for certain Administration Hub settings during the installation process, or if you have upgraded an existing installation, some of these steps may not be necessary. Read through the sections anyway, because some steps may deal with new features that were not previously available and therefore must be performed even after an upgrade of an existing installation.
LISTSERV Maestro is installed with a pre-defined example account. You can access this account by opening the Maestro User Interface and logging in with the user name “sample” (no group name) and the password that you supplied for the sample account during the setup wizard (if you did not supply a password during the setup wizard, then you first have to login with the administrator account – see below – and assign a password to the sample account before you can login with the sample account).
The sample account contains two example jobs in the list of delivered jobs, one plain text and one HTML mail job, along with the collected tracking data from these jobs, viewable with three pre-defined tracking reports. Feel free to browse through these jobs and their tracking data and to create some “test-jobs” of your own by using the sample jobs as starting points (making copies of the sample jobs).
The sample account also contains one example dataset with an example newsletter recipient list, which you may browse through and experiment with to try out the recipient warehouse features.
Note: The recipients on the sample list are dummy recipients with addresses that will all bounce back to the sender, should you actually try to deliver a mail job to these recipients.
After installation (or after upgrading) you may still have to execute a few initial configuration steps in the Administration Hub before you can fully use LISTSERV Maestro. Access the Administration Hub with a browser, using the LISTSERV Maestro access URL (see above), and log in with the user name “admin” (no group) and the administrator password that you supplied during the setup wizard.
LISTSERV Maestro login page is used for login both to the Maestro User
Interface (LUI) and to the Administration Hub (HUB). Once logged in, you can
switch freely between the two by clicking on the [Switch to LUI] or [Switch
to HUB] links at the very top of the window.
The configuration steps described below are all performed in the Administration Hub, so after the initial login, you may have to click on [Switch to HUB] to reach these settings.
Note: The following sub-sections describe only a small subset of the available configuration settings in the Administration Hub. Please see the LISTSERV Maestro Administrator’s Manual for a complete description and for more details.
Before you can fully use all features of the Maestro User Interface, you need to configure some basic settings, which you can do either on account/group level or as application wide defaults:
· To configure the application wide defaults: Go to the Administration Hub, then access the defaults via the Global Settings menu. These settings apply to all accounts and groups which do not override them with individual settings.
· To configure the settings of a non-group account: Go to the Accounts and Identities page in the Administration Hub, click on the account name and access the account settings via the User Account menu. (If the Accounts and Identities page is not already being displayed, select Accounts and Identities > Accounts and Identities Overview from the menu. If necessary, change the selection in the Displayed Accounts drop-down list to make the required account visible.)
· To configure the settings of a group: Go to the Accounts and Identities page in the Administration Hub, click on the group name and access the group settings via the Group menu. These settings apply to all accounts in the group which do not override them with individual settings. (If the Accounts and Identities page is not already being displayed, select Accounts and Identities > Accounts and Identities Overview from the menu. If necessary, change the selection in the Displayed Accounts drop-down list to make the required group visible.)
· To configure the account-specific settings of a group account: Go to the Accounts and Identities page in the Administration Hub, click on the account name and access the account settings via the User Account menu. Note that for group accounts, only a few selected settings are definable on an account level. Most settings are only definable on the group level for the associated group (see above) and therefore apply to all accounts in that group. (If the Accounts and Identities page is not already being displayed, select Accounts and Identities > Accounts and Identities Overview from the menu. If necessary, change the selection in the Displayed Accounts drop-down list to make the required account visible.)
The following sub-sections describe the most important settings that you need to define in order for the Maestro User Interface to work properly. You can define all of these settings on the account/group level or as application-wide defaults.
The LISTSERV connection settings are necessary to make the Maestro User Interface aware of the LISTSERV instance with which it is supposed to collaborate.
Since this setting can be defined individually for accounts/groups, you can connect the Maestro User Interface to separate LISTSERV instances (even in parallel), depending on which account is currently logged in and using the Maestro User Interface. You do so by defining each account’s/group’s individual LISTSERV connection settings.
If, on the other hand, you have only a single LISTSERV instance that you want to share among all accounts, then it is easiest to configure this LISTSERV instance as the application-wide default and leave the settings of the individual accounts and groups empty.
To configure the default LISTSERV connection: Select Global Settings > Maestro User Interface > Default LISTSERV Connection.
To configure the LISTSERV connection of a specific account: On the Accounts and Identities page, click on the account, then select User Account > LISTSERV Connection.
To configure the LISTSERV connection of a specific group: On the Accounts and Identities page, click on the group, then select Group > LISTSERV Connection.
Enter information for the following parameters:
· LISTSERV Host: The host name of the server running the LISTSERV component. This LISTSERV host will be used for the following purposes:
· Delivery of all mail jobs sent with the account(s) to which this setting applies.
· Bounce reporting for all jobs sent with the account(s) to which this setting applies (unless a dedicated bounce handling server is defined – see the LISTSERV Maestro Administrator’s Manual for more details).
· Creation and maintenance of all Hosted LISTSERV Lists created with the account(s) to which this setting applies (in case the Hosted LISTSERV Lists feature is used – see Section 5.3 Preparing LISTSERV Maestro for Hosted Lists for more details).
· External Host Name: If the LISTSERV host is known externally with a different host name than the one above, enter this external host name here (see the LISTSERV Maestro Administrator’s Manual for more details).
· Client Address for Mail Delivery and Bounce Reporting: The address you configure here is used by the Maestro User Interface when transferring a mail job to the LISTSERV host configured above and when retrieving bounce information from that LISTSERV host.
· Address: An e-mail address that is known to the LISTSERV host configured above either as a postmaster address or as an address that is listed under the LISTSERV configuration parameter “DIST_ALLOWED_USERS”, meaning an address that has the DISTRIBUTE right.
· Password: The address’ password, associated with it at the LISTSERV component. Please see the LISTSERV documentation about how to set a personal password for an e-mail address. (In short: Send a plain-text mail to “listserv@LISTSERV_HOST”, with “PW ADD your_password” in the mail body, and the e-mail address to which you want to assign the password as the sender address of the message.)
Note: This address and password are used internally for the communication between the Maestro User Interface and LISTSERV in order to transfer mail jobs to LISTSERV for sending or to read bounce information from LISTSERV. This transfer includes an authentication of the client accessing LISTSERV using the given e-mail address and password.
· Client Address for LISTSERV Server Administration: The address configured here is used by the Maestro User Interface to communicate with the LISTSERV host to perform server administrative tasks.
· Address: An email address that is known to the LISTSERV configured above as a postmaster address.
· Password: The address’ password, associated with it at the LISTSERV component. (See above for details about how to set a password for an address.)
Note: This address is only used internally for the communication between the Maestro User Interface and LISTSERV for server administrative tasks. These tasks include an authentication of the client accessing LISTSERV using the given e-mail address and password.
The tracking URL is necessary to enable the mail tracking functionality of LISTSERV Maestro. Without a tracking URL, you can still create and send mail jobs, but you cannot enable tracking for them.
Since this setting can be defined individually for accounts/groups, you can make LISTSERV Maestro use different tracking URLs (even in parallel) depending on which account is currently logged in to the Maestro User Interface. You do so by defining each account’s/group’s individual tracking URL settings.
If, on the other hand, you have no reason to use different tracking URLs for different accounts or groups, then it is easiest to configure the tracking URL as an application wide default and leave the settings of the individual accounts and groups empty.
To configure the default tracking URL: Select Global Settings > Maestro User Interface > Default URL Settings.
To configure the tracking URL of a specific account: On the Accounts and Identities page, click on the account, then select User Account > URL Settings.
To configure the tracking URL of a specific group: On the Accounts and Identities page, click on the group, then select Group > URL Settings.
Enter information for the following parameters:
· Tracker Host: Enter the host name of the server running the Maestro Tracker component. This must be a DNS-registered host name that can be used by external clients to access the server from the Internet.
Note: In a proxy environment, the Tracker
This step is usually only executed after you are done testing the system with the predefined sample account (see above) and are ready to use the system with your own accounts. Create at least one user account that you can then use to access the Maestro User Interface. Select Accounts and Identities > New Account. Next, enter the account name (and, optionally, group) and the password. Click on [OK].
If you do not want the account to use the default LISTSERV connection settings and/or default tracking URL settings, (or if you have not configured such defaults) you need to configure individual connection and tracking URL settings for the account. See the previous sub-sections on how to configure these settings on the account/group level.
The recipient warehouse of LISTSERV Maestro allows you to store and maintain your recipient lists (and all recipient profile values) directly inside of LISTSERV Maestro, without the need for additional software.
The recipient warehouse allows you to created hosted lists of two types:
· Hosted Recipient Lists
· Hosted LISTSERV Lists
Each of these recipient list types has its own set of special features. Please see the documentation for LISTSERV Maestro for more details.
To use hosted lists in general, you will have to perform the following steps (or confirm that they have been performed earlier). For each of the steps below, see the following sub-sections for details:
Enable Usage of Hosted
In a freshly installed LISTSERV Maestro, usage of Hosted Lists is already enabled by default. However, after an upgrade from an older version, where this feature may have been disabled or was not yet available, it may be necessary to enable their usage in the Administration Hub.
Even after usage of hosted lists has been enabled in general, only accounts that are granted the right to administer hosted recipient datasets are actually allowed to use the feature.
If you want to use hosted lists of the type Hosted Listserv List, you will also have to perform these additional steps (or confirm that they have been performed earlier). Again, see the following sub-sections for details about each step:
3. Define Database Server in LISTSERV
If Hosted LISTSERV Lists are to be used, then the LISTSERV host configured in the LISTSERV connection settings of the corresponding account/group needs to be connected to the system database of LISTSERV Maestro.
If you want to use hosted lists, confirm that their usage has been enabled in the Administration Hub (this is by default the case in a freshly installed LISTSERV Maestro).
To enable hosted lists by default: Select Global Settings > Maestro User Interface > Default Hosted Data Settings.
To enable hosted lists for a specific account: On the Accounts and Identities page, click on the account, then select User Account > Hosted Data Settings.
To enable hosted lists for a specific group: On the Accounts and Identities page, click on the group, then select Group > Hosted Data Settings.
The Hosted Data Settings screen allows you to selectively enable or disable creation of Hosted Recipient Lists and/or Hosted LISTSERV Lists. Only accounts to which one of the enabled creation rights apply will be allowed to create the corresponding type of hosted list. (Note that the applicable right may also be inherited from the default level, if not overridden on the individual account/group level.)
Once usage of hosted lists has been enabled for a group (specifically in the group settings or as an inherited default setting), it is still necessary to define which accounts from the group are actually granted the right to use this feature.
To define the right for a specific account: On the Accounts and Identities page, click on the account, then select User Account > User Right Settings.
The User Right Settings screen allows you to grant or revoke the right to administer hosted recipient datasets for the selected account.
Note: If this user right is granted, then the right to administer target groups is also always granted by default. Any user who is allowed to administer datasets will always also be allowed to administer target groups.
Note: If this user right is granted but usage of hosted lists is still disabled (see the previous sub-section), then the account will still not be able to administrate hosted lists until hosted lists are enabled as described above.
Note: Non-group accounts are handled in the same manner. If you grant only this right but do not enable usage of hosted lists, the account will not be able to use hosted lists. To actually allow usage of hosted lists, you also need to enable that feature as described in the previous sub-section. (Enabling usage of hosted lists, but not granting the administer hosted recipient datasets right, will not have any effect and the account will not be able to used hosted lists.)
Hosted lists of the Hosted LISTSERV List type are based on classic LISTSERV lists, as described in the previous sub-section.
The LISTSERV list created by LISTSERV Maestro will be an actual LISTSERV list, but one that is “database backed” by a table in the LISTSERV Maestro system database (also called “DBMS-backed list” or simply “DBMS list”). This means that the subscribers on the list are not stored in LISTSERV itself, but in a table in the database backing the list (in this case, the LISTSERV Maestro system database). With such a DBMS list, LISTSERV must have access to the backing database in order to be able to retrieve the subscribers during delivery.
To enable LISTSERV to access the LISTSERV Maestro system database, you need to configure a specific database server name in the LISTSERV instance.
You need to do so for every LISTSERV instance that is configured in the LISTSERV connection settings of any account/group for which the feature to create Hosted LISTSERV Lists is enabled.
In other words, if for an account/group you have enabled the feature to create Hosted LISTSERV Lists, then you must configure the LISTSERV instance that this account/group has defined in its LISTSERV connection settings (or inherited from the default settings) to be able to connect to the LISTSERV Maestro system database. (If the only hosted list type you have enabled is Hosted Recipient List, then you do not have to do this.)
The following instructions describe how to configure a LISTSERV instance on a Windows 2000 host so that it is correctly enabled to connect to the LISTSERV Maestro system database. For other Windows operating systems, the procedure is very similar. For LISTSERV on a non-Windows host, please refer to the LISTSERV documentation on how to create a database server name. Use the description below as a guideline and modify it to apply to your operating system.
On Windows, LISTSERV’s database connection happens by way of ODBC. You must first create a system-wide ODBC data source on the host where the LISTSERV instance is installed. This may or may not be the same host where LISTSERV Maestro or its system database is installed.
For example on Windows XP: Open the Control Panel. Next, open Administrative Tools, then open Data Sources (ODBC). Select the System DSN tab, and then click [Add…]. Select the appropriate driver and fill out the driver-specific form with the database specific values, using the same values as you supplied for the system database connection in the Administration Hub of LISTSERV Maestro (the same database host name, port and any additional settings required by the driver). L-Soft does not recommend supplying a user name and password in a system-wide DSN (if offered by the driver at all). Instead of supplying these values in the DSN, you will supply them in the LISTSERV configuration (see below). Give the DSN a meaningful name.
Now you need to configure this DSN as a database server name in LISTSERV. You can do so by using the LISTSERV Configuration tool or by editing the SITE.CFG file directly:
· Using the LISTSERV Configuration tool:
Start the tool. Click on Advanced Configuration and then DBMS…, then on More Servers. Fill out the Server field with the specific server name (see below for details) and the DSN, User ID, and Password fields with the name of your DSN and the same database user name and password that you have also supplied for the system database connection in the Administration Hub of LISTSERV Maestro. Then click [Add/Replace] and then [OK].
· Editing SITE.CFG:
Add the following lines to the SITE.CFG
file of the LISTSERV instance:
where you replace “SERVERNAME” with the specific server name (see below for details), “DSN_NAME” with the name of your DSN and “USERNAME” and “PASSWORD” with the same database user name and password that you have also supplied for the system database connection in the Administration Hub of LISTSERV Maestro.
The “SERVERNAME”: The value for the specific server name to be used in the above configuration is a special value that you can find on the LISTSERV Connection screen in the Maestro Administration Hub:
Default LISTSERV Connection: Select Global Settings > Maestro User Interface > Default LISTSERV Connection.
LISTSERV Connection for a specific account: On the Accounts and Identities page, click on the account, then select User Account > LISTSERV Connection.
LISTSERV Connection for a specific group: On the Accounts and Identities page, click on the group, then select Group > LISTSERV Connection.
The server name is given as the value labeled Database Server Name in the Hosted LISTSERV Lists Settings section. This name always starts with “MAESTRODB_”, followed by a unique string of characters. For example, “MAESTRODB_dtn7nzn3”. So the entry in the SITE.CFG might look like this:
(On your own server, you would replace “dtn7nzn3” with the correct value for your SERVERNAME.)
It is important to use exactly the same server name as given on the LISTSERV Connection screen of the Administration Hub, using the exact spelling (all letters must be in lowercase, which is also useful to discern between the letter “O” and the digit “zero”: The letter is shown in lowercase as “o” while the digit is shown as “0”).
Important: LISTSERV requires that if you are using a database server name, the “default database interface” must also always be defined, even if it is not used. If you do not already have the default database interface defined, you need to do this now. Otherwise, the above configuration of the database server name for Maestro will be ignored by LISTSERV. However, for the default database interface, you may supply dummy values as shown below. (Note that the following step is not necessary if the default database interface is already defined in your LISTSERV configuration.)
Again, you can edit your LISTSERV configuration either by using the LISTSERV Configuration tool or by editing the SITE.CFG file directly:
· Using the LISTSERV Configuration tool:
Start the tool. Click on Advanced Configuration and then DBMS…. Enter “Dummy” into the DSN, User ID, and Password fields in the Default Interface to Database section, and then click [OK].
· Editing SITE.CFG:
the following lines to the SITE.CFG
file of the LISTSERV instance:
Note for Users of the Internal System Database: LISTSERV Maestro comes with an out-of-the-box version of MySQL as the internal system database. If you use this internal database as the system database and need to connect LISTSERV to it as described above, do this as follows:
· If LISTSERV is installed on the same host as the internal database – that is the host where the Maestro User Interface (LUI) component is installed – then you need an ODBC-driver for MySQL on that host, and when creating the DSN you need to supply the host name “localhost”, the port “3306” and the database name “LUI”. In the LISTSERV Configuration tool (or the SITE.CFG, see above), supply “luiuser” as the user name and “lui” as the password.
− OR −
· If LISTSERV is installed on a different host than the internal database, then you need an ODBC-driver for MySQL on that host, and when creating the DSN you need to supply the host name where the internal database is installed (the host where the Maestro User Interface component is installed), the port “3306” and the database name “LUI”. Then in the LISTSERV Configuration tool (or the SITE.CFG, see above), supply a database user name and password of your choice (and of course remember which ones you chose).
second step, you need to grant the right to access the internal database to
this user that you have defined. Do so here:
On the server where the Maestro User Interface component is installed, start the MySQL client program
[Maestro installation folder]/lui/database/bin/mysql –u root
Then enter the following command:
grant all on lui.* to USERNAME@LISTSERVHOST identified by 'PASSWORD';
where you replace “USERNAME” with the database user name you have defined (this is your self defined user name, see above), “LISTSERVHOST” with the name of the host where LISTSERV is running and “PASSWORD” with the database password you have defined (again, your self defined password, see above).
Take care to use the same upper/lowercase spelling of the username and password as you have defined them in the LISTSERV Configuration tool (or the SITE.CFG). Also take care to type “lui.*” in lowercase.
To display the pages of the user interface, LISTSERV Maestro uses a technology that compiles each page “just-in-time” – that is, at the moment a user accesses a page for the first time. This means that when LISTSERV Maestro is freshly installed, all pages are still un-compiled, existing in their raw state. The moment a page is accessed for the first time, it is compiled automatically behind the scenes and the result is displayed to the user.
Because of this, the first access to a page is usually noticeably slower (it takes longer for the page to appear) because the page is compiled first. Any subsequent access to the same page will happen with normal speed because it is now pre-compiled (even after a restart of the server).
The slower page loading during first access after an installation can be avoided by executing the “CompileAll” command after the installation. This will pre-compile all pages of the application so that page loading will happen with normal speed even during the first access of a page.
The command can be found in the “commands” subfolder of the LISTSERV Maestro installation folder. The command is named “CompileAll.sh”. Simply execute the command.
LISTSERV Maestro must be running on the server while the command is being executed.
Note: Compilation is a lengthy and processor-intensive task that may take a considerable amount of time during which the server will be working to capacity. Please be patient and wait until the “Compilation complete” message appears in the console (see below). You may safely interrupt the command at any time, which will then leave all the remaining pages in the un-compiled state. You can then re-execute the command at a later time to compile the remaining pages.
Executing the command is completely optional. If you do not execute the command, or if you interrupt its execution, all pages that are not pre-compiled will be compiled in the background when they are accessed by a user for the first time. This command needs to be executed only once, since running it again when all pages are already pre-compiled has no additional benefit.
When executed, the command displays its output in a console, similar to the following:
Compilation started at Thu Aug 08 09:56:14 CEST 2002
All pages compiled successfully
The last line of the output must read “All pages compiled successfully”. If that line instead reads “There were compilation errors on ... pages”, then there was a problem. If all pages failed to compile, then LISTSERV Maestro was probably not running on the server on which you executed the command. If LISTSERV Maestro actually was running, or if only a few pages failed to compile, then you most likely have a corrupted installation. Try to re-install or, when in doubt, contact L-Soft support.
The “CompileAll” command only pre-compiles the pages of the local server. If both the Maestro User Interface and the Administration Hub components are installed on the same server, then “CompileAll” will pre-compile the pages of both these components. If only one of the components is installed, then the command will pre-compile only the pages of that component. In this case the command should also be run on the server(s) where other components are installed.
This manual assumes that you have access to the LISTSERV Maestro 4.0-16 setup application:
LISTSERV Maestro 4.0-16 Setup
(This setup is normally part of the ZIP-distribution bundle which also contains this manual. If you unzipped the distribution bundle into a folder, then you will find an icon with the above name in that folder.)
LISTSERV Maestro on Mac OS X is officially supported for Mac OS X 10.4 or later with Java 5.0 installed (Java 5.0 can be downloaded from www.apple.com).
When installing the components on the their hosts, the following restrictions must be met:
· All hosts that contain any of the three LISTSERV Maestro components must be interconnected with a network in such a way that the components can communicate using TCP/IP ports. In addition, the host where the Maestro User Interface component is installed must be interconnected with the LISTSERV host, as well as with the host of any optional database(s).
· The host where the Maestro Tracker component is installed must have a registered DNS host name and the HTTP port (typically port “80”) on that host must be available to external users from the Internet.
· The host where the Maestro User Interface component is installed must be accessible on the HTTP port for all intended users of the Maestro User Interface. If there are only internal users, then the host may be protected by a firewall. However, if external users also must access the Maestro User Interface, then the host needs to have a registered DNS host name and the HTTP port must be available to external users from the Internet, even through a firewall.
Note: If the Recipient Warehouse feature is to be used in such a way that subscribers will be able to use the subscriber access pages to independently subscribe to and unsubscribe from lists, as well as to edit their subscription profiles, then the Maestro User Interface must be accessible to external users as described above.
· The host where the Administration Hub component is installed must be accessible on the HTTP port for all intended users of the Administration Hub interface. If there are only internal users, then the host may be protected by a firewall. However, if external users also must access the Administration Hub, then the host needs to have a registered DNS host name and the HTTP port must be available to external users from the Internet, even through a firewall.
· For standard installations, the three LISTSERV Maestro components all require use of the HTTP port. On a host where any of these three components is installed, there may not be any other software running that also requires use of the same HTTP port (such as a web server, for example). The three LISTSERV Maestro components themselves may however share one host and the same HTTP port. The standard port for HTTP is port “80”. However, a different port may be configured as the HTTP port during setup or at a later time (see the LISTSERV Maestro Administrator’s Manual for details about how to change the port at a later time).
· Other restrictions may apply to the LISTSERV host, depending on LISTSERV’s setup requirements. See the LISTSERV manuals for details.
Remember that if any of the components share a host, then all restrictions from all components on that host apply.
By default, LISTSERV Maestro 4.0-16 is installed with an instance of MySQL 4.1.13 as the internal system database.
Using this internal system database is optional. You may decide during setup not to install the internal system database at all, in which case you have to install a separate external system database. Alternatively, you may choose to install it during setup, but then switch to a different external system database of your own at a later time.
Please see http://www.mysql.com for details about MySQL 4.1.13 and its features to determine if it meets your requirements and expectations for a production database. Reviewing the features will help you decide if you want to use the internal database or if you prefer to install a different external system database.
With LISTSERV Maestro, the internal MySQL database is installed on the same server as the Maestro User Interface component (if installation of MySQL was not deselected during setup). You can find the database binaries, including the server and client tools, in this folder on that server:
[Maestro installation folder]/lui/database
Note: The internal MySQL 4.1.13 database included with LISTSERV Maestro 4.0-16 is a binary distribution of the version for Mac OS X 10.4. If you are using a newer Mac OS X version and are planning to use the internal database, you might have to exchange it manually with a MySQL distribution for your newer Mac OS X version (or you can simply not install the internal database and connect to an external database instead).
To enable LISTSERV Maestro to be started automatically during each system startup (as a background process), a Startup Item for the background process must be installed. This is done as follows:
(For the below procedure to work, you must be logged in with an administrator account or as the root user.)
During the installation, setup has already prepared a startup item for the LISTSERV Maestro server which needs to be copied to the correct location to “install” it. The prepared startup item is initially located in the following folder:
[Maestro installation folder]/commands/StartupItem
The startup item itself is a folder with the name “LISTSERVMaestro” which contains two files (one called “LISTSERVMaestro”, i.e. the same name as the folder itself, and one called “StartupParameters.plist”).
Copy this “LISTSERVMaestro” startup item folder with the two files in it to the following location:
so that you have the following folder and file structure:
After you have copied the folder, you need to set the correct folder and file ownership for these items: Both the folder and the files in it must be owned by “root” in group “wheel”.
You can change the ownership manually as follows: Open a terminal, change to the folder “/Library/StartupItems” and execute the following command:
sudo chown –R root:wheel LISTSERVMaestro
(enter your administrator password if queried – if you are already logged in as the root user, you can leave out the “sudo” part in the above command).
Note: If you do not want to set the ownership manually, you can let Mac OS X do this for you: Restart the computer and log in again with the same account as before. A short moment after the login, a security warning for the startup item will be displayed, caused by the still incorrect ownership of the files. One of the options in the security warning window is the Fix option. Select this option to let Mac OS X set the correct ownership on the startup item files for you.
The normal LISTSERV Maestro Setup wizard which is started via the “LISTSERV Maestro 4.0-16 Setup” icon is a GUI based application which requires the Mac OS X Aqua user interface to run. If the graphical user interface is not available (for example if you are installing remotely via telnet), you may also execute the Setup wizard in a purely text based terminal mode.
To start the Setup wizard in this terminal mode, open a terminal and change into the folder into which you have unzipped the distribution ZIP archive. This is the folder which contains the “LISTSERV Maestro 4.0-16 Setup.app” folder. From there, execute the following command:
"LISTSERV Maestro 4.0-16 Setup.app"/Contents/MacOS/LISTSERVMaestroSetup.sh -headless
The run-user is the account under which the LISTSERV Maestro server is actually run (no matter if started as a terminal application or as a background process).
After a fresh installation, the initially configured run-user is always the root user.
Security Note: For security reasons it is usually considered good practice not to run a server under the root user account, if possible. Therefore, you might want to change the run-user to a different account after the initial installation (however, you have to keep the run-user constraint in mind).
The currently configured run-user can be found in the file
[Maestro installation folder]/commands/UserConfig.sh
In this file, look for an entry similar to “export RUN_USER=username”, where “username” defines the current run-user.
For security reasons imposed by the operating system, non-root users are not allowed to open servers on the so called “privileged ports”, which are ports in the range of “1023” and below.
Therefore, the choice for the run-user is constrained by the following:
· If the HTTP-port is a privileged port (“1023” and below, including the defaults of “80” for HTTP and “443” for HTTPS), you must specify the root user as the run-user.
· If the HTTP-port is a non-privileged port (“1024” and above), you can specify any user account as the run-user (preferably not the root user).
To change the LISTSERV Maestro run-user, do the following:
· Shut down LISTSERV Maestro.
· Edit the following file:
[Maestro installation folder]/commands/UserConfig.sh
The file contains an entry similar to:
where username is the name of the current run-user. Replace this name with the user account name you want to define as the new run-user instead.
· If the new run-user is not the root user, then you also need to do the following:
· Make sure that you do not violate the run-user constraint, i.e. it might be necessary that you also change the HTTP-port to a non-privileged port if the new run-user is not the root user.
file ownership of the LISTSERV Maestro installation folder and all files in it
to the new run-user (this is not necessary if the root user is used as the new run-user), by
executing a recursive chown
command on the installation folder:
(For this to work, you must be logged in with an administrator account or as the root user.)
sudo chown –R username:groupname installfolder
where username is the name of the new run-user, groupname is the name of group the files shall belong to (the group is optional and can be left out, in which case you would leave out the colon “:” too) and installfolder is the name of the folder where LISTSERV Maestro is installed.
(Enter your administrator password if queried – if you are already logged in as the root user, you can leave out the “sudo” part in the above command.)