AEM /CQ5: How to install and work with it.
Introduction
Adobe
Experience Manager (AEM) is a server-side application that runs on the Java platform.
It is available in two forms:
- A standalone executable jar file referred to as a quickstart file.
- A war file to be deployed in a third-party application server.
AEM is
accessed entirely through the web browser. No client-side software, other than a
compatible browser, is required.
- Apache Felix OSGi container within which all other components are run.
- Integrated HTTP server (no separate application server needed).
- Apache Sling web application framework (provides REST-based request resolution).
- CRX content repository that stores all content (no separate database needed)
- AEM application built on the above stack (provides all the content management functionality and more).
The war
file version of AEM includes all of the same components, except that the HTTP
service is delegated to the application server within which the war file
is deployed.
- Installation requirements
- Installing, starting, and stopping AEM
- Custom installation
- Installing AEM with an application server
- Troubleshooting
- Uninstalling AEM
Installation requirements
Before
you start to install AEM please read AEM Technical Requirements, in particular, the following
sections:
Prerequisites
- The Java Runtime Environment (JRE). Version 1.7 is preferred. See Java Virtual Machines for details.
- The AEM Quickstart JAR file (if deploying as a standalone server) or the AEM WAR file (if deploying in an application server).
Minimum Sizing Requirements
- 3 GB free disk space in the deployment directory
- 1.5 GB memory
If you are using AEM DAM, you must increase the heap size when starting AEM WCM.
You will have to increase these in accordance with
your operational expectations. Please see the Hardware
Sizing Guidelines for
further information.
Support Levels
This document lists the supported client and server platforms for AEM. Adobe provides several levels of support, both for our recommended configurations and for other configurations.Supported Platforms
Java Virtual Machines
Platform
|
Support
Level
|
Oracle
JRE 1.7.x
|
A:
Supported
|
Oracle
JRE 1.6.x
|
A:
Supported
|
IBM J9 VM (build 2.6, JRE 1.7.0)
|
A: Supported
|
HP JRE 1.6
|
A: Supported
|
IBM J9 VM (build 2.4 & 2.6, JRE 1.6.0)
|
A: Supported
|
Note:
- The IBM JRE is only supported on IBM server platforms (AIX), or in conjunction with WebSphere Application Server.
- The HP JRE is only supported on HP server platforms (HP-UX).
Adobe Experience Manager Architecture
AEM system architecture is described in detail in Exploring AEM,
which explains the underlying concepts and technologies
Here following topics are covered :-
What is AEM?
AEM Console
Unique Concepts
Concepts of the
Touched Optimized UI
Author and Publish UI
Persistence Managers and Databases
The
default installation of AEM (in either jar or war form) includes a built in
persistent storage layer in which all content is ultimately stored. In some
cases users may choose to re-configure AEM to use an external third-party
database for storage. Any such database must, of course, be installed
separately from AEM.
In such
cases the initial installation of AEM should still proceed as described in this
section. Once installation is complete the system can be reconfigured to
connect to the database, as described in Custom Installation - Configuring
a Persistence Manager other than TarPM.
Note:-
The Tar PM Scan
tool allows you to view the transactions within the Tar Persistence Manager's
tar files at a low level. Viewing such transactions helps in analyzing unusual
repository growth issues where the disk usage is growing rapidly.
Tar PM Scan – Scans tar files and displays node path
and size for each record. This can be useful when analyzing abnormal
workspace growth. Large individual node sizes could indicate a flat
hierarchy (i.e. a large child node list > 1000). The same nodes
appearing repeatedly in the scan could indicate a code issue or some other
problem related to updating the same nodes repeatedly. Detailed info
here: http://helpx.adobe.com/content/help/en/cq/kb/tarpmscan.html
Installing AEM
How To install AEM author and publish instance
Generally,
when you set up Adobe Experience Manager (AEM), you need to set up an Author
and a Publish instance - see Author and Publish Environments for further details on the
two types of environment.
Installation procedures for these are described in Installing an Author instance and Installing a Publish instance. If you need to install AEM for
testing or similar purposes, you can use the generic procedure to install an author
instance with default settings and file names.
Note:-
· Author
and publish websites. This is achieved using
two specialized environments:
- Author:
Here you can enter and manage the content for your website.
Use either of the two UIs (classic and touch-optimized) to author and administer content on a range of devices (desktop, laptop, tablet, etc). - Publish:
This environment makes the content available to your intended audience.
Note:-
AEM Instances
While different instances in different environments are all installations of the same AEM software installed in different places in the overall system infrastructure, they differ mainly in the way they are configured. For example, it is that configuration which determines whether a AEM instance behaves as an author instance or a publish instance.
Author
Author instances are usually located behind the internal firewall. This is the environment where you, and your colleagues, will perform authoring tasks, such as:- administrate the entire system
- input your content
- configure the layout and design of your content
- activate your content to the publish environment
In order to reverse-replicate data generated in a publish environment back to the author environment, a replication listener in the author environment will poll the publish environment and retrieve such content from the publish environment's reverse-replication outbox.
Publish
A publish environment is usually
located in the Demilitarized Zone (DMZ). This is the environment where visitors
will access your website and interact with it; be it public, or within your
intranet.
- holds content replicated from the author environment
- makes that content available to the visitors of your website
- stores user data generated by your visitors, such as comments or other form submissions
- may be configured to add such user data to an outbox, for reverse-replication back to the author environment
Steps To Install Author Instance of AEM
To
install an author instance:
- On the host file system, create a directory and name it author.
- Copy the cq5-<version>.jar file into author/.
- Rename cq5-<version>.jar to cq5-author-p4502.jar.
If you need a different port this can be set in the
filename.
- Copy a valid license.properties file into author/ as well (the same directory as the cq5-author-p4502.jar file).
If you do not provide the license.properties file,
CQ will redirect you to the Welcome screen when starting the
application, where you can enter a valid license key. You will need to request
a valid license key from Adobe if you do not yet have one.
- Start CQ Quickstart using one of the following methods:
- If using a GUI file-system explorer, double-click the cq5-author-p4502.jar file.
- If using the command line,
for a 32bit VM type:
java -Xmx1024M -jar cq5-author-p4502.jar
Or, for a 64bit VM, type:
java -XX:MaxPermSize=256m -Xmx1024M -jar cq5-author-p4502.jar - Use a custom script located
in the crx quickstart folder, such as server.bat to start CQ.
The Start and Stop scripts are for UNIX, Linux, and Macintosh. The server.bat script is for Windows
6. · When the installation is
completed, you are automatically presented with a new web browser window
opening http://localhost:4502/.
With the default settings, the syndication agent
points toward the publish instance at http://localhost:4503/.
Steps To Install Publish AEM Instance
To set up a publish instance on port
4503 of the desired host, you perform the same steps as in installing an author
instance except
that you create a directory named publish (instead of author) and you rename the
quickstart.jar file as cq5-publish-p4503.jar. You
can select any port number.
Including all Steps of Author
Instance there is one more Steps for Author
As steps :-5
·
Start CQ Quickstart using one of the following methods:
- If using a GUI file-system explorer, double-click the cq5-publish-p4503.jar file.
- If using the command line,
for a 32bit VM type:
java -Xmx1024M -jar cq5-publish-p4503.jar
Or, for a 64bit VM, type:
java -XX:MaxPermSize=256m -Xmx1024M -jar cq5-publish-p4503.jar
- Use a custom script located
in the crx quickstart folder, such as server.bat to start CQ.
The Start and Stop scripts are for UNIX, Linux, and Macintosh. The server.bat script is for Windows.
You cannot use a custom script when you install the cq quickstart jar file (the first time it is started) unless you expand the file first. Use the -unpack option on the command line to unpack the contents before running the script as in java -jar cq5-publish-p4503.jar -unpack.
Installing a AEM Instance - Generic Procedure
You do not need to perform this procedure before installing author or publish instances. To install an author or publish instance, see Installing an Author Instance and Installing a Publish Instance.
To install a generic AEM instance (author):
2. Copy
a valid license.properties file
into the same directory as the cq5-<version>.jar
file).
If you do not provide the license.properties
file, AEM will redirect you to the Welcome screen when starting the application,
where you can enter a valid license key. You will need to request a valid
license key from Adobe if you do not yet have one.
3. Start
AEM Quickstart using one of the following methods:
- If using a GUI file-system explorer, double-click the cq5-<version>.jar file.
- If
using the command line, for a 32bit VM type:
java -Xmx1024M -jar cq5-<version>.jar
Or, for a 64bit VM, type:
java -XX:MaxPermSize=256m -Xmx1024M -jar cq5-<version>.jar - Use
a custom script located in the crx quickstart folder, such as start.bat to start AEM.
The Start and Stop scripts are for UNIX, Linux, and Macintosh. The start.bat and stop.bat scripts are for Windows.
You cannot use a custom script when you install the AEM quickstart jar file (the first time it is started) unless you expand the file first. Use the -unpack option on the command line to unpack the contents before running the script as in java -jar cq5-<version>.jar -unpack.
4. When
the installation is completed, you are automatically presented with a new web
browser window opening http://localhost:4502/.
AEM Quickstart selects the first available port
from the following list:
4502,8080,8081,8082,8083,8084,8085,8888,9362,<random>
4502,8080,8081,8082,8083,8084,8085,8888,9362,<random>
You can also set the port number. See installing
an author instance for an example on how to set a port number.
Starting Adobe Experience Manager
Download and Start Working
You are reading the Adobe Experience Manager
5.6.1 version of Download and Start Working.
This documentation is also available for the following versions: AEM 5.6 CQ 5.5 CQ 5.4 CQ 5.3 Download Adobe Experience Manager
The quickstart jar file contains the full stack needed for AEM. This includes:
The war file version of AEM includes all of the same components, except that the HTTP service is delegated to the application server within which the war file is deployed. This section includes information on the following:
The touch-optimized UI introduces new versions of the consoles and can be used for basic handling, such as creating, opening, copying, moving and deleting a page. Editing a page (to add content using paragraphs) is still done with the classic UI. Upon installation the touch-optimized UI is the default, you can configure your instance to use the UI that you require. Installation RequirementsSoftware and Hardware RequirementsBefore you start to install AEM please read AEM Technical Requirements, in particular, the following sections:
Adobe Experience Manager ArchitectureAEM system architecture is described in detail in Exploring AEM, which explains the underlying concepts and technologies.Persistence Managers and DatabasesThe default installation of AEM (in either jar or war form) includes a built in persistent storage layer in which all content is ultimately stored. In some cases users may choose to re-configure AEM to use an external third-party database for storage. Any such database must, of course, be installed separately from AEM.In such cases the initial installation of AEM should still proceed as described in this section. Once installation is complete the system can be reconfigured to connect to the database, as described in Custom Installation - Configuring a Persistence Manager other than TarPM. Installing Instances of Adobe Experience ManagerHow to Install AEM Author and Publish Instances using QuickstartGenerally, when you set up Adobe Experience Manager (AEM), you need to set up an Author and a Publish instance - see Author and Publish Environments for further details on the two types of environment.Installation procedures for these are described in Installing an Author instance and Installing a Publish instance. If you need to install AEM for testing or similar purposes, you can use the generic procedure to install an author instance with default settings and file names. Only US-ASCII characters are allowed in the name of the folder used to store the Quickstart jar (or any other runnable jar). The first time you start the jar file (either by double-clicking on it or via the command line), it unpacks itself and installs the AEM application in a sub-directory within the same directory as itself. However, once AEM is installed, restarting the jar file does not reinstall the system. It simply starts up the application. Installing an Author InstanceThis procedure describes how to set up a default Author instance on port 4502 of the desired host.To install an author instance:
1.
On the host file system, create a directory and name
it author.
2.
Copy the cq5-<version>.jar
file into author/.
3.
Rename cq5-<version>.jar
to cq5-author-p4502.jar.
If you need a different port this can be set
in the filename.
4.
Copy a valid license.properties file
into author/
as well (the same directory as the cq5-author-p4502.jar
file).
If you do not provide the license.properties
file, AEM will redirect you to the Welcome screen when starting the
application, where you can enter a valid license key. You will need to
request a valid license key from Adobe if you do not yet have one.
5.
Start AEM Quickstart using one of the following
methods:
Note
You cannot use a custom script when you
install the AEM quickstart jar file (the first time it is started) unless you
expand the file first. Use the -unpack option on the command line to unpack
the contents before running the script as in java -jar cq5-author-p4502.jar -unpack.
6.
When the installation is completed, you are
automatically presented with a new web browser window opening http://localhost:4502/.
With the default settings, the syndication
agent points toward the publish instance at http://localhost:4503/.
Installing a Publish InstanceIf you are installing both your author and publish instances on an Amazon EC2 web service, see Installing AEM on an Amazon EC2 web service before starting the Publish instance. You must modify some start settings or the Publish instance will not function.To set up a publish instance on port 4503 of the desired host, you perform the same steps as in installing an author instance except that you create a directory named publish (instead of author) and you rename the quickstart.jar file as cq5-publish-p4503.jar. You can select any port number. To install a publish instance:
1.
On the host file system, create a directory and name
it publish.
2.
Copy the cq5-<version>.jar
file into publish/.
3.
Rename cq5-<version>.jar
to cq5-publish-p4503.jar.
If
you need a different port this can be set in the filename.
4.
Copy a valid license.properties
file into publish/ as well (the same
directory as the cq5-publish-p4503.jar
file).
If
you do not provide the license.properties file, AEM will redirect you to the Welcome
screen when starting the application, where you can enter a valid license
key. You will need to request a valid license key from Adobe if you do not
yet have one.
5.
Start AEM Quickstart using one of the following
methods:
6.
When the installation is completed, you can browse
your site (for example, http://localhost:4503/content/geometrixx/en/company.html
Installing a AEM Instance - Generic ProcedureThis procedure is a generic, quickstart procedure for installing AEM; it installs an author instance using default settings and file names. It is often used when testing, or other scenarios when you need a quickly available instance.You do not need to perform this procedure before installing author or publish instances. To install an author or publish instance, see Installing an Author Instance and Installing a Publish Instance. To install a generic AEM instance (author):
1.
Copy the cq5-<version>.jar
file to the desired directory on the host file system.
2.
Copy a valid license.properties
file into the same directory as the cq5-<version>.jar
file).
If you do not provide the
license.properties file, AEM will redirect you to the Welcome screen
when starting the application, where you can enter a valid license key. You
will need to request a valid license key from Adobe if you do not yet have
one.
3.
Start AEM Quickstart using one of the following
methods:
4.
When the installation is completed, you are
automatically presented with a new web browser window opening http://localhost:4502/.
AEM Quickstart selects the first
available port from the following list:
4502,8080,8081,8082,8083,8084,8085,8888,9362,<random>
You can also set the port number. See installing
an author instance for an example on how to set a port
number.
Starting Adobe Experience ManagerStarting AEM is similar to installing it, you can:
1. If
using a GUI file-system explorer, double-click the quickstart jar file; for
example:
cq5-<version>.jar
2. If
using the command line, type:
3. To
use a customized script you need to expand the quickstart.jar
file first. Use the -unpack
option on the command line to unpack the contents before running the script.
Various log messages will be shown on the
command line, the actual appearance will depend on the platform you are
using.
AEM starts and automatically redirects your web
browser to the appropriate page, usually the login page; for example:http://localhost:4502/ |
Once logged in, you have access to AEM WCM
Starting Adobe Experience Manager from the Command Line
The start
script is available under the <cq-installation>/bin
directory. Both Unix and Windows versions are provided. The script starts the
instance installed in <cq-installation> directory.
Those two
versions support a list of environement variables that could be used to start
and tune the AEM instance.
Environment variable
|
Description
|
CQ_PORT
|
TCP
port used for stop and status scripts
|
CQ_HOST
|
Host
name
|
CQ_INTERFACE
|
Interface
that this server should listen to
|
CQ_RUNMODE
|
Runmode(s)
separated by comma
|
CQ_JARFILE
|
Name of
the jarfile
|
CQ_USE_JAAS
|
Use of
JAAS (if true)
|
CQ_JAAS_CONFIG
|
Path of
the JAAS configuration
|
CQ_JVM_OPTS
|
Default
JVM options
|
Windows
platform start.bat script example
1
|
SET CQ_PORT=1234 & ./start.bat
|
Unix
platform start script example
1
|
CQ_PORT=1234 ./start
|
Note :-
The start
script launches the AEM Quickstart installed under the
<cq-installation>/app folder.
Accessing CRXDE Lite and the Apache Felix Management Console
Once AEM
WCM has been started, you can also access:
- CRXDE Lite - used to access and manage the repository
- Web Console - used to manage or configure the OSGi bundles (also known as the OSGi Console)
Accessing CRXDE Lite
To open CRXDE Lite you can select CRXDE Lite from the welcome screen or use your browser to navigate tohttp://<host>:<port>/crx/de/index.jsp
For example:
http://localhost:4502/crx/de/index.jsp
Accessing the Web Console
To access the Adobe CQ Web console you can select OSGi Console from the welcome screen or use your browser to navigate tohttp://<host>:<port>/system/console
For example:
http://localhost:4502/system/console
or for the Bundles page
http://localhost:4502/system/console/bundles
Stopping Adobe Experience Manager
To stop
AEM, do one of the following:
- Depending on the platform you are using:
- If you started AEM from either a script or the command line, press Ctrl+C to shut down the server.
- If you have used the start script on UNIX, you must use the stop script to stop AEM.
- If you started AEM by double-clicking the jar file, click the On button on the startup window (the button then changes to Off) to shut down the server.
The stop script is available under the
<cq-installation>/bin directory. Both Unix and Windows versions are
provided. The script stops the running instance installed in <cq-installation>
directory.
1
|
./stop
|
1
|
./stop.bat
|
Further Option available From The QuickStart File
Loading quickstart properties: default
Loading quickstart properties:
instance
Setting properties from filename
'/Users/Desktop/AEM/cq-quickstart-5.6.0.jar'
--------------------------------------------------------------------------------
Adobe Experience Manager
Quickstart (build
20130129)
--------------------------------------------------------------------------------
Usage:
Use these options on the
Quickstart command line.
--------------------------------------------------------------------------------
-help (--help,-h)
Show
this help
message
-quickstart.server.port
(-p,-port) <port>
Set
server port
number
-contextpath
(-c,-org.apache.felix.http.context_path) <contextpath>
Set
context
path
-debug <port>
Enable
Java Debugging on port number; forces
forking
-gui
Show
GUI if running on a
terminal
-nobrowser
(-quickstart.nobrowser)
Do
not open browser at startup
-unpack
Unpack
installation files only, do not start
the server (implies
-verbose)
-v (-verbose)
Do
not redirect stdout/stderr to files
and do not close stdin
-nofork
Do
not fork the JVM, even if not running on a console
-fork
Force
forking the JVM if running on a console, using
recommended
default
memory settings for the forked JVM.
-forkargs <args> [<args> ...]
Additional
arguments for the forked JVM, defaults to '-Xmx1024m
-XX:MaxPermSize=256m
'. Use -- to specify values
starting with -,
example:
'-forkargs -- -server'
-a (--interface) <interface>
Optional
IP address (interface) to bind
to
-pt <string>
Process
type (main/fork) - do not use directly, used when forking a
process
-r <string> [<string> [<string>
[<string> [<string> [<string> [<string> [<string>
[<string> [<string>]]]]]]]]]
Runmode(s)
- Use this to define the run
mode(s)
-b <string>
Base
folder - defines the path under which the quickstart work folder
is
created
-low-mem-action <string>
Low
memory action - what to do if memory is insufficient at startup
-use-control-port
Start
a control port
-ll <level>
Define
launchpad log level (1 = error...4 =
debug)
--------------------------------------------------------------------------------
Quickstart filename
options
--------------------------------------------------------------------------------
Usage:
Rename the jar file,
including one of the patterns shown below, to set the
corresponding option.
Command-line options have priority on these
filename
patterns.
--------------------------------------------------------------------------------
-NNNN
Include
-NNNN.jar or -pNNNN in the renamed jar filename to run on port
NNNN,
for example:
quickstart-8085.jar
-nobrowser
Include
-nobrowser in the renamed jar filename to avoid opening
the
browser
at startup, example:
quickstart-nobrowser-8085.jar
-publish
Include
-publish in the renamed jar filename to run cq5 in "publish"
mode,
example:
cq5-publish-7502.jar
--------------------------------------------------------------------------------
The license.properties file
--------------------------------------------------------------------------------
The
license.properties file stores licensing information, created from
the
licensing form
displayed on first startup and stored in the folder from where
Quickstart is
run.
--------------------------------------------------------------------------------
Log files
--------------------------------------------------------------------------------
Once Quickstart has
been unpacked and started, log files can be found under
./crx-quickstart/logs.
--------------------------------------------------------------------------------
Installing AEM with Application Server ( e.g Oracle WebLogic)
Oracle WebLogic 10.3.5 / 10.3.6 / 12.1
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:
- <enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials> see on http://xmlns.oracle.com/weblogic/domain/1.0/domain.xsd for the correct position (per default to position it at the end of the section is ok)
- 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
- search for MEM_MAX_PERM_SIZE, set e.g MEM_MAX_PERM_SIZE_64BIT=-XX:MaxPermSize=512m
- restart WebLogic Server
- Create in ${myDomain} a packages folder and inside a cq folder and in it a Plan folder
- 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
Note:-
Minimum Sizing Requirements
The following are the minimum requirements:
- 3 GB free disk space in the deployment directory
- 1.5
GB memory
If you are using AEM DAM, you must increase the heap size when starting AEM WCM.
please send the cq5-author-p4502.jar download link
ReplyDeleteBro Please Send cq5-author-p4502.jar link
ReplyDelete