Deploying and Maintaining

Last update: 2024-01-11

In this page you find:

Once you have familiarized yourself with these basics, you can find in more advanced and detailed information in the following subpages:

Basic Concepts

What is AEM?

Adobe Experience Manager is a web-based client-server system for building, managing, and deploying commercial websites and related services. It combines several infrastructure-level and application-level functions into a single integrated package.

At the infrastructure level AEM provides the following:

  • Web Application Server: AEM can be deployed in standalone mode (it includes an integrated Jetty web server) or as a web application within a third-party application server.
  • Web Application Framework: AEM incorporates the Sling Web Application Framework that simplifies the writing of RESTful, content-oriented web applications.
  • Content Repository: AEM includes a Java™ Content Repository (JCR), a type of hierarchical database designed specifically for unstructured and semi-structured data. The repository stores not only the user-facing content but also all code, templates, and internal data used by the application.

Building on this base, AEM also offers several application-level features for the management of:

  • Websites
  • Mobile Applications
  • Digital Publications
  • Forms & Documents
  • Digital Assets
  • Communities
  • Online Commerce

Finally, customers can use these infrastructure and application-level building blocks to create customized solutions by building applications of their own.

The AEM server is Java-based and runs on most operating systems that support that platform. All client interaction with AEM is done through a web browser.

NOTE

The Adaptive Forms feature, available in AEM 6.5 QuickStart, is designed for exploration and evaluation purposes only. For production use, it is essential to obtain a valid license for AEM Forms, as Adaptive Forms functionality requires proper licensing.

Typical Deployment Scenarios

In AEM terminology, an “instance” is a copy of AEM running on a server. AEM installations usually involve at least two instances, typically running on separate computers:

  • Author: An AEM instance used to create, upload, and edit content and to administer the website. Once content is ready to go live, it is replicated to the publish instance.
  • Publish: An AEM instance that serves the published content to the public.

These instances are identical in terms of installed software. They are differentiated by configuration only. In addition, most installations use a Dispatcher:

  • Dispatcher: A static web server (Apache httpd, Microsoft® IIS, and so on) augmented with the AEM Dispatcher module. It caches web pages produced by the publish instance to improve performance.

There are many advanced options and elaborations of this setup, but the basic pattern of author, publish and Dispatcher is at the core of most deployments. Let’s begin by focusing on a simple setup. Discussions of advanced deployment options follow.

The following sections describe both the scenarios:

  • On-premise: AEM deployed and managed in your corporate environment.

  • Managed Services - Cloud Manager for Adobe Experience Manager: AEM deployed and managed by Adobe Managed Services.

On-premise

You can install AEM on servers in your Corporate environment. Typical installation instances include: Development, Testing, and Publishing environments. See Getting Started for basic details on how to get the AEM software to install it locally.

To learn more about the typical on-premises deployments, see Recommended Deployments.

Managed Services using Cloud Manager

AEM Managed Services is a complete solution for Digital Experience management. It provides benefits of experience delivery solution in the cloud while retaining all the control, security, and customization benefits of an on-premise deployment. AEM Managed Services enables customers to launch faster by deploying on the cloud and also by leaning on the best practices and support from Adobe. Organizations and business users can engage customers in minimal time, drive market share, and focus on creating innovative marketing campaigns while reducing the burden on IT.

With AEM Managed Services customers can realize the following benefits:

Faster Time to Market: With flexible cloud infrastructure of Adobe Managed Services, organizations can rapidly plan, launch, and optimize successful digital experiences. Adobe manages the cloud architecture with no additional capital, hardware, or software required and Adobe’s Customer Solutions Engineers, help with AEM architecture, provisioning, customization for connecting to back-end apps and go-live best practices.

Higher Performance: Provides reliable digital experiences for your business with four service availability options 99.5%, 99.9%, 99.95%, and 99.99%. Also, it allows automatic backup and multimode disaster recovery models to help ensure reliability and contingency management.

Optimized IT Costs: Proactive guidance and expertise help organizations stay current on the latest version of AEM. Adobe Platinum Maintenance and Support is automatically included in new deployments of AMS Enterprise/Basic, offering technical expertise, and operational experience to help organizations maintain their mission-critical applications. Free basic Analytics or Target capabilities offer additional value especially for mid-market organizations with limited needs for analytics and personalization.

Highest Security: Ensures enterprise-grade physical, network, and data security by hosting customer applications in a restricted-access facility, behind firewall systems, or inside a virtual private cloud. It includes single-tenant virtual machines with robust data storage encryption, antivirals, and data isolation.

Cloud Manager: Cloud Manager, part of the Adobe Experience Manager Managed Services offering is a self-service portal that further enables organizations to self-manage Adobe Experience Manager in the cloud. It includes a state-of-the-art continuous integration and continuous delivery (CI/CD) pipeline that lets IT teams and implementation partners speed the delivery of customizations or updates without compromising performance or security. Cloud Manager is only available for Adobe Managed Service customers.

