|
Installing CQ5 with an Application Server
This section tells you how to install CQ with an application server. Consult the Supported Platforms section to see the specific support levels provided for the individual application servers.
The generic procedure details the actions common to the installation procedures for:
After installation you can install further content packages if required.
Consult the appropriate application server documentation for more information on installing web applications.
Note
The naming convention used here for the CQ quickstart file is:
cq-wcm-quickstart-<version>.jar.
For example, cq-wcm-quickstart-5.3.jar, where 5.3 would be the <version>.
Be sure to substitute the version of your edition of CQ wherever appropriate.
Generic Procedure for Installing CQ with an Application Server
This section provides generic information about installing CQ with an application server.
The procedure (with minor deviations) is used for all web servers and is referenced from the instructions provided for the individual web servers.
After having installed the application server, install CQ as follows:
Open the directory where you want to install CQ. This will be known as <cq-installation-dir>. Copy the installation jar file into this directory.
Unpack the quickstart jar file without starting the installation (or server).
To do this start the CQ Quickstart jar with the option -unpack by typing, for example:
java -jar cq-wcm-quickstart-<version>.jar -unpack
This creates a folder <cq-installation-dir>/crx-quickstart containing the files and folders used for installation.
Note
You must start CQ from the command line.
If you open the jar file directly, you activate the Quickstart installation and start the server.
Stop your web application server (if running).
Copy the following jar file:
- <cq-installation-dir>/crx-quickstart/server/lib/common/cq-shared-libs-<version>.jar
to the application server folder that holds the shared libraries (shared by all applications deployed to the server).
Restart your web application server.
-
Deploy the following web applications:
- CRX webapp: crx-explorer_crx.war
It is recommended to deploy this with the context path /crx
- Launchpad webapp: crx-launchpad.war
It is recommended to deploy this with the context path /
- CRXDE webapp (if required) crx-de_crxde.war
It is recommended to deploy this with the context path /crxde
These can be found in:
<cq-installation-dir>/crx-quickstart/server/webapps
Note
JBoss:
- After deploying, copy the two war files to:
<JBoss-installation-dir>/server/default/deploy
- Supports Hot Deployment, if hot deployment is enabled then you can simply copy the two war files to:
<JBoss-installation-dir>/server/default/deploy
If hot deployment is disabled then you will need to restart JBoss after copying the files to the deploy directory.
-
Start the web applications.
Register your CRX license:
- Access your CRX installation:
http://<server>:<port>/crx/index.jsp
- Enter the serial number.
Edit the workspace configuration file to prepare for package installation:
- Open the following file for edit:
<cq-installation-dir>/crx-quickstart/repository/workspaces/workspace.xml
- Locate the <SearchIndex> parameter section.
- Add:
<param name="indexingConfiguration" value=""/>
to the <SearchIndex> parameter section.
Follow the Generic Procedure for Installing Content Packages to install the:
- CQ initial content package:
<cq-install-dir>/crx-quickstart/repository/install/cq-content-<version>.zip
- CQ documentation package (optional):
<cq-install-dir>/crx-quickstart/repository/install/cq-documentation-<version>.zip
using the CRX Package Manager to Upload, then Install the packages.
-
You can now configure CQ according to your requirements.
Generic Procedure for Installing Content Packages
After you have installed CQ, you should install the CQ initial content and documentation packages before proceeding to other tasks. The content package ensures that your CQ instance is fully functional (welcome page, example applications, support for CRX IDEs, etc). The documentation package is optional. The packages are available in the following location:
- <cq-install-dir>/crx-quickstart/repository/install/
- cq-content-<version>.zip
- cq-documentation-<version>.zip
After installing these, you can install any additional content packages that you may have; for example, your Sling application, project content and many others.
To install the packages follow the procedure below:
Note
Starting and stopping web applications is specific to your application server.
Please refer to the documentation of the specific application server.
Stop the following web application in your application server:
- / (the CRX launchpad web application)
Navigate to the Package Manager in CRX:
- http://<server>:<port>/crx/packmgr/index.jsp
Log in to the appropriate workspace (usually the default workspace, crx.default).
Use the CRX Package Manager to Upload then Install the CQ package(s).
Alternatively, you can use Package Share to access and download packages to your local instance and then install them.
Start the following web application in your application server:
- / (the CRX launchpad web application)
Confirm the operation of CQ.
Note
If you experience any problems, please restart both web applications to ensure that all bundles are correctly started.
Generic Procedure to Define the Run Mode for an Instance
You must configure your instance to start in the required run mode. This steers functionality such as replication from an author instance of CQ5.
Stop the crx launchpad (/) web application.
Open the file:
<cq-installation-dir>/crx-quickstart/launchpad/sling.properties
Add the following properties, appropriate to your instance:
- for an Author environment:
sling.jcrinstall.folder.name.regexp = .*/(install|config)(.author)?$ sling.run.modes = author
- for a Publish Environment
sling.jcrinstall.folder.name.regexp=.*/(install|config)(.publish)?$ sling.run.modes = publish
Restart the crx launchpad (/) web application.
To install CQ5 with the WebSphere 6.1 server, you need to complete the following tasks:
- Install WebSphere and disable basic authentication.
- Install and configure CQ.
The installation process differs slightly according whether you want to:
- install the author and publish instances under separate web application servers (standard practice)
- install the author and publish instances under the same web application server (often required for a test or demo environment)
The differences are highlighted below.
Install WebSphere v6.1 and disable basic authentication
To install WebSphere and disable basic authentication:
-
Login to the IBM web console at:
http://<server>:<port>/ibm/console
For example, http://localhost:9060/ibm/console, where port 9060 is the default port number.
Click Application Servers, then server1, then Web services: Default bindings for Web services security, then Login mappings.
Select the BasicAuth checkbox and then click Delete.
-
WebSphere - One CQ Instance with One Web Application Server
Install CQ, using content packages, according to the generic procedures.
Configure the Default JDK
WebSphere v6.1 uses JDK 1.5. By default the SAMLv2 JSP JDK source level uses JDK 1.3. As the SAMLv2 sample configuration uses the JDK 1.5 syntax, running it with the default source level will not work.
The following steps should be used to configure the source level as 1.5:
-
Open ibm-web-ext.xmi for edit.
This is found in:
<WebSphere-installation-dir>/profiles/<profilename>/config/cells/<cellname>/applications/crxauthor_war.ear/deployments/crxauthor_war/crxauthor.war/WEB-INF
Add the following configuration parameter to specify the JSP engine:
<jspAttributes xmi:id="JSPAttribute_1225281520121" name="jdkSourceLevel" value="15"/>
Repeat for crx-launchpad.war.
Note
The default configuration directory for the web module is:
<WebSphere-installation-dir>/profiles/<profilename>/config/cells/<cellname>/applications/<enterpriseappname>/deployments/<deployedname>/<webmodulename>/
If you have already checked the option Use Binary Configuration the files are extracted to the following directory, where they can be edited:
<WebSphere-installation-dir>/profiles/profilename/installedApps/nodename/enterpriseappname/webmodulename/
Where <WebSphere-installation-dir> is the root directory of the web application server installation.
-
Websphere - Author and Publish under One Web Application Server
To unpack CQ, create the correct folders and deploy the shared libraries:
Open the directory where you want to install CQ. This will be known as <cq-installation-dir>. Copy the installation jar file into this directory.
Unpack the quickstart jar file without starting the installation (or server).
To do this start the CQ Quickstart jar with the option -unpack by typing, for example:
java -jar cq-wcm-quickstart-<version>.jar -unpack
This creates a folder <cq-installation-dir>/crx-quickstart containing the files and folders used for installation.
Note
You must start CQ from the command line.
If you open the jar file directly, you activate the Quickstart installation and start the server.
Rename the newly created folder to crx-quickstart-author.
Copy this folder and name the new instance crx-quickstart-publish.
You should now have two folders, crx-quickstart-author and crx-quickstart-publish.
Copy the following jar file:
- <cq-installation-dir>/crx-quickstart-author/server/lib/common/cq-shared-libs-<version>.jar
to the application server folder that holds the shared libraries (shared by all applications deployed to the server).
Install the Author Instance
To install the author instance, we must do the following:
- Adjust JNDI and home paths of the web applications.
- Configure the default JDK.
- Define the run mode.
- Adjust the JNDI name for the CRX sling client repository.
- Install the content packages.
Detailed instructions are provided in the following sections.
Adjust JNDI and home paths of the web applications
To adjust JNDI and home paths of the web applications:
Unpack <cq-installation-dir>/crx-quickstart-author/server/webapps/crx-explorer_crx.war.
Windows:
- Move to <cq-installation-dir>/crx-quickstart-author/server/webapps.
- Rename the crx-explorer_crx.war to crx-explorer_crx.zip.
- Extract crx-explorer_crx.zip to a directory named crx-explorer_crx.
Linux (command line):
- cd <cq-installation-dir>/crx-quickstart-author/server/webapps
- mkdir crx-explorer_crx
- cd crx-explorer_crx
- jar -xvf ../crx-explorer_crx.war
Repeat for
<cq-installation-dir>/crx-quickstart-author/server/webapps/crx-launchpad.war.
In the WEB-INF directory of the unpacked crx-explorer_crx.war, edit web.xml:
- Change repository-home from crx-quickstart/repository to crx-quickstart-author/repository (Repository Servlet).
- Change repository-name from crx to crx-author (Repository Servlet).
- Change repository-name from virtual-crx to virtual-crx-author (JCR Explorer Servlet).
- Change explorer-home from crx-quickstart/repository to crx-quickstart-author/repository (JCR Explorer Servlet).
- Change the home parameter from crx-quickstart to crx-quickstart-author (WebDav Server Servlet).
In the same directory, edit the repository-template.xml:
- Add the defaultVirtualRepository parameter (shown below) to the VirtualRepositoryModule configuration:
<Module class="com.day.crx.mount.virtual.VirtualRepositoryModule"> <param name="defaultVirtualRepository" value="virtual-crx-author" /> ... </Module>
Again in the same directory, edit log4j.xml to change the File parameter of the error and transaction log from crx-quickstart/... to crx-quickstart-author/....
In the WEB-INF directory of the unpacked crx-launchpad.war, edit web.xml:
- Change repositoryName from crx to crx-author.
- Change sling.home from crx-quickstart/launchpad to crx-quickstart-author/launchpad.
Repackage the crx-explorer_crx.war file:
Windows:
- Select all files in the crx-explorer_crx directory.
- Select Send To -> Compress (zipped) Folder.
You have now created a zip file in the crx-explorer_crx directory.
- Rename the generated zip file to crx-explorer_crx.war.
Linux (command line):
- jar -cvf crx-explorer_crx.war -C crx-explorer_crx/ .
Repeat accordingly to repackage crx-launchpad.war.
Rename crx-explorer_crx.war to crx-author.war.
Rename crx-launchpad.war to author.war.
Deploy both war applications inside the WebSphere console at:
http://<server>:<port>/ibm/console
For example, http://localhost:9060/ibm/console, where 9060 is the default port.
Configure the Default JDK
Configuring the Default JDK is done with the same procedure as for the standard installation of one CQ instance under one web application server (using crx-quickstart-author as appropriate).
Adjust the JNDI name for the CRX sling client
To adjust the JNDI name for the CRX sling client:
Open the Apache Felix Configuration console:
http://<server>:<port>/author/system/console/configMgr
For example, http://localhost:9080/author/system/console/configMgr, where 9080 is the default port.
Select the CRX Sling Client Repository and change the Repository Name from virtual-crx to virtual-crx-author.
Install the content package
To install the content package:
Open
http://<server>:<port>/crx-author/
Or the location of your CRX installation; for example, http://localhost:9080/crx-author/, where 9080 is the default port.
-
Stop the following web application in your application server:
- / (the CRX launchpad web application)
Open the CRX Package Manager.
Upload and install:
cq-content-<version>.jar
from:
<cq-installation-dir>/crx-quickstart-author/repository/install/
Open the CRX Content Explorer and change the virtual repository from virtual-crx to virtual-crx-author below /etc/virtual-repository.
Start the following web application in your application server:
- / (the CRX launchpad web application)
Confirm the operation of CQ.
Note
If you experience any problems, please restart both web applications to ensure that all bundles are correctly started.
Install the Publish Instance
To install the publish instance, repeat all the steps described in Installing the Author Instance, replacing author with publish.
Note
CQ 5.3 deployment on an Oracle WebLogic application server requires version 10.3.0 or version 10.3.3 or later. A CQ 5.3 deployment in WebLogic versions 10.3.1 or 10.3.2 does not work.
To install WebLogic v10.3, you need to perform the following tasks:
- Install the WebLogic server and create a domain.
- Prepare the WebLogic server by:
- configuring the server locale
- enabling basic authentication headers
- Unpack, install and configure CQ.
- Deploy CRXDE Lite.
- Modify WebLogic optimization so CQ login succeeds.
- Define the Run Mode for your instance.
To install the WebLogic server and create a domain:
Download and install the WebLogic server software.
Note
The installation folder is referred to as <WebLogic-installation-dir>.
If you do not want to use the default domain, then create a new domain; for example, <myDomain>:
- navigate to Oracle Weblogic - WebLogic Server - Tools - Configuration Wizard.
- The domain is created in:
<WebLogic-installation-dir>/user_projects/domains/<myDomain>
Note
This directory is referred to as <myDomain-dir> in the following sections.
Configure the Server Locale
After installing WebLogic v10.3 (for use with CQ5), you must set the server locale to en_US to avoid errors such as:
java.lang.IllegalArgumentException: Bad date header: 'We 16:34:28 GMT'
These can occur when, for example, requesting a resource such as /libs/widgets/0.gif.
To configure the server locale on Microsoft Windows:
-
Open Regional and Languages Options.
In the Regional Options tab, for Standards and formats select English (United States).
To configure the server locale on Linux or Unix:
Set the environment variable LANG to en_US.
Enable Basic Authentication Headers
To enable out-of-the-box authentication of users in CRX, authentication by the application server must be switched off:
Open:
<WebLogic-installation-dir>/user_projects/domains/<myDomain>/config/config.xml.
Locate the element <security-configuration>.
Add the following as the last child element:
<enforce-valid-basic-auth-credentials>
false
</enforce-valid-basic-auth-credentials>
If you had already started WebLogic then you will need to restart it.
Create folders for holding the web applications deployment plans:
This is recommended if you want to change the context paths of the web applications:
Create the directories (the names are suggestions):
- <myDomain-dir>/packages/crx-explorer
- <myDomain-dir>/packages/crx-launchpad
- <myDomain-dir>/packages/crxde
to hold the war files and the deployment plan files.
Copy the files:
- crx-explorer_crx.war to <myDomain-dir>/packages/crx-explorer
- crx-launchpad.jar to <myDomain-dir>/packages/crx-launchpad
- crxde.war file to <myDomain-dir>/packages/crxde
Install CQ, using content packages, according to the generic procedures.
If you have changed the context paths of either web application, then to use CRXDE Lite with WebLogic v10, you need to adapt the context path of crx-launchpad and crx-explorer_crx.
To do this, edit the web.xml file of the CRXDE Lite web application and insert these paths into the <context-param> section:
<context-param> <param-name>repository.ctx.path</param-name> <param-value>/crx</param-value> </context-param> <context-param> <param-name>launchpad.ctx.path</param-name> <param-value>/</param-value> </context-param>
Note
If you have upgraded the CRX (within CQ) to 2.1 this step is not needed as CRXDE Lite is embedded in the CRX web application.
Modify WebLogic optimization
By default WebLogic optimization is enabled. This does not allow you to log into the CQ Websites page and returns a ClassNotFoundException error, even though the class can be found in the stacktrace.
To modify the WebLogic optimization so that CQ login succeeds:
Open <myDomain-dir>/packages/crx-launchpad/plan/WEB-INF/weblogic.xml.
Add the following line as a child entry of <container-description>:
<optimistic-serialization>true</optimistic-serialization>
Perform the same change for crx-explorer
(<myDomain-dir>/packages/crx-explorer/plan/WEB-INF/weblogic.xml).
Restart both web applications.
Log into CQ and access the Websites page to ensure that everything operates as expected.
To install Tomcat v6, you need to perform the following tasks:
- Install the Tomcat server.
- Configure the Tomcat access accounts.
- Unpack, install and configure CQ.
Configure Tomcat access accounts
Tomcat enables neither admin nor manager access at installation.
Therefore you have to manually edit tomcat-users.xml to allow access for these accounts:
Navigate to the Tomcat configuration folder.
Edit tomcat-users.xml to include access for admin and manager. The configuration should look similar to the following example:
<?xml version='1.0' encoding='utf-8'?> <tomcat-users> <role rolename="manager"/> <role rolename="tomcat"/> <role rolename="admin"/> <role rolename="role1"/> <user username="both" password="tomcat" roles="tomcat,role1"/> <user username="tomcat" password="tomcat" roles="tomcat"/> <user username="admin" password="admin" roles="admin,manager"/> <user username="role1" password="tomcat" roles="role1"/> </tomcat-users>
Install CQ, using content packages, according to the generic procedures.
To install JBoss, you need to perform the following tasks:
- Follow the JBoss documentation on how to install a default instance of JBoss v4 Application Server.
- Unpack, install and configure CQ.
- Configure the JBoss Server Login Module.
Install CQ, using content packages, according to the generic procedures. and the additional steps required for JBoss.
Note
The data directories of your installation now can be found under the working directory of your JBoss Application Server:
(usually the working directory is <JBoss-installation-dir>/bin/crx-quickstart)
- CRX Repository Data: crx-quickstart/repository
- Launchpad / Apache Felix Data: crx-quickstart/launchpad
- Logs: crx-quickstart/logs, crx-quickstart/launchpad/logs
Additional Installation Steps required for JBoss
Unpack <cq-installation-dir>/crx-quickstart/server/webapps/crx-explorer_crx.war.
Windows:
- Move to <cq-installation-dir>/crx-quickstart/server/webapps.
- Rename the crx-explorer_crx.war to crx-explorer_crx.zip.
- Extract crx-explorer_crx.zip to a directory named crx-explorer_crx.
Linux (command line):
- cd <cq-installation-dir>/crx-quickstart/server/webapps
- mkdir crx-explorer_crx
- cd crx-explorer_crx
- jar -xvf ../crx-explorer_crx.war
In the WEB-INF directory, open log4j.xml.
Disable console logging in the CRX web application:
- Remove or comment out the line
<appender-ref ref="console"/>
from the Loggers section of the file.
- Save your changes and exit the file.
Delete the following files from the WEB-INF/lib folder:
- jcr-2.0.jar
- jackrabbit-api-2.0.0.jar
- day-commons-naming-1.1.2.jar
- crx-api-2.0.0.jar
- log4j-1.2.14.jar
- xml-apis-1.3.04.jar
- xercesImpl-2.9.0.jar
Repackage the crx-explorer_crx.war file:
Windows:
- Select all files in the crx-explorer_crx directory.
- Select Send To -> Compress (zipped) Folder.
You have now created a zip file in the crx-explorer_crx directory.
- Rename the generated zip file to crx-explorer_crx.war.
Linux (command line):
- cd <cq-installation-dir>/crx-quickstart/server/webapps
- jar -cvf crx-explorer_crx.war -C crx-explorer_crx/ .
Redefining where the Web Applications Store their Data
The procedure above uses the default configuration for the crx and launchpad web application data directories. This means that the data directory crx-quickstart will be created under the JBoss working directory (usually <Jboss-installation-dir>/bin).
Optionally, you can reconfigure where crx-explorer_crx.war and crx-launchpad.war store their data:
Configure the launchpad web application:
- Unpack crx-launchpad.war.
- Edit WEB-INF/web.xml.
- Change sling.home from crx-quickstart/launchpad to the required path (where you would like to store the Apache Felix data).
- Repack crx-launchpad.war.
Configure the crx-explorer web application:
- Unpack crx-explorer_crx.war.
- Edit WEB-INF/web.xml.
- Change repository-home from crx-quickstart/repository to the required path (where you want to store the CRX repository data - Repository Servlet).
- Change explorer-home from crx-quickstart/repository to the required path (JCR Explorer Servlet).
- Change the home parameter from crx-quickstart to the required path (WebDav Server Servlet).
- Repack crx-explorer_crx.war.
Caution
It is not recommended to configure these data paths to point to a network share directory such as an NFS or Windows Share (CIFS).
If you would like to store data on a network share, then please refer to the CRX clustering documentation for information about how you can configure the CRX shared data paths (the clustering documentation also applies to single crx instances).
Configure the JBoss Server Login Module
The default login configuration of JBoss attempts to authenticate users against a list of users in the users.properties file.
You must configure JBoss to allow login attempts by unknown users to pass to the web application (CRX Explorer). The web application will then process authentication.
The configuration is made as follows:
Open for editing:
<JBoss-installation-dir>/server/default/conf/login-config.xml
Delete the <application-policy name="other"> section (it can be found at the bottom of the login-config.xml file):
<application-policy name="other"> ... </application-policy>
Additional Configuration Required when not using Default Contexts
Day recommends installing the product web applications under the default contexts (/ and /crx). If there are reasons why this is not possible (operations, deployment, etc), you can also deploy the web applications under other contexts.
You will need the following additional configuration step(s) if you do not use the default contexts (/ and /crx) for the webapps. The description below assumes that crx-launchpad.war is deployed into /launchpad, and crx-explorer_crx.war into /daycrx).
The action to be taken depends on whether you will be using CRXDE or CRXDE Lite:
- CRXDE Lite:
Edit the configuration file WEB-INF/web.xml, of the CRX web application deployed to your application server. Configure the required launchpad context in the JCRExplorer servlet section:
<init-param> <param-name>launchpad.ctx.path</param-name> <param-value>/launchpad</param-value> <description>Context path of the launchpad</description> </init-param>
The location of the WEB-INF/web.xml configuration file is specific to the application server and its configuration, please consult the relevant third-party documentation.
- CRXDE:
Reconfigure the URL for the CRX server endpoint. See Changing the CRX Server Endpoint for instructions.
You have to log in to CRXDE with the URL appropriate to your launchpad web application; for example, http://<server>:<port>/launchpad
Verifying the Installation
The following links can be used to verify that your installation is operational (all examples are on the basis that the instance is running on port 8080 of the localhost, that CRX is installed under /crx and Launchpad under /):
- http://localhost:8080/libs/cq/core/content/welcome.html
The CQ Welcome screen.
- http://localhost:8080/crx/
The CRX administration Console.
- http://localhost:8080/crx/de/
The CRXDE Lite console.
- http://localhost:8080/system/console
The Apache Felix Web Console.
|
|
Forgotten your password? Reset the password here.
Note: Customers with DayCare user accounts need to create a new account for use on day.com.