Installing SDL LiveContent Reach with a third-party Web application server
This procedure covers installing SDL LiveContent Reach if you want to use a third-party web application server, such as Apache Tomcat.
Before you begin
Before installing, see SDL LiveContent Reach Platform Requirements to ensure you have supported hardware and software.
About this task
- The Installer installs the SDL LiveContent Reach application version.
Note: The Tomcat service must be stopped before running the installer because SDL LiveContent Reach application components will be active (such as .jar files), as the OS will not allow a new file to overwrite a file that is actively executing.
- The setup script updates the XML database so it can work correctly with that SDL LiveContent Reach application version.
Note: The Tomcat service must be started before running setup because it updates the XML database itself. If the service is not running, there is no connection to the available database.
If you do not wait long enough between starting the Tomcat service and running setup.bat, you may get errors.
Procedure
- Obtain a license file from SDL customer support to run SDL LiveContent Reach. If you do not have a license file, see Manually installing a license file.
- Log on to the server as a user with administrative privileges.
- Verify that you have the correct version of the Java JDK: at a command prompt, type java -version.
See SDL LiveContent Reach Platform Requirements for the supported version.
- Download the SDL LiveContent Reach installation executable through your customer FTP account, provided by SDL customer support.
- Stop the Tomcat Service.
- To start the installation, run the installation executable.
- For Windows, navigate to the folder where you downloaded the installation package, and then right-click on the installation executable and choose Run as administrator.
- For Linux, navigate to the folder where you downloaded the installation package, and then enter ./install.bin. The installation package may have a different filename, which includes its version number.
- Click Next in the Introduction panel.
- In the License Agreement panel, read the license terms, click I accept the terms of the License Agreement, then click Next.
- In the Choose Web Application Deployment Folder panel, click through the directory structure path to your chosen web application server's deployment folder.
For example, on Apache Tomcat, the deployment folder is ApacheTomcat_home/webapps where ApacheTomcat_home is the directory where Tomcat is installed.
- In the Choose Web App Context panel, choose the application context name.
This appears as the last part of the URL. In a content distribution model, the distribution server and its content delivery servers must all have the same context.For example, given the URL https://neptune:8443/LiveContent, LiveContent is the context.
- In the Choose Backup Schedule panel, select the frequency with which SDL LiveContent Reach will back up the XML database, and then click Next.
- In the Install License panel, click Yes.
If you do not have a license file yet, you can click No and install the license file later.
- In the Choose a License File panel, locate the license file and then click Next.
The installation program installs the file to C:\Program Files\XyEnterprise\SDL_License (Windows) or /opt/XyEnterprise/SDL_License (Linux).
- Review the settings in the Pre-Installation Summary panel and then click Install.
- In the Install Complete panel, click Done. A log file of the installation process is written to LiveContent_home/WEB-INF/logs.
- Optionally, configure Apache Tomcat to support UTF-8 input (for user names and searches).
In the
TOMCAT_HOME/conf/server.xmlfile, add these attributes to all<Connector>elements within the configuration:useBodyEncodingForURI="true"URIEncoding="UTF-8"
For example:<Connector port="8443" protocol="HTTPS/1.1" connectionTimeout="20000" redirectPort="8443" useBodyEncodingForURI="true" URIEncoding="UTF-8"/> - Restart the web application server. For example, if you are using Apache Tomcat, restart the Apache Tomcat service.
- At a command prompt (Run as Administrator), in the LiveContent_home/WEB-INF/ directory, do one of the following:
For a Windows secure installation, type
setup.bat -jh path_to_java -Dlc.port=port# -Dlc.protocol={http,https} -Dlc.host=fully.qualified.domain.name installExample:
setup.bat -Dlc.port=8443 -Dlc.protocol=https -Dlc.host=wkqasv0804.global.sdl.corp installwhere
JAVA_HOMEis set as follows:C:\Users\Administrator>set JAVA_HOME=C:\Program Files\Java\jdk7
For a Windows non-secure installation, type
setup.bat -jh path_to_java -Dlc.port=port# -Dlc.host=fully.qualified.domain.name installExample:
setup.bat -Dlc.port=8080 -Dlc.protocol=http -Dlc.host=wkqasv0804.global.sdl.corp installwhere
JAVA_HOMEis set as follows:C:\Users\Administrator>set JAVA_HOME=C:\Program Files\Java\jdk7
For a Linux secure installation, type
setup.sh -jh path_to_java -Dlc.port=port# -Dlc.protocol={http,https} -Dlc.host=fully.qualified.domain.name installExample:
setup.sh -Dlc.port=8443 -Dlc.protocol=https -Dlc.host=wkqasv0804.global.sdl.corp installwhere
JAVA_HOMEis set as follows:set JAVA_HOME=/usr/Java/jdk7
For a Linux non-secure installation, type
setup.sh -jh path_to_java -Dlc.port=port# -Dlc.host=fully.qualified.domain.name installExample:
setup.sh -Dlc.port=8080 -Dlc.protocol=http -Dlc.host=wkqasv0804.global.sdl.corp installwhere
JAVA_HOMEis set as follows:set JAVA_HOME=/usr/Java/jdk7
-jh path_to_java Path to where the JDK is installed. See the SDL LiveContent Reach Platform Requirements for supported Java versions. If your path to Java includes spaces, then you must quote the entire path. Note: If your JAVA_HOME environment variable is set to point to the version of Java that you have used for the SDL LiveContent Reach installation, you do not need to include the-jhoption in the command.-Dlc.port# Port number of the SDL LiveContent Reach web application. The port number can be 2 to 5 digits. Typically, Tomcat uses port 8443 for the HTTPS protocol.
-Dlc.protocol Hypertext Transfer Protocol Secure (HTTP). Because this is the default protocol, you do not need to include the
Hypertext Transfer Protocol Secure (HTTPS), a secure communications protocol. You must include the-Dlc.protocolswitch.-Dlc.protocolswitch.-Dlc.context Used to specify a web app context other than the default, which is LiveContent. Include -Dlc.context=/context
If you are unable to run setup.bat (as evidenced by an error in ApacheTomcat_home\logs\urlrewrite.log about an invalid char at index 27), ensure that C:\Windows is included in the
java.library.pathenvironment variable.Running this script completes the installation by initializing the database, and uploading program files and skins to the database. - For Apache Tomcat only, if you wish to be able to control SDL LiveContent Reach from the Tomcat Application Manager interface, you must copy the LiveContent_home/WEB-INF/lib/rlmnum.jar file to ApacheTomcat_home/lib and then stop and restart the Apache Tomcat service.
Note: Typically, num is a date string (for example, rlm923.jar).Tip: If you would like to manage only SDL LiveContent Reach from the Tomcat Web Application Manager, then delete all but the LiveContent directory from the InstallDir\Program Files\Apache Software Foundation\Tomcat 7.0\webapps directory.
- Refer to the third-party web application server documentation for settings to optimize the initial heap size and maximum heap size for Java, based on available RAM. Ensure that the memory settings are valid based on those specified for the database and modify the database memory settings as appropriate. For details, see Changing Database Memory Settings.
For example, in Apache Tomcat you can configure these memory settings using the tomcatversion#w.exe application (for example, tomcat7w.exe).
On the Java tab, you can set these fields:Table 1. On Windows: Initial memory pool 2048 Maximum memory pool 6144 Thread stack size null Note: These settings assume that the Tomcat server has at least 8 GB of system memory.On Linux:xpplinux5sqa-root 114 > more setenv.sh export JAVA_HOME="/usr/java" export JAVA_OPTS="-Xms2048m -Xmx6144m" xpplinux5sqa-root 115 > pwd /usr/app/apache-tomcat-7.0.23/bin - Specify the Tomcat session timeout override for SDL LiveContent Reach sessions created by SDL LiveContent Architect publish tasks.
The Tomcat web application server has a timeout setting for each SDL LiveContent Reach session. When user inactivity is detected in SDL LiveContent Reach, a publish process may be terminated based on Tomcat's session timeout. Tomcat's session timeout can be overridden for publishing by adding the
pub.session.timeoutconfiguration item, so a long publish will not be interrupted.- From the Review and Collaboration landing page, click Manage Application > Global Config.
- In the right pane, under Customized Config, click Add Item.
- In the Name field, enter
pub.session.timeout - In the Value field, enter a timeout value in minutes.
- Click Save.
- Specify the Tomcat session timeout override for all SDL LiveContent Reach sessions.
Tomcat has a default session timeout of 30 minutes that is imposed on every web application that the Tomcat instance serves. In the case of the SDL LiveContent Reach application, that timeout means that you will have to log in again after 30 minutes of inactivity. You can override the Tomcat session timeout defined in the
$tomcatdir\conf\web.xmlfile by editing theLiveContent_home\WEB-INF\LiveContentSecurity.xmlfile to include asession-timeoutsetting.For example, to set the timeout to 1 hour (60 minutes):<session-config> <session-timeout>60</session-timeout> </session-config>Warning: To avoid many dead sessions that may linger, and possibly degrade performance of Tomcat and/or SDL LiveContent Reach, do not specify a session timeout greater than 2 hours (120 minutes).
What to do next
Once you have completed this procedure, you are ready to perform the post-installation processes.