LISTSERV® Maestro 6.0 Installation Manual for Linux® - L
Contents
1. Softy LISTSERV Maestro 6 0 Installation Manual for Linux April 15 2015 L Soft Sweden AB Isoft com LISTSERV MAESTRO This document describes the installation of the Version 6 0 Build 10 release of LISTSERV Maestro for Linux with a build date of April 15 2015 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 Copyright 2003 2015 L Soft Sweden AB All Rights Reserved Worldwide LISTSERV is a registered trademark licensed to L Soft international Inc L SOFT and LMail are tr2. 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 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 O Address An e mail 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 LISTSERV Maestro 6 0 10 8 Installation Manual for Linux 5 2 1 2 Tracking URL 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 g
3. 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 How to Change the LISTSERV Maestro Run 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 RUN_USER username 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 O 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 Set 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 as the root user 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
4. iiee eis sanete peres pa Rar ea pea y EISE en re 3S PEE a aee Sean EE dE 4 4 1 Starting LISTSERV Maestro ccceesssssceeecececeenseseececececeaneeeaeseeceeeseasaueesseeeeeeeeesauagsess 4 ALI Startas Daemon PrOocessiicc cccecscncivaiscoteontecncteniesetecerecnedeaeesodcoutectsdeandsotscetneacdensabdeoureedcedesish 4 4 1 2 Start as Console Application ccccsscssecececsssssaseccecececsesseasecsececeesenueasacseceseesensateceecneeess 4 4 1 3 Checking if LISTSERV Maestro is RUNNING cssccccccecessessssececeeecesseseaeaeeeeseessessaeaneeeeees 5 4 2 Stopping LISTSERV MaestrO ssseeeeeenenenen enne nennen nennen nnne enne nnne nennen 5 4 3 Accessing LISTSERV Maestro sssseseseeeenenen enne enn enne nennen enean nennen enean nene 5 4 3 1 Supported BrOWSEMS cicasdexesesszzevecdedessvehedes caeeus tocco seva etae eco saos xa vtasg eraai r EEE Sieen Ea 5 5 Prepare LISTSERV Maestro for First Use eese eee eee eene nnn 6 5 1 First Steps with the LISTSERV Maestro Sample ACCOUNL ccccccessessssececeeeeeseessaees 6 5 2 Configuring LISTSERV Maestro for First US c ccccccccssssessseeeceescessessaeeeeeeeesesesseaees 6 5 2 1 Maestro User Interface Runtime Settings c cccccccecessssssseceeececsssesseaeceseesseesesnsaeeeeeeeseeeees 7 5 2 1 1 EISTSERV Connection ooo esee tin ie ideni Pe ao dues Casu ae eee 7 5 2 1 2 Tracking URL terere DURER EORR ERRLEE UR cde pedi
5. using the configured run user as the executing user even if the command is issued by the root user Remember that if you start LISTSERV Maestro in a console 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 daemon process LISTSERV Maestro 6 0 10 4 Installation Manual for Linux 4 1 3 Checking if LISTSERV Maestro is Running 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 e To query LUI http LUISERVER 1lui build e To query LUI s list context http LUISERVER list build e To query HUB http HUBSERVER hub build e To query TRK http TRKSERVER trk build 4 2 Stopping LISTSERV Maestro To stop LISTSERV Maestro you need to be logged in either as the configured run user see Appendix C for details or as the root user Execute the following command Maestro installation folder commands StopServer sh 4 3 Accessing LISTSERV Maestro To access LISTSERV Maestro open a web browser and access the URL http YOUR MAESTRO USER INTERFACE HOST lui
6. 6 0 10 14 Installation Manual for Linux e 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 e 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 are also supposed to access the Maestro User Interface then the host must 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 e 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 are also supposed to access the Administration Hub then the host must to have a registered DNS host name and the HTTP port must be available to external u
7. 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 1ui 4 3 1 Supported Browsers Access to the Maestro User Interface and Administration Hub requires a web browser running on the client computer It is strongly recommended that you use the latest version or at least a relatively recent version of one of the major browsers Google Chrome Firefox Microsoft Internet Explorer Apple Safari or Opera If another browser or an older version of one of these browsers is used it is possible that some features of LISTSERV Maestro may not work as expected and or that the application pages may suffer display problems 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 LISTSERV Maestro 6 0 10 5 Installation Manual for Linux 5 Prepare LISTSERV Maestro for First Use The following subsection
8. for 64 bit If necessary you may need to perform a chmod on the file first to make it executable During execution the self extracting setup will create a temporary folder in the current directory This folder will automatically be removed once setup completes Before you actually perform the installation please see Appendix C for more details about Linux 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 e 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 e 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 Please read section 6 Prepare LISTSERV Maestro for First Use for further steps you might have to execute after a successful installation 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 Administrato
9. 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 7 Open the Control Panel Next open System and Security then 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 4 If the administer hosted Recipients Datasets 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 Also 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 If the only hosted list type you have enabled is Hosted Recipient List then you do not have to do this LISTSERV Maestro 6 0 10 11 Installation Manual for Linux 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 wi
10. of the folder where LISTSERV Maestro is installed LISTSERV Maestro 6 0 10 18 Installation Manual for Linux
11. 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 The minimum supported LISTSERV version is LISTSERV 16 0 with build date 10 Dec 2009 LISTSERV Maestro 6 0 10 1 Installation Manual for Linux 1 3 Install LISTSERV Maestro 6 0 10 LISTSERV Maestro 6 0 10 itself consists of three components e The Maestro User Interface component is the actual user interface for mail jobs tracking data and recipient lists e 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 e 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 acomplete LISTSERV Maestro 6 0 10 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 self extracting setup file LISTSERVMaestro6 0 10 linux x86 bin for 32 bit or LISTSERVMaestro6 0 10 linux x64 bin
12. shown below Again you can edit your LISTSERV configuration either by using the LISTSERV Configuration tool or by editing the SITE CFG file directly e Use 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 OR e Edit SITE CFG Add the following lines to the SITE CFG file of the LISTSERV instance ODBC DSN DUMMY ODBC UID DUMMY ODBC AUTH DUMMY 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 e 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 Also in the LISTSERV Configuration tool or the SI TE CFG see above supply 1uiuser as the user name and lui as the password 6 Itis 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
13. 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 LISTSERV Maestro 6 0 10 13 Installation Manual for Linux OR e 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 SI TE CFG see above supply a database user name and password of your choice and of course remember which ones you chose As a 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 ab
14. SERV Maestro is a generic Linux version that relies on certain shared libraries and assumes that these libraries are already present on the system If MySQL cannot start it may therefore be necessary to install some missing shared libraries on your Linux system LISTSERV Maestro 6 0 10 15 Installation Manual for Linux Please see http www mysgl com for details about MySQL 5 5 16 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 some selected server and client tools in the folder Maestro installation folder lui database on that server Upgrade Note LISTSERV Maestro 4 0 and older was installed with an internal MySQL database of an older version than 5 5 16 When upgrading such an existing older installation to version 6 0 10 the internal MySQL database will not automatically be upgraded to 5 5 16 Instead the upgraded LISTSERV Maestro 6 0 10 will continue to use the older internal MySQL database version If you are upgrading from such an older version of LISTSERV Maestro 4 0 or older and are using the
15. ademarks of L Soft international Inc CataList and EASE are service marks of L Soft international Inc 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 for LISTSERV are available in ASCII text format via LISTSERV and in popular word processing formats via ftp lsoft com They are also available on the World Wide Web at the following URL 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 1 Quick Installation Guide dccsnsacacepcencdcccensadcsdecidecdsateotsanessadatsensateeiane 1 1 1 Install LISTSERV it ibeensietiumd qetuiessend tac dieat ue dedetumett De qae Hound tRoledia iine wes 1 1 2 Install External Database optional cccccccccssssececssssececseaeeeceesesseeeesssaeeeessaaeeeees 1 1 3 Install LISTSERV Maestro B 0 D sic vase cen nace inda mena iaa aV enna nanan ado a bri 2 2 Upgrading an Existing Installation eese ecce ee eee eene 3 3 Modifying or Uninstalling an Existing Installation 3 4 Running LISTSERV Maestro
16. aestro Administration Hub Default LISTSERV Connection Select Global Settings gt Maestro User Interface gt 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 LISTSERV Maestro 6 0 10 12 Installation Manual for Linux 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 ODBC DSN MAESTRODB dtn7nzn3 DSN NAME ODBC UID MAESTRODB dtn7nzn3 USERNAME ODBC AUTH MAESTRODB dtn7nzn3 PASSWORD On your own server you would replace dtn7nzn3 with the correct value for your SERVERNAME 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
17. allation setup has already prepared the daemon startup script for the LISTSERV Maestro server Maestro installation folder commands lsoft maestro As the root user copy this file to the location on your system where daemon scripts are usually located On a typical Linux this is usually the folder etc init d In addition you will typically have to create symbolic links to this file for startup or shutdown in the corresponding runlevel folders etc rc d depending on if you want to start or stop the LISTSERV Maestro daemon in that runlevel The actual steps to install the daemon script on your system may differ for your Linux distribution see your distribution s documentation for more details Console Based Installation Headless The normal LISTSERV Maestro setup wizard is a GUI based application which requires a graphical environment to run If such a graphical environment is not available for example if you are installing remotely via telnet or if the server does not have a graphics environment installed you may also execute the setup wizard in a purely text based console mode To start the setup in this console mode execute the self extracting setup file with the additional parameter headless as follows LISTSERVMaestro6 0 10 linux x86 bin headless or LISTSERVMaestro6 0 10 linux x64 bin headless Understanding the LISTSERV Maestro Run User The run user is the account under w
18. ccount 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 that 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 5 2 Configuring LISTSERV Maestro for First Use 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 Note The 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 descrip
19. d 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 6 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 LISTSERV TCPGUI Port The port number on the LISTSERV host on which the LISTSERV component accepts TCPGUI connections the standard port is 2306 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 O 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
20. e 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 The following instructions describe how to configure a LISTSERV instance on a Windows XP 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
21. e 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 6 0 10 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 Please read the section 6 Prepare LISTSERV Maestro for First Use for further steps you might have to execute after a successful upgrade 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 computer crash other error there is a potential for an unexpected and incomplete termination of the upgrade process that could 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 3 Modifying or Uninstalling an Existing Installation This section explains how to modify an existing installation of LISTSERV Maestro 6 0 10 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 I
22. ecessary to enable their usage in the Administration Hub 2 Grant Data Administrator Right 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 an additional step or confirm that it has been performed earlier Again see the following sub sections for details about this 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 5 3 1 Enable Usage of Hosted Lists 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 di
23. f 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 LISTSERV Maestro 6 0 10 3 Installation Manual for Linux Also if you have configured the daemon startup script for LISTSERV Maestro see Appendix C for details you will have to delete this script too otherwise you will get error messages during system startup 4 Running LISTSERV Maestro LISTSERV Maestro can be run either as a daemon process or as a console application Running as a daemon process has the advantage that LISTSERV Maestro is running silently in the background it cannot be stopped accidentally by closing the console window that it will start automatically when the server is booted up and that it will continue running when the current user logs off Th
24. hich the LISTSERV Maestro server is actually run no matter if started in console mode or as a daemon 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 RUN USER username where username defines the current run user 8 As is the convention for daemon scripts if this script is executed with the parameter start it will start the LISTSERV Maestro server if it is executed with stop it will stop the server Some Linux distributions also have a GUI tool for this LISTSERV Maestro 6 0 10 17 Installation Manual for Linux LISTSERV Maestro Run User Constraint 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
25. 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 e Toconfigure 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 5 2 1 1 LISTSERV Connection 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 i
26. internal MySQL database then please contact L Soft support for help on how to also upgrade the internal database Appendix C Special Linux Installation Issues Pre Installation Verify that GNU tar is available The installation of LISTSERV Maestro requires that the GNU version of the tape archival tool tar is present on all hosts where LISTSERV Maestro components will be installed To find out if the currently available tar is sufficient to install LISTSERV Maestro issue the following command maestro host gt tar version tar GNU tar 1 13 19 Copyright 2001 Free Software Foundation Inc This program comes with NO WARRANTY to th xtent permitted by law You may redistribute it under the terms of the GNU General Public License S the file named COPYING for details Written by John Gilmore and Jay Fenlason If the version output does not contain the text GNU tar or reports an error then you need to obtain a compatible version However for all supported Linux platforms the distribution normally contains the GNU version of tar so this should usually not be necessary Configuring LISTSERV Maestro for Automatic Startup To enable LISTSERV Maestro to be started automatically during each system startup as a daemon process a daemon startup script must be made available to the init process responsible for starting the daemons at system startup LISTSERV Maestro 6 0 10 16 Installation Manual for Linux During the inst
27. is should be the normal run mode for a production environment Running in a console 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 4 1 Starting LISTSERV Maestro 4 1 1 Start as Daemon Process To start LISTSERV Maestro as a daemon process you must first have installed the corresponding LISTSERV Maestro daemon scripts please see Appendix C for details The correct method to start such a pre configured daemon process depends on the actual operating system you are running LISTSERV Maestro on For many UNIX variants the following command issued by the root user will start the LISTSERV Maestro daemon process under the assumption that the daemon script has been installed correctly etc init d lsoft maestro start Note Even though the daemon is started by the root user the server is actually executed under the account of the configured run user which may be different than the root user 4 1 2 Start as Console Application To start LISTSERV Maestro as a console application you need to be logged in either as the configured run user see Appendix C for details or as the root user Execute the following command Maestro installation folder commands StartServer sh This will start LISTSERV Maestro with all output directly visible in the console
28. ll 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 e Use 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 OR e Edit SITE CFG Add the following lines to the ST TE CFG file of the LISTSERV instance ODBC DSN SERVERNAME DSN NAME ODBC UID SERVERNAME USERNAME ODBC AUTH SERVERNAME PASSWORD 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 M
29. ndividually 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 LISTSERV Maestro 6 0 10 7 Installation Manual for Linux To configure the default LISTSERV connection Select Global Settings gt Maestro User Interface gt 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 gt LISTSERV Connection To configure the LISTSERV connection of a specific group On the Accounts and Identities page click on the group then select Group gt 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 O O 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 dedicate
30. neas E EXISTENS e REUS REFERS IER 9 SA3 User eiie m 9 5 3 Preparing LISTSERV Maestro for Hosted Lists essere 9 5 3 1 Enable Usage of Hosted Lists eene nennen nennen enne nnn nn isses nnne 10 5 3 2 Grant Right to Administer Recipient Datasets 0 cccccsssecccecessessseeceeeeeseesesseaeeeeeesseesees 10 5 3 3 Define Database Server in LISTSERV ssessseseseeeeeeneeen nennen nennen nnne 11 Appendix A Required Resources e eceee eese eene eene ee eene enses n nana nnno 14 Appendix B The Internal MySQL Database ee eeeee eee eene 15 Appendix C Special Linux Installation Issues eenecne nennen 16 Pre Installation Verify that GNU tar is available 16 Configuring LISTSERV Maestro for Automatic Startup ccecccceesssseceesesneeeceseseeeeeeeeaaeeeees 16 Console Based Installation Headless cccccccccccccccssssssssseescecceesessseeuseeceusseessseeeeeeesensens 17 Understanding the LISTSERV Maestro Run User ceceessccecesstececesseeeecessseeeeeessaeeeenesneess 17 LISTSERV Maestro Run User Constraint How to Change the LISTSERV Maestro Run User 1 Quick Installation Guide For acomplete installation of LISTSERV Maestro 6 0 10 several components are required that may be installed on one server or distributed over several server
31. nter 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 5 3 Preparing LISTSERV Maestro for Hosted Lists 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 e Hosted Recipient Lists e Hosted LISTSERV Lists LISTSERV Maestro 6 0 10 9 Installation Manual for Linux 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 1 Enable Usage of Hosted Lists 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 n
32. ove 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 SI TE CFG Also take care to type 1ui in lowercase and to use the apostrophe quotes as shown above Appendix A Required Resources This manual assumes that you have access to the self extracting setup file of LISTSERV Maestro 6 0 10 ISTSERVMaestro6 0 10 linux x86 bin for 32 bit or ISTSERVMaestro6 0 10 linux x64 bin for 64 bit To be able to execute the setup package and also LISTSERV Maestro itself you must have the GNU C library installed on your system libstdctt libc6 1 1 s0 2 Also you need to have GNU tar installed see Appendix C The version of MySQL that is bundled with LISTSERV Maestro as the internal database is the generic Linux version This generic version requires that certain shared libraries are already installed on the Linux system If in doubt check www mysql com for details When installing the components on their hosts the following restrictions must be met e 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 LISTSERV Maestro
33. r s Manual for details Note Setup will query only those settings which it cannot 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 LISTSERV Maestro 6 0 10 2 Installation Manual for Linux 2 Upgrading an Existing Installation To upgrade an existing installation of LISTSERV Maestro to the current version 6 0 10 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 self extracting setup file LISTSERVMaestro6 0 10 linux x86 bin for 32 bit or LISTSERVMaestro6 0 10 linux x64 bin for 64 bit If necessary you may need to perform a chmod on the file first to make it executable Important Do not upgrade an existing 64 bit installation with the 32 bit version or vice versa During execution the self extracting setup will create a temporary folder in the current directory This folder will automatically be removed once setup completes Before you actually perform the upgrade please see Appendix C for more details about Linux specific installation issues Once started the setup wizard will guide you through all the necessary upgrade steps When it queries you for th
34. roups empty To configure the default tracking URL Select Global Settings gt Maestro User Interface gt Default URL Settings Then enter the Default Tracking URL on the settings page To configure the tracking URL of a specific account On the Accounts and Identities page click on the account then select User Account gt URL Settings Then enter the Tracking URL on the settings page To configure the tracking URL of a specific group On the Accounts and Identities page click on the group then select Group gt URL Settings Then enter the Tracking URL on the settings page The tracking URL consists of the protocol hostname and HTTP port the port can be omitted if it is the default port for the given protocol For example http www mycompany com https www mydomain com http www sample net 8080 Note In a proxy environment the Tracking URL as seen by external clients may be different from what the actual Maestro Tracker component server uses internally Please see the LISTSERV Maestro Administrator s Manual for details about a proxy environment or when using host name aliases 5 2 1 3 User Accounts 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 e
35. s 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 1 1 Install LISTSERV LISTSERV Maestro 6 0 10 requires an instance of LISTSERV For a new installation LISTSERV 16 0 2014b or later is recommended 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 2014b with the corresponding LISTSERV installation package see the LISTSERV installation manual for instructions 1 2 Install External Database optional Only necessary if you do not want to use the internal database that is deployed together with LISTSERV Maestro 6 0 10 an instance of MySQL 5 5 16 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 e Microsoft SQL Server 2000 or later e MySQL 4 1 or later e Oracle 8i or later e IBM DB2 V8 2 or later 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
36. s 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 values for certain 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 5 1 First Steps with the LISTSERV Maestro Sample Account 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 a
37. sable 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 5 3 2 Grant Right to Administer Recipient Datasets 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 The applicable right may also be inherited from the default level if not overridden on the individual account group level LISTSERV Maestro 6 0 10 10 Installation Manual for Linux To define the right for a specific account On the Accounts and Identities page click on the account then select User Account gt 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 5 3 3 Define Database Server in LISTSERV 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 tabl
38. sers from the Internet even through a firewall e 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 e 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 Appendix B The Internal MySQL Database By default LISTSERV Maestro 6 0 10 is installed with an instance of MySQL 5 5 16 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 at a later time 7 The MySQL version that is included with LIST
39. tion and for more details If you have already supplied defaults for some of the settings during the installation process itself then some of the configuration steps below are no longer necessary LISTSERV Maestro 6 0 10 6 Installation Manual for Linux 5 2 1 Maestro User Interface Runtime Settings 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 e 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 e 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 gt 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 e 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
Download Pdf Manuals
Related Search