フロントエンドパイプラインを有効にする enable-front-end-pipeline
サイトテーマを使用してサイトをより迅速にカスタマイズできるように、既存のサイトのフロントエンドパイプラインを有効にする方法について説明します。
概要 overview
フロントエンドパイプラインは、サイトテーマとサイトテンプレートに基づいて web サイトのフロントエンドコードだけを迅速にデプロイできるメカニズムです。
このパイプラインはフロントエンドコードのみを処理するので、フルスタックデプロイメントよりデプロイメントプロセスが高速になります。これにより、フロントエンド開発者は AEM の知識がなくても、サイトを簡単にカスタマイズできます。
サイトテンプレートに基づくサイトでは、フロントエンドパイプラインをデフォルトで使用できます。このドキュメントでは、フロントエンドパイプラインを利用するように既存のサイトを適応させる方法について説明します。
AEM では、サイトがサイトテンプレートとテーマを使用して作成されていない場合でも、既存のクライアントライブラリの上にテーマをレイヤー化することで、フロントエンドパイプラインでデプロイされたテーマを読み込むようにサイトを設定できます。
技術的詳細 technical-details
サイトのフロントエンドパイプラインを有効にすると、AEM はサイト構造に次のような変更を加えます。
- サイトのすべてのページには、追加の CSS および JS ファイルが 1 つ含まれており、専用の Cloud Manager フロントエンドパイプラインを通じて更新をデプロイすることで、このファイルを変更できます。
- 追加された CSS および JS ファイルは最初は空です。ただし、「テーマソース」フォルダーをダウンロードすると、パイプラインを通じて CSS コードと JS コードの更新をデプロイするために必要なフォルダー構造を設定できます。
- この操作によって
/conf/<site-name>/sling:configs
の下に作成されるSiteConfig
ノードとHtmlPageItemsConfig
ノードを削除することで、変更を取り消すことができるのは、開発者のみです。
要件 requirements
AEM では、フロントエンドパイプラインを使用するように既存のサイトを自動的に適応させることができます。このワークフローを実行するには、サイトでコアコンポーネントのページコンポーネント v2 以降を使用する必要があります。
フロントエンドパイプラインの有効化 enabling
>詳しくは、フロントエンドパイプラインでの Cloud Manager IP 許可リストの使用を参照してください。
サイトを有効にするには、Sites コンソールのサイトパネルを使用して行います。
-
AEM にログインし、グローバルナビゲーション/サイト を使用して Sites コンソールに移動します。
-
サイトをコンソールで選択します。サイトの子ページではなくルートを選択します。
-
サイトが選択された状態で、左側のパネルセレクターを開き、「サイト」を選択します。
-
サイト パネルで「フロントエンドパイプラインを有効化」ボタンをクリックします。
-
実行される変更の概要が表示され、AEM から確認を求められます。確認すると、サイトに適応されます。
これで、サイトでフロントエンドパイプラインを使用する準備が整いました。フロントエンドパイプラインとサイトテーマの管理について詳しくは、以下を参照してください。
- サイトパネルを使用したサイトテーマの管理
- クイックサイト作成ジャーニー - このドキュメントジャーニーでは、フロントエンドパイプラインとクイックサイト作成ツールを使用してサイトを迅速にデプロイするプロセスの包括的な概要を示しています。
- CI/CD パイプライン - このドキュメントでは、フルスタックパイプラインおよび web 階層設定パイプラインとの関連でフロントエンドパイプラインについて説明しています。
フロントエンドパイプラインとカスタムドメイン custom-domains
フロントエンドパイプラインは Cloud Manager のカスタムドメイン機能と共に使用できますが、2 つの機能を一緒に使用する場合は、次の要件に注意してください。
静的フロントエンドファイル static-files
フロントエンドパイプライン経由でデプロイされた静的フロントエンドアセットは、デフォルトでは、アドビの事前定義済み静的ドメインから提供されます。
フロントエンドアセットにカスタムドメインが必要な場合は、パブリッシュ層にカスタムドメインをインストールし、Dispatcher を設定して、特定のパス(/static/
など)をアドビの静的ホスティングの場所にルーティングできます。この方法では、静的アセットのリクエストを適切に転送およびキャッシュするのに、Dispatcher ルールを更新する必要があります。
カスタムドメインと Dispatcher を設定したら、AEM を設定して、静的ドメインからフロントエンドアセットを提供できます。
設定 configuration
技術的詳細の節に従って、サイトのフロントエンドパイプライン機能をアクティブ化すると、/conf/<site-name>/sling:configs
の下に SiteConfig
ノードと HtmlPageItemsConfig
ノードが作成されます。
ステータスアセット用のフロントエンドパイプラインと共にサイトに Cloud Manager のカスタムドメイン機能を使用する場合は、これらのノードに追加のプロパティを追加する必要があります。
-
サイトの
SiteConfig
にcustomFrontendPrefix
プロパティを設定します。/conf/<site-name>/sling:configs/com.adobe.aem.wcm.site.manager.config.SiteConfig
に移動します。- プロパティ
customFrontendPrefix = "https://your-custom-domain.com/static/"
を追加または更新します。
-
これにより、
HtmlPageItemsConfig
のprefixPath
値がカスタムドメインで更新されます。-
/conf/<site-name>/sling:configs/com.adobe.cq.wcm.core.components.config.HtmlPageItemsConfig
に移動します。 -
prefixPath
がカスタムドメインを反映していることを確認します(例:prefixPath = "https://your-custom-domain.com/static/<hash>/..."
)。
- この値は、必要に応じて手動で上書きすることもできます。
-
-
設定を確認します。
- デプロイメント後、ページがカスタムドメインのテーマアーティファクトを正しく参照していることを確認します。
- ブラウザーの開発者ツールを開き、
theme.css
およびtheme.js
ファイルのパスを調べて、正しいドメインから読み込まれていることを確認します。
その後、サイトのページは、更新された URL からテーマアーティファクトを参照します。次に、Dispatcher はこれらのリソースに対するリクエストを静的ドメインにルーティングします。
フロントエンド開発者向けのベストプラクティス best-practices
フロントエンドパイプライン経由でデプロイする前に、フロントエンドアセットをローカルで開発およびテストする必要がある場合は、次のアプローチを考慮します。
- Site Theme Builder のプロキシモードを使用して、テーマアーティファクトをローカルで上書きし、テストします。
- ローカル開発サーバーからテーマファイルを手動で提供し、
HtmlPageItemsConfig
のprefixPath
を更新して、ローカルサーバーアドレスと一致させます。 - テスト中にブラウザーのキャッシュが無効になっていることを確認して、ライブ更新を確認します。
ローカルフロントエンド開発について詳しくは、Site Theme Builder ドキュメントを参照してください。