Application Server Install

You are reading the AEM 6.2 version of Application Server Install.
This documentation is also available for the following versions:  AEM 6.1  AEM 6.0  AEM 5.6.1  AEM 5.6  CQ 5.5  CQ 5.4 

This section tells you how to install Adobe Experience Manager (AEM) with an application server. Consult the Supported Platforms section to see the specific support levels provided for the individual application servers.

The installation steps of the following Application Servers are described:

Consult the appropriate application server documentation for more information on installing web applications, server configurations and how to start and stop the server.

Note

If you are using Dynamic Media in a WAR deployment, please see the dynamic media documentation

General Description

Default behaviour when installing AEM in an Application Server

AEM comes as a single war file to deploy.

If deployed the following will happen by default:

  • the run mode is author
  • the instance (Repository, Felix OSGI environment, bundles etc.) is installed in ${user.dir}/crx-quickstart where ${user.dir} is the current working directory, this path to crx-quickstart is called  sling.home
  • the context root is the war file name e.g : aem-6

Configuration

You can change the default behaviour in the following way:

  • run mode : configure the sling.run.modes parameter in the WEB-INF/web.xml file of the AEM war file before deployment
  • sling.home: configure the sling.home parameter in the WEB-INF/web.xml file of the AEM war file before deployment
  • context root: rename the AEM war file

Publish installation

To get a publish instance deployed you need to set the run mode to publish:

  • Unpack the WEB-INF/web.xml from the AEM war file
  • Change sling.run.modes parameter to publish
  • Repack web.xml file into AEM war file
  • Deploy AEM war file

Installation check

To check if all is installed you can:

  • tail the error.log file to see that all content is installed
  • look in /system/console that all bundles are installed

Two Instances on the same Application Server

For demonstration purposes it can be appropriate to install author and publish instance in one application server. For that do the following:

  1. Change sling.home variable and sling.run.modes variables of the publish instance.

  2. Unpack WEB-INF/web.xml file from the AEM war file.

  3. Change sling.home parameter to a different path, (absolute and relative paths are possible).

  4. Change sling.run.modes to publish for the publish instance.

  5. Repack the web.xml file.

  6. Rename the war files, so they have different  names: e.g. one rename to aemauthor.war and the other to aempublish.war.

  7. Use higher memory settings, e.g. for default AEM instances use e.g.: -Xmx3072m

  8. Deploy the two web applications.

  9. After Deployment stop the two web applications.

  10. In both author and publish instances assure that in the  sling.properties files the property felix.service.urlhandlers=false is set to false (default is that it is set to true).

  11. Start the two web applications again.

Application Servers Installation Procedures

WebSphere 8.5

Before a deployment read the General Description above.

Server Preparation

  • Let Basic Auth Headers pass through:
    • One way to let AEM to authenticate a user is to disable the global administrative security of the WebSphere server, to do so: go to Security -> Global Security and uncheck the Enable administrative security checkbox, save and restart the server.
  • set "JAVA_OPTS= -Xmx2048m"
  • If you want to install AEM using context root = / then you have first to change the context root of the existing Default web application

Deploy AEM web application

  • Download AEM war file
  • Make your configurations In web.xml if needed (see above in the General Description)
    • Unpack WEB-INF/web.xml file
    • change sling.run.modes parameter to publish
    • uncomment sling.home initial parameter and set this path as you need
    • Repack web.xml file
  • Deploy AEM war file
    • Choose a context root (if you want to set the sling run modes you need to select the detailed steps of the deploy wizard, then specify it in step 6 of the wizard)
  • Start AEM web application

JBoss EAP 6.3.0/6.4.0

Before a deployment read the General Description above.

Prepare JBoss server

Set Memory arguments in your conf file(e.g. standalone.conf)

  • JAVA_OPTS="-Xms64m -Xmx2048m"

if you use the deployment-scanner for to install the AEM web application it might be good to increase the deployment-timeout, for that set a deployment-tiimeout attribute in the xml file of your instance (e.g configuration/standalone.xml):

