Deploying Communities

You are reading the AEM 6.2 version of Deploying Communities.
This documentation is also available for the following versions:  AEM 6.3  AEM 6.1 

Prerequisites

  • AEM Communities license

Caution

Be aware that Java version 1.7 (and earlier) is not supported for AEM 6.2. For more information, see Supported Platforms.

Installation Checklist

For the AEM platform

For Communities capability

Latest Releases

AEM 6.2 Communities GA ships with Communities package version 1.9.
Feature packs for AEM 6.2 Communities are version 1.10.

All packages are made available through package share.

AEM 6.2 Updates

Before installing Communities fix or feature packs, it is necessary to ensure the AEM platform is up-to-date. 

For the latest updates to AEM 6.2, be sure to check Adobe Experience Manager 6.2 hot fixes

Note

The AEM platform service and fix packs never include updates to Communities features.

Communities updates and fixes are made available only through Communities feature packs. 

After installing an AEM platform service pack, it is not  necessary to re-install a Communities feature pack.

Latest Feature Pack

Feature Pack 3 (FP3)

This cumulative feature pack includes the latest fixes, new features, and improvements for the AEM 6.2 Communities and Livefyre releases.

  • AEM-6.2-Communities-Livefyre-Feature-Pack-3
    • v1.10.167
    • 25 Apr 2017
  • improved member self-registration
  • recover password/ID
  • email verification
  • migration tool
  • ability for allow any member to view enablement resources and learning paths in the catalog
  • social login update for Facebook API change (v2.2 not supported as of 3/25/2017)
  • all fixes and improvements from previous versions

See also

Note

  • the latest feature pack may be directly installed on a new AEM instance
  • a feature pack should be installed without uninstalling a previous feature pack
  • a feature pack does not need to be re-installed after an AEM platform update is installed

Caution

Never uninstallcq-socialcommunities-pkg from package manager.

While not necessary, if it is desired to remove older packages present in package manager, simply delete them.

Version History

See Communities Version History for information on all versions of AEM 6.2 Communities.

JDBC driver for MySQL

Two Communities features use a MySQL database :

  • for enablement : recording SCORM activities and learners
  • for DSRP : storing user generated content (UGC)

The MySQL connector must be obtained and installed separately.

The necessary steps are :

  1. download the ZIP archive from https://dev.mysql.com/downloads/connector/j/
    • version must be >= 5.1.38
  2. extract mysql-connector-java-<version>-bin.jar (bundle) from the archive
  3. use the web console to install and start the bundle :
    • for example, http://localhost:4502/system/console/bundles
    • select Install/Update
    • Browse... to select the bundle extracted from the downloaded ZIP archive
    • check that Oracle Corporation's JDBC Driver for MySQLcom.mysql.jdbc is active, and start it if not (or check the logs)
  4. if installing on an existing deployment after JDBC has been configured, then rebind JDBC to the new connector by resaving the JDBC configuration from the web console :
    • for example, http://localhost:4502/system/console/configMgr
    • locate Day Commons JDBC Connections Pool configuration
    • select to open
    • select Save
  5. repeat steps 3 and 4 on all author and publish instances

Further information on installing bundles is found on the Web Console page.

Example : Installed MySQL Connector Bundle

file

SCORM Package

Sharable Content Object Reference Model (SCORM) is a collection of standards and specifications for e-learning.  SCORM also defines how content may be packaged into a transferable ZIP file.

The AEM Communities scorm engine is required for the enablement feature.

Each version of the SCORM 1.0 package is compatible with all AEM 6.2 Communities releases.

The SCORM package should be installed on all AEM instances.

SCORM is configured during setup of MySQL.

SCORM Logging

As installed, all enablement activity is verbosely logged to the system console.

If desired, the log level can be set to WARN for the RusticiSoftware.* package.

For working with logs, see Working with Audit Records and Log Files.

AEM Advanced MLS

For the SRP collection (MSRP or DSRP) to support advanced multilingual search (MLS), new Solr plug-ins are required in addition to a custom schema and Solr configuration.  All required items are packaged into a downloadable zip file.

The advanced MLS download (also known as 'phasetwo') is available from the Adobe repository :

For details and installation information, visit Solr Configuration for SRP.

About Links to Package Share

Packages Visible in Adobe AEM Cloud

The links to packages on this page require no running instance of AEM as they are to package share on adobeaemcloud.com.  While the packages are viewable, the Install button is for installing the packages into an Adobe hosted site.  If intending to install on a local AEM instance, selecting Install will result in an error.