To learn more about Cloud Manger and its resources, see Cloud Manager User Guide.

Getting Started

Prerequisites

While production instances are run on dedicated machines running an officially supported OS (see Technical Requirements), the Experience Manager server will actually run on any system that supports Java™ Standard Edition 8.

For purposes of familiarization and for developing on AEM, it is common to use an instance installed on your local machine running Apple OS X or desktop versions of Microsoft® Windows or Linux®.

On the client-side, AEM works with all modern browsers (Microsoft® Edge, Internet Explorer 11, **Chrome 51+ **, **Firefox **47+, Safari 8+) on both desktop and tablet operating systems. See Supported Client Platforms for details.

Getting the Software

Customers with a valid maintenance and support contract should have received a mail notification with a code and be able to download AEM from the Adobe Licensing Website. Business partners can request download access from spphelp@adobe.com.

The AEM software package is available in two forms:

  • cq-quickstart-6.5.0.jar: A standalone executable jar file that includes everything that you need to get running.

  • cq-quickstart-6.5.0.war: A war file for deployment in a third-party application server.

In the following section we describe the standalone installation. For details on installing AEM in an application server see Application Server Install.

Default Local Install

  1. Create an install directory on your local machine. For example:

    UNIX® install location: /opt/aem

    Windows install location: C:\Program Files\aem

    Equally, it is common to install sample instances in a folder right on the desktop. In any case, Adobe refers to this location generically as:

    <aem-install>

    The path of the file directory must consist of only US ASCII characters.

  2. Place the jar and license files in this directory:

    <aem-install>/
        cq-quickstart-6.5.0.jar
        license.properties
    

    If you do not provide a license.properties file, AEM redirects your browser to a Welcome screen on startup, where you can enter a license key. You need to request a valid license key from Adobe if you do not yet have one.

  3. To start up the instance in a GUI environment, double-click the cq-quickstart-6.5.0.jar file.

    Alternative, you can launch AEM from the command line:

        java -Xmx1024M -jar cq-quickstart-6.5.0.jar
    

AEM takes a few minutes to unpack the jar file, install itself, and start up. The above procedure results in:

  • an AEM author instance
  • running on localhost
  • on port 4502

To access the instance, point your browser to:

https://localhost:4502

The result in author instance will be automatically configured to connect to a publish instance on localhost:4503.

Author and Publish Installs

The default install (an author instance on localhost:4502) can be changed simply by renaming the jar file before launching it for the first time. The naming pattern is:

cq-<instance-type>-p<port-number>.jar

For example, renaming the file to

cq-author-p4502.jar

And launching it, results in an author instance running on localhost:4502.

Similarly, renaming and launching the file

cq-publish-p4503.jar

Results in a publish instance running on localhost:4503.

You would install these two instances in, for example

<aem-install>/authorand

<aem-install>/publish

For more details on customizing your installation see the following:

Unpacked Install Directory

When the quickstart jar is launched for the first time, it unpacks itself into the same directory under a new subdirectory called crx-quickstart. You should have the following:

<aem-install>/
    license.properties
    cq-quickstart-6.5.0.jar
    crx-quickstart/
        app/
        bin/
        conf/
        launchpad/
        logs/
        metrics/
        monitoring/
        opt/
        repository/
        threaddumps/
        eula-de_DE.html
        eula-en_US.html
        eula-fr_FR.html
        eula-ja_JP.html
        readme.txt

If the instance was installed from the UI, a browser window opens automatically, and a desktop application window also opens displaying the host and port of the instance and an on/off switch:

start up screen

NOTE

If you are using symlinks, have a look at issues with symlink.

Starting and Stopping

Once AEM has unpacked itself and started up for the first time, double-clicking the jar file in the install directory simply starts the instance, it does not reinstall it.

To stop the instance from the GUI, click the on/off switch on the desktop application window.

You can also stop and start AEM from the command line. Assuming you have already installed the instance for the first time, the command-line scripts are here:

<aem-install>/crx-quickstart/bin/

This folder contains the following UNIX® bash shell scripts:

  • start: Starts the instance
  • stop: Stops the instance
  • status: Reports the Status of the instance
  • quickstart: Used to configure start information, if necessary.

There are also equivalent bat files for Windows. For more detailed information, see:

AEM starts and automatically redirects your web browser to the appropriate page, usually the login page; for example:

https://localhost:4502/

sign in screen

After you are logged in, you have access to AEM. For more information, depending on your role, see the following:

Advanced Deployment

The above section should give you a good understanding of the basics of AEM installation. However, installing a full production system of AEM can involve considerably more complexity. For full coverage of advanced installation see the following subpages:

On this page