Enabling the Front-End Pipeline

Learn how you can enable the front-end pipeline for existing sites to leverage site themes to more quickly customize your site.

Overview

The front-end pipeline is a mechanism that can quickly deploy just the front-end code of your websites based on site themes and site templates.

Instead of deploying the full-stack, only front-end code is handled by this pipeline making the process faster and also allows front-end developers to easily and quickly customize your site without knowledge of AEM.

Sites based on site templates can leverage the front-end pipeline by default. This document describes how you can adapt your existing sites to take advantage of the front-end pipeline.

TIP

If you are not familiar with the front-end pipeline and how to quickly deploy sites using it and site templates, please review the Quick Site Creation journey for an introduction.

If you have not created your existing site based on site templates and themes, AEM can configure your site to load the themes that are deployed with the Front End Pipeline on top of the existing client libraries.

Technical Details

When you activate the front-end pipeline for a site, AEM makes the following changes to your site structure.

  • All pages of the site will include one additional CSS and JS file, which can be modified by deploying updates through a dedicated Cloud Manager front-end pipeline.
  • The added CSS and JS files will initially be empty, but a “theme sources” folder can be downloaded to bootstrap the folder structure that allows to deploy CSS and JS code updates via that pipeline.
  • This change can only be undone by a developer, by deleting the SiteConfig and HtmlPageItemsConfig nodes that this operation creates below /conf/<site-name>/sling:configs.
NOTE

This action won’t automatically convert the existing client libraries of the site to use the font-end pipeline. Moving these sources from the client library folder to the front-end pipeline folder is a task that requires manual work by a front-end developer.

Requirements

AEM can automatically adapt your existing site to use the front-end pipeline. To be able to do this, your site must use v2 or newer of the Page Component of the Core Components.

Enabling Front-End Pipeline

Enabling your site is done from the Sites console using the Site rail.

  1. Log into AEM and navigate to your site via Global Navigation > Sites.

  2. Select your site in the console. You must select the root of the site and not any child pages.

  3. With your site selected, open the rail selector at the left and choose Site.

  4. In the Site rail, click the button Enable Front End Pipeline.

    Enable front-end pipeline

  5. AEM prompts you to confirm with an overview of the changes that will be made. Confirm and your site is adapted.

Now your site is ready to use the front-end pipeline. To learn more about the front-end pipeline and managing your site theme see:

On this page