Upgrade Steps for Application Server Installations

Last update: 2023-05-03
  • Created for:
  • Developer

AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

This section describes the procedure that needs to be followed in order to update AEM for Application Server installations.

All the examples in this procedure use JBoss as the Application Server and imply that you have a working version of AEM already deployed. The procedure is meant to document upgrades performed from AEM version 5.6 to 6.3.

  1. First, start JBoss. In most situations, you can do this by running the standalone.sh startup script, by running this command from the terminal:

  2. If AEM 5.6 is already deployed, check that the bundles are functioning correctly by running:

    wget https://<serveraddress:port>/cq/system/console/bundles
  3. Next, undeploy AEM 5.6:

    rm jboss-install-folder/standalone/deployments/cq.war
  4. Stop JBoss.

  5. Now, migrate the repository using the crx2oak migration tool:

    java -jar crx2oak.jar crx-quickstart/repository/ crx-quickstart/oak-repository

    In this example, oak-repository is the temporary directory where the newly converted repository will reside. Before performing this step, make sure you have the latest crx2oak.jar version.

  6. Delete the necessary properties in the sling.properties file by doing the following:

    1. Open the file located at crx-quickstart/launchpad/sling.properties

    2. Step text Remove the following properties and save the file:

      1. sling.installer.dir
      2. felix.cm.dir
      3. granite.product.version
      4. org.osgi.framework.system.packages
      5. osgi-core-packages
      6. osgi-compendium-services
      7. jre-*
      8. sling.run.mode.install.options
  7. Remove the files and folders that are no longer necessary. The items you need to specifically remove are:

    • The launchpad/startup folder. You can delete it by running the following command in the terminal: rm -rf crx-quickstart/launchpad/startup
    • The base.jar file: find crx-quickstart/launchpad -type f -name "org.apache.sling.launchpad.base.jar*" -exec rm -f {} \
    • The BootstrapCommandFile_timestamp.txt file: rm -f crx-quickstart/launchpad/felix/bundle0/BootstrapCommandFile_timestamp.txt
  8. Copy the newly migrated segmentstore to its proper location:

    mv crx-quickstart/oak-repository/segmentstore crx-quickstart/repository/segmentstore
  9. Copy the datastore as well:

    mv crx-quickstart/repository/repository/datastore crx-quickstart/repository/datastore
  10. Next, you need to create the folder that will contain the OSGi configurations that will be used with the new upgraded instance. More specifically, a folder named install needs to be created under crx-quickstart.

  11. Now, create the node store and data store that will be used with AEM 6.3. You can do this by creating two files with the following names under crx-quickstart\install:

    • org.apache.jackrabbit.oak.segment.SegmentNodeStoreService.cfg

    • org.apache.jackrabbit.oak.plugins.blob.datastore.FileDataStore.cfg

    These two files will configure AEM to use a TarMK node store and a File data store.

  12. Edit the configuration files to make them ready for use. More specifically:

    • Add the following line to org.apache.jackrabbit.oak.segment.SegmentNodeStoreService.config:


    • Then add the following lines to org.apache.jackrabbit.oak.plugins.blob.datastore.FileDataStore.config:

  13. Remove the crx2 runmode by running:

    find crx-quickstart/launchpad -type f -name "sling.options.file" -exec rm -rf {} \
  14. You now need to change the run modes in the AEM 6.3 war file. In order to do that, first create a temporary folder that will be housing the AEM 6.3 war. The name of the folder in this example will be temp. Once the war file has been copied over, extract its contents by running from inside the temp folder:

    jar xvf aem-quickstart-6.3.0.war
  15. Once the contents have been extracted, go to the WEB-INF folder and edit the web.xml file to change the run modes. To find the location where they are set in the XML, look for the sling.run.modes string. Once you find it, change the run modes in the next line of code, which by default is set to author:

    <param-value >author</param-value>
  16. Change the above author value and set the run modes to: author,crx3,crx3tar The final block of code should look like this:

  17. Recreate the jar with the modified contents:

    jar cvf aem62.war
  18. Finally, deploy the new war file:

    cp temp/aem62.war jboss-install-folder/standalone/deployments/aem61.war

On this page