Application Server Install application-server-install

JAR and WAR are the file types Adobe Experience Manager (AEM) is released in. These formats are undergoing quality assurance to accommodate the support levels Adobe has committed to.

This section tells you how to install Adobe Experience Manager (AEM) with an application server. Consult the Supported Platforms section to read about 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.

If you are using Dynamic Media in a WAR deployment, see Dynamic Media documentation.

General Description general-description

Default behavior when installing AEM in an Application Server default-behaviour-when-installing-aem-in-an-application-server

AEM comes as a single war file to deploy.

If deployed, the following happens by default:

  • the run mode is author

  • the instance (Repository, Felix OSGI environment, bundles, and so on) is installed in ${user.dir}/crx-quickstartwhere ${user.dir} is the current working directory, this path to crx-quickstart is called sling.home

  • the context root is the war file name for example, aem-6

Configuration configuration

You can change the default behavior in the following way:

  • run mode : configure the 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.xmlfile of the AEM war file before deployment

  • context root: rename the AEM war file

Publish installation 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 parameter to publish
  • Repack web.xml file into AEM war file
  • Deploy AEM war file

Installation check installation-check

To check if all is installed, you can:

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

Two Instances on the same Application Server 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 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 to publish for the publish instance.
  5. Repack the web.xml file.
  6. Rename the war files, so they have different names. For example, one rename to aemauthor.war and the other to aempublish.war.
  7. Use higher memory settings. For example, default AEM instances use -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 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 application-servers-installation-procedures

WebSphere® 8.5 websphere

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 = /, 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 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 jboss-eap

Before a deployment read the General Description above.

Prepare JBoss® server

Set Memory arguments in your conf file (for example, standalone.conf)

  • JAVA_OPTS=“-Xms64m -Xmx2048m”

If you use the deployment-scanner to install the AEM web application, it might be good to increase the deployment-timeout, for that set a deployment-timeout attribute in the xml file of your instance (for example, 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"/>

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 oracle-weblogic

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.xmladd to the security-configuration section:

  • Increase VM Memory settings:

    • open ${myDomain}/bin/setDomainEnv.cmd (resp .sh) search for WLS_MEM_ARGS, set, for example, 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.xmlfile
    • change 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 (for example, 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 tomcat

Before a deployment read the General Description above.

  • Prepare Tomcat Server

    • Increase VM memory settings:

      • In bin/catalina.bat (resp on UNIX®) add the following setting:
      • set "JAVA_OPTS= -Xmx2048m
    • Tomcat enables not admin or 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:

        code language-xml
        <?xml version='1.0' encoding='utf-8'?>
        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"/>
    • 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,


      and increase the max-file-size and max-request-size to at least 500MB, see the following multipart-config example of such a web.xml file.

      code language-xml
      <!-- 500MB max -->
  • 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 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 want to deploy it as root webapp. Rename it to aemauthor.war if you want to have aemauthor as context root.

    • Copy it into tomcat’s webapps folder.

    • Wait until AEM is installed.

Troubleshooting troubleshooting

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