Enabling the Front-End Pipeline enable-front-end-pipeline

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

Overview 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.

This pipeline handles only front-end code, making the deployment process faster than full-stack deployments. It allows front-end developers to customize your site easily without needing knowledge of AEM.

Sites based on site templates can use 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 deploy sites quickly using it and site templates, see Quick Site Creation Journey for an introduction.

AEM can configure your site to load themes deployed with the Front End Pipeline, even if your site was not created using site templates and themes, by layering them on top of existing client libraries.

Technical Details 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 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 are empty initially. However, you can download a “theme sources” folder to set up the folder structure needed to deploy CSS and JS code updates through the pipeline.
  • Only a developer can undo the change, by deleting the SiteConfig and HtmlPageItemsConfig nodes that this operation creates below /conf/<site-name>/sling:configs.
NOTE
This action does not 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 requirements

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

Enabling Front-End Pipeline enabling

IMPORTANT
If you use—or intend to use—the front-end pipeline to develop sites, the Cloud Manager IP Allow List must be added beforehand.
See Use of the Cloud Manager IP Allow List with the 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. 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 are 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:

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab