Installing CRX with an Application Server - docs.day.com

Installing CRX with an Application Server
Installing CRX with an Application Server
Overview / CRX / CRX 2.2 / How To /
This section tells you how to install CRX 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 (and referenced in) the installation procedures for:
• Websphere v6.1
• Weblogic v10.3
• Tomcat v6
• JBoss v4 or v5
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 CRX quickstart file is:
crx-<version>-<edition>.jar.
For example, crx-2.1.0-enterprise.jar, where 2.1.0 would be the <version> and enterprise the
name of the <edition>. The version might also include a datestamp.
Be sure to substitute the version and name of your edition of CRX wherever appropriate.
GENERIC PROCEDURE FOR INSTALLING CRX WITH AN APPLICATION
SERVER
This section provides generic information about installing CRX 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 CRX as follows:
1.
Unpack the quickstart jar file without starting the installation.
To do this start the CRX Quickstart jar with the option -unpack by typing, for example:
java -jar crx-<version>-<edition>.jar -unpack
This creates a folder <crx-installation-dir>/crx-quickstart containing the files and folders used for
installation.
NOTE
You must start CRX from the command line.
If you open the jar file directly, you activate the Quickstart installation and start the
server.
2.
Stop your web application server (if running).
3.
Copy the following two jar files:
4.
5.
• <crx-install-dir>/crx-quickstart/server/lib/container/jcr-2.0.jar
• <crx-install-dir>/crx-quickstart/server/lib/container/crx-shared.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 it with the context path /crx
• Launchpad webapp: crx-launchpad.war
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 1
Created on 2015-01-08
Installing CRX with an Application Server
It is recommended to deploy with the context path /
These can be found in <crx-installation-dir>/crx-quickstart/server/webapps
NOTE
JBoss v5 - see the workaround required.
NOTE
If you decided to deploy any of the applications with a non-recommended context path,
you need to follow these additional configuration steps.
NOTE
6.
Websphere - see the additional step of Configuring the default JDK.
7.
8.
9.
Start the two applications.
Register your CRX license:
1. Access your CRX installation:
http://<server>:<port>/crx/index.jsp
2. Enter the serial number.
Follow the Generic Procedure for Installing Content Packages to install CRX's initial content package
(using the CRX Package Manager to Upload then Install the package):
<crx-install-dir>/crx-quickstart/repository/install/crx-initial-content-<version>.zip
Without this package, the CRX Launchpad instance is not a fully functional sling instance as it misses
application bundles, initial content, welcome page and other elements.
GENERIC PROCEDURE FOR INSTALLING CONTENT PACKAGES
After you have installed CRX, you should install the CRX initial content package first. That ensures that
your CRX instance is fully functional (welcome page, example applications, support for CRX IDEs, etc). The
content package is available in the following location:
• <crx-install-dir>/crx-quickstart/repository/install/crx-initial-content-<version>.zip.
After that, you can install any additional content packages you may have; for example, your Sling application,
project content, amongst others.
To install content packages follow the procedure below:
NOTE
Starting and stopping web applications is specific to your application server.
Please refer to the documentation of the individual application server.
1.
2.
3.
4.
5.
Stop the following web application in your application server:
• /
(the CRX Launchpad 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 CRX 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 application)
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 2
Created on 2015-01-08
Installing CRX with an Application Server
6.
Confirm the operation of CRX.
NOTE
If you experience any problems, please restart CRX to ensure that all bundles are
correctly started.
INSTALLING CRX WITH WEBSPHERE V6.1
To install CRX with WebSphere v6.1 you:
• install Websphere
• install CRX
• configure the default JDK
Installing CRX
After installing WebSphere install CRX according to the generic procedure.
NOTE
Before registering your CRX license perform the additional step of Configuring the default JDK
according to the procedure.
Configuring 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.
Use the following steps to configure the source level as 1.5:
1.
Within the deployed crx-explorer_crx.war, edit ibm-web-ext.xmi and add the following configuration
parameter to specify the JSP engine:
<jspAttributes xmi:id="JSPAttribute_1225281520121" name="jdkSourceLevel" value="15"/>
NOTE
Note: The integer (n) referenced in JSPAttribute_<n> must be unique within the file.
2.
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.
INSTALLING CRX WITH WEBLOGIC V10.3
To install CRX with WebLogic 10.3 you:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 3
Created on 2015-01-08
Installing CRX with an Application Server
•
•
•
•
install WebLogic
configure the server locale
enable Basic Authentication Headers (to allow user authentication in CRX)
install CRX
NOTE
CRX deployment on an Oracle WebLogic application server requires version 10.3.0 or version
10.3.3 or later. A CRX deployment in WebLogic versions 10.3.1 or 10.3.2 does not work.
Configuring the Server Locale
After installing WebLogic v10.3 (for use with CRX), 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:
1.
2.
3.
Open the Control Panel.
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:
1.
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:
1.
2.
3.
Open <WebLogic-installation-dir>/user_projects/domains/<myDomain>/config/config.xml.
Locate the element <security-configuration>.
Add the following child element to it:
<enforce-valid-basic-auth-credentials>
false
</enforce-valid-basic-auth-credentials>
4.
5.
If you have already started WebLogic then you will need to restart it now.
After Installation has finished add the following additional property to the sling.properties file:
• Stop the CRX 2.3 web application in the WebLogic /console gui
• Go to the ${sling.home} folder and add the follwoing to the the sling.properties file:
sling.bootdelegation.weblogic.xml=weblogic.xml.*
•
(Assure there are no trailing whitespaces!)
Start web application again
Installing CRX
After installing WebLogic install CRX according to the generic procedure.
INSTALLING CRX WITH TOMCAT V6
To install CRX with Tomcat v6 you:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 4
Created on 2015-01-08
Installing CRX with an Application Server
•
•
•
install Tomcat
configure Tomcat access accounts
install CRX
Configuring Tomcat access accounts
After installing Tomcat v6, you must configure the access accounts as Tomcat enables neither admin nor
manager access at installation. This must be manually enabled:
1.
2.
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>
Installing CRX
After installing Tomcat install CRX according to the generic procedure.
INSTALLING CRX WITH JBOSS V4 OR V5
To install CRX with JBoss v4 or v5 you:
• install JBoss
• install CRX
• configure the JBoss Server Login Module
Installing CRX
After installing JBoss install CRX according to the generic procedure.
NOTE
When deploying the web applications in JBoss 5, there is a conflict between xml-apis and
xercesImpl bundled with Jackrabbit and Jboss libraries.
Therefore, the following workaround is required:
1. Before deploying the CRX war it should be unpacked.
2. WEB-INF/lib/{xml-apis-1.3.x.jar,xercesImpl-2.8.x.jar} removed.
3. Then repacked and deployed as specified.
Configuring the JBoss Server Login Module
By default JBoss' default login configuration attempts to authenticate users against a list of users in the
users.properties file. You must configure JBoss as follows to let login attempts by unknown users pass to the
web application (CRX Explorer). The web application then processes authentication by itself.
1.
2.
Open JBOSS_HOME/server/default/conf/login-config.xml for editing.
In the section application-policy name="other" (at the bottom of the file) add the attribute
unauthenticatedIdentity="nobody" to the login-module entry.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 5
Created on 2015-01-08
Installing CRX with an Application Server
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).
1.
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 the installation is operational (all examples on the basis that the
instance is running on port 8080 of the localhost, CRX is installed under /crx, and Launchpad under /):
•
•
•
•
http://localhost:8080/crx/
The CRX administration Console.
http://localhost:8080/crx.html
The CRX Welcome screen.
http://localhost:8080/crx/de/
The CRXDE Lite console.
http://localhost:8080/system/console
The Apache Felix Web Console.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 6
Created on 2015-01-08