<subsystem xmlns="urn:jboss:domain:deployment-scanner:1.1">
            <deployment-scanner path="deployments" relative-to="jboss.server.base.dir" scan-interval="5000" deployment-timeout="1000"/>
</subsystem>
        

Code samples are intended for illustration purposes only.

Deploy AEM web application

- Upload the AEM web application in your JBoss Administration Console.

- Enable the AEM web application.

Oracle WebLogic 12.1.3/12.2

Before a deployment read the General Description above.

This uses a simple Server Layout with only an Admin Server.

WebLogic Server Preparation

  • In ${myDomain}/config/config.xml add to the security-configuration section:
  • Increase VM Memory settings:
    • open ${myDomain}/bin/setDomainEnv.cmd (resp .sh)search for WLS_MEM_ARGS, set e.g set WLS_MEM_ARGS_64BIT=-Xms256m -Xmx2048m
    • restart WebLogic Server
  • Create in ${myDomain} a packages folder and inside a cq folder and in it a Plan folder

Deploy AEM web application

  • Download AEM war file
  • Put the AEM war file into the ${myDomain}/packages/cq folder
  • Make your configurations In WEB-INF/web.xml if needed (see above in the General Description)
    • Unpack WEB-INF/web.xml file
    • change sling.run.modes parameter to publish
    • uncomment sling.home initial parameter and set this path as you need (see General Description)
    • Repack web.xml file
  • Deploy AEM war file as an Application, (for the other settings use the default settings)
  • The installation can take time...
  • Check that the installation has finished as mentioned above in the General Description (e.g. tailing the error.log)
  • You can change the context root in the Configuration tab of the web application in the WebLogic /console

Tomcat 8/8.5

Before a deployment read the General Description above.

  • Prepare Tomcat Server

    • Increase VM memory settings:
      • In bin/catalina.bat (resp catalina.sh on unix) add the following setting:
      • set "JAVA_OPTS= -Xmx2048m
    • Tomcat enables neither admin nor manager access at installation. Therefore you have to manually edit tomcat-users.xml to allow access for these accounts:
      • 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"/>
        <role rolename="manager-gui"/>
        <user username="both" password="tomcat" roles="tomcat,role1"/>
        <user username="tomcat" password="tomcat" roles="tomcat"/>
        <user username="admin" password="admin" roles="admin,manager-gui"/>
        <user username="role1" password="tomcat" roles="role1"/>
        </tomcat-users>
    • If you like to deploy AEM with context root "/" then you have to change context root of the existing ROOT webapp:
      • Stop and undeploy ROOT webapp
      • Rename ROOT.war folder in tomcat's webapps folder
      • Start webapp again
    • If you install the AEM web application using the manager-gui then you need to increase the maximal size of an uploaded file, as the default only allows 50MB upload size. For that open the web.xml of the manager web application, 
          webapps/manager/WEB-INF/web.xml 
      and increase the max-file-size and max-request-size to at least 500MB, see the following multipart-config example of such a a web.xml file:
      • <multipart-config>
        <!-- 500MB max -->
        <max-file-size>524288000</max-file-size>
        <max-request-size>524288000</max-request-size>
        <file-size-threshold>0</file-size-threshold>
        </multipart-config>
  • Deploy AEM web application

    • Download AEM war file
    • Make your configurations In web.xml if needed (see above in the General Description)
      • Unpack WEB-INF/web.xml file
      • change sling.run.modes parameter to publish
      • uncomment sling.home initial parameter and set this path as you need
      • Repack web.xml file
    • Rename AEM war file to ROOT.war if you like to deploy it as root webapp, rename it to e.g aemauthor.war if you like to have aemauthor as context root
    • copy it into tomcat's webapps folder
    • wait until AEM is installed

     

Troubleshooting

For information on dealing with issues that may come up during installation, see:

Any questions?

Have a question about this or any other AEM topic? Ask our Community.
Learn more about AEM topics on our help hub.
Was this helpful?

By submitting your feedback, you accept the Adobe Terms of Use.

Thank you for submitting your feedback.