Customizing Liferay DXP in the Cloud
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

クライアント拡張機能用のLiferay PaaSの設定

ベータ機能

クライアント拡張機能 は、クラウド環境で Liferay DXP にさまざまなカスタマイズや変更を展開するのに最適な方法です。 クライアント拡張機能を使用する場合の Liferay PaaS の構成要件を次に示します。

クライアント拡張ビルドパイプライン

クライアント拡張機能を使用するには、 インフラ 環境に 2 つのビルド パイプラインが存在している必要があります。

クライアント拡張機能を展開するには、個別のパイプラインが必要です。

クライアントエクステンション用の追加パイプラインがない場合は、Liferay Cloud Supportに連絡して、あなたの環境のクライアントエクステンションを有効にしてください。

必要なサービスバージョン

環境で古いクラウド サービス バージョンを使用している場合、Liferay PaaS でクライアント拡張機能を使用できません。 サービスが以下のバージョンより古い場合は、( LCP.json ファイル経由で) サービスを更新する必要があります。

  • CI サービス: liferaycloud/jenkins:2.479.2-lts-jdk21-6.0.0
  • Liferay サービス: liferaycloud/liferay-dxp:7.4-5.8.4

プロジェクトワークスペースの liferay/gradle.properties ファイルで、Liferay DXP が 少なくとも バージョン 2024.q2.0liferay.workspace.docker.image.liferay プロパティを使用)を使用するように設定されていることも確認する必要があります。

クライアント拡張機能をデプロイする前に、すべてのサービスを更新した後 、Liferay DXP サービスを再デプロイしてください

Webサーバーの構成

デフォルトでは、Liferay PaaS のすべての非本番環境では、アクセスするために基本認証(Web ブラウザ経由)が必要です。 この要件により、開発環境が保護され、サイトの開発者だけが閲覧できるようになります。

ただし、基本認証の要件により、クライアント拡張機能はデフォルトでサービス間で通信できなくなります。 クライアント拡張機能がこの制約を回避できるように、Web サーバー上で例外を構成することができます。

  1. プロジェクトのリポジトリで、目的の環境の webserver/configs/<ENV>/conf.d/ フォルダーに移動します (例: webserver/configs/dev/conf.d/)。

  2. proxy.includeという新しいファイルを追加します。

    touch proxy.include
    
  3. これらの内容をコピーして proxy.include ファイルに保存します。

    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
    proxy_set_header X-Forwarded-Port $http_x_forwarded_port;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $http_x_forwarded_for;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection $http_connection;
    proxy_hide_header liferay-portal;
    
    proxy_pass http://upstream_server;
    proxy_http_version 1.1;
    proxy_intercept_errors on;
    
  4. 同じフォルダで、 liferay.conf ファイルを編集し、内容を次のように置き換えます。

    location /o {
        include /etc/nginx/conf.d/proxy.include;
    }
    
    location / {
        auth_basic "Authentication Required";
        auth_basic_user_file /var/www/html/.htpasswd;
    
        include /etc/nginx/conf.d/proxy.include;
    }
    
  5. これらの変更を保存してリポジトリにコミットします。

    git commit -m "Configure dev web server for client extensions."
    
  6. 通常のワークフローを使用してビルドをプッシュし、選択した環境にデプロイします

ビルドが完了すると、Web サーバーはクライアント拡張機能が Liferay DXP サービスと通信できるように構成されます。

互換性のないLiferay DXP構成

Liferay DXP の特定の構成は、クライアント拡張機能と互換性がありません。 環境にクライアント拡張機能を展開するときに問題を回避するには、これらの構成を削除します。

環境変数

LIFERAY_COMPANY_PERIOD_DEFAULT_PERIOD_VIRTUAL_PERIOD_HOST_PERIOD_NAME
LIFERAY_COMPANY_PERIOD_DEFAULT_PERIOD_VIRTUAL_PERIOD_HOST_PERIOD_SYNC_PERIOD_ON_PERIOD_STARTUP
LIFERAY_MODULE_PERIOD_FRAMEWORK_PERIOD_PROPERTIES_PERIOD_ORG_PERIOD_APACHE_PERIOD_FELIX_PERIOD_CONFIGADMIN_PERIOD_PLUGIN_PERIOD_INTERPOLATION_PERIOD_SECRETSDIR
LIFERAY_VIRTUAL_PERIOD_HOSTS_PERIOD_VALID_PERIOD_HOSTS
LIFERAY_WEB_PERIOD_SERVER_PERIOD_PROTOCOL

OSGiの構成

"com.liferay.portal.http.internal.configuration.HttpConfiguration",
"com.liferay.portal.k8s.agent.override.OverridePortalK8sAgentConfiguration",
"com.liferay.portal.workflow.configuration.WorkflowDefinitionConfiguration"

ポータルプロパティ

company.default.virtual.host.name
company.default.virtual.host.sync.on.startup
module.framework.properties.org.apache.felix.configadmin.plugin.interpolation.secretsdir
virtual.hosts.valid.hosts
web.server.protocol