How to Install on Local AEM Instance

To install the packages visible in adobeaemcloud.com on a local AEM instance, the package must first be downloaded to a local disk :

  • select the Assets tab
  • select download to disk

On the local AEM instance, use package manager (for example http://localhost:4502/crx/packmgr/), to upload to the local AEM's package repository.

Alternatively, accessing the package using package share from the local AEM instance (for example,http://localhost:4502/crx/packageshare/), the Download button will download to the local AEM instance's package repository.

Once in the local AEM instance's package repository, use package manager to install the package.

For more information, visit How to Work With Packages.

Recommended Deployments

In AEM Communities, a common store is used to store user generated content (UGC) and is often referred to as the storage resource provider (SRP).  The recommended deployment centers on choosing an SRP option for the common store.  

The common store supports moderation of, and analytics on, UGC in the publish environment which eliminates the need for replication.

Upgrading

When upgrading to the AEM 6.2 platform from previous versions of AEM, it is important to read Upgrading to AEM 6.2.

In addition to upgrading the platform, read Upgrading to AEM Communities 6.2 to learn about Communities changes.

Configurations

Primary Publisher

When the deployment chosen is a publish farm, then one AEM publish instance must be identified as the primary publisher for activities which should not occur on all instances, such as features that rely on notifications or Adobe Analytics.

By default, the AEM Communities Publisher Configuration OSGi configuration is configured with the Primary Publisher checkbox checked, such that all publish instances in a publish farm would self-identify as the primary.  

Therefore, it is necessary to edit the configuration on all secondary publish instances to uncheck the Primary Publisher checkbox.

file

For all other (secondary) publish instances in a publish farm :

Replication Agents on Author

Replication is used for site content created in the publish environment, such as community groups, as well as managing members and member groups from the author environment using the tunnel service.

For the primary publisher, ensure the Replication Agent Config correctly identifies the publish server and authorized user.  The default authorized user, admin, already has the appropriate permissions (is a member of Communities Administrators).

In order for some other user to have the appropriate permissions, they must be added as a member to the administrators user group (also a member of Communities Administrators).

There are two replication agents in the author environment that need the transport configuration to be correctly configured.  

  • access the Replication console on author
    • from global navigation : Tools, Deployment, Replication,  Agents on author
  • follow the same procecure for both agents :
    • Default Agent (publish) 
    • Reverse Replication Agent (publish reverse)
      1. select the agent
      2. select edit
      3. select the Transport tab
      4. if not port 4503, edit the URI to specify the correct port
      5. if not user admin, edit the User and Password to specify a member of the administrators user group

The following images show the results of changing the port from 4503 to 6103 by :

Default Agent (publish)

file

Reverse Replication Agent (publish reverse)

file

Tunnel Service on Author

When using the author environment to create sitesmodify site properties or manage community members, it is necessary to access members (users) registered in the publish environment, not users registered on author.

The tunnel service provides this access using the replication agent on author.

To enable the tunnel service :

file

Replicate the Crypto Key

Caution

If another security feature has already been configured that is based on the crypto keys, then replicating the crypto keys could damage the configuration.  For assistance, contact customer care.

There are two features of AEM Communities that require all AEM server instances to use the same encryption keys.  These are Analytics and ASRP.

Note

It is important to verify the replication agent on author is correctly configured.

Replicate /etc/key

Using CRXDE Lite :

file

Refresh the Granite Crypto Bundle

file
  • after a moment, a Success dialog should appear :
                Operation completed successfully.
  • it may be necessary to re-login

Apache HTTP Server

If using the Apache HTTP server, ensure that you use the correct server name for all relevant entries.

In particular, be careful to use the correct server name, not localhost, in the RedirectMatch

httpd.conf sample
<IfModule alias_module>
     # XAMPP does not have a favicon; this prevents any 404 errors which may arise.
     Redirect 404 /favicon.ico
     <Location /favicon.ico>
         ErrorDocument 404 "No favicon"
     </Location>

    # Return from "Sign Out" generates response header directing you to "/", generating a 404 error
    # The RedirectMatch resolves it correctly when modified for the target Community Site :
    RedirectMatch ^/$ http://[server name]/content/sites/engage/en.html
 ...
 </IfModule>
        

Code samples are intended for illustration purposes only.

Dispatcher

Related Communities Documentation

  • Visit Administering Communities Sites to learn about creating a community site, configuring community site templates, moderating community content, managing members, and configuring messaging.
  • Visit Developing Communities to learn about the social component framework (SCF) and customizing Communities components and features.

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.