WebSphereへのインストール

WebSphereにLiferay DXPをインストールするには、DXP WARのインストール、依存関係のインストール、WebSphereの構成、およびDXPの開始が必要です。データベースとメールサーバーの接続も設定する必要があります。

IBM® WebSphere®はInternational Business Machines Corporationの商標であり、世界中の多くの国で登録されています。

tip

このインストールおよび設定プロセス全体を通して、WebSphereは［Save］をクリックして変更をマスター構成に適用するようにプロンプトを出します。変更を保存するには、この操作が必要です。

前提条件

Liferay DXPが正しく機能するには、WebSphere 9(フィックスパック11以降）がインストールされている必要があります。フィックスパックについて詳しくは、 IBMサポートにアクセスしてください。 Liferay DXPは現在、WebSphere Application Liberty Profileをサポートしていません。

important

DXPをインストールする前に、 Liferay-Tomcatバンドルのインストールおよびデータベースの設定の記事を確認してください。

次のファイルは、WebSphereアプリケーションサーバーにLiferay DXPをインストールするために必要であり、ヘルプセンター (サブスクリプション）または Liferayコミュニティのダウンロードから入手できます。

DXP WARファイル
OSGi依存関係のZIPファイル
依存関係のZIPファイル(DXP 7.3以前）

Liferay DXPにはJava JDK 8または11が必要です。 JDKを選択するには、互換性マトリックスを参照してください。推奨される設定については、 JVM設定を参照してください。

［Liferay Home］ フォルダーは、Liferay DXPが機能するために必要なファイルとフォルダーを格納および管理する場所です。 WebSphereでは、［Liferay Home］フォルダは通常［Install Location］/WebSphere/AppServer/profiles/［your-profile］/liferayです。

WebSphereの構成

WebSphereプロファイルの作成

アプリケーションサーバーのバイナリがインストールされたら、 プロファイル管理ツール を起動して、DXPに適したプロファイルを作成します。

［Create…］をクリックし、［Application Server］を選択して、［Next］をクリックします。
［拡張プロファイルの作成オプション］をクリックし、［Next］をクリックします。拡張プロファイルを使用して、プロファイルの場所やプロファイルの名前、ノードとホストなどの設定値を指定したり、特定のポートを割り当てたり、オプションで管理コンソールとサンプルアプリケーションをデプロイするかどうか、またWeb IBM HTTP ServerのWebサーバー定義を追加するかどうかを選択します。これらのオプションの詳細は、WebSphereのドキュメントを参照してください。
［Deploy the administrative console］ボックスをオンにします。これにより、アプリケーションサーバーを操作するためのWebベースのUIが有効になります。デフォルトのアプリケーションをスキップします。 (これらは開発マシンにのみインストールしてください。）［Next］をクリックします。
プロファイル名と場所を設定します。環境に適したパフォーマンス調整設定を指定します。

note

パフォーマンス調整設定の詳細は、WebSphereのドキュメントを参照してください。［Next］をクリックします。
サーバーのノード、サーバー、およびホスト名を選択します。これらは、ユーザーの環境に合わせたものです。［Next］をクリックします。
WebSphereの管理セキュリティは、管理ツールへのアクセス権を持つユーザーを制限する方法です。環境でこの方法を有効にすることで、WebSphereサーバーの管理にユーザー名とパスワードが必要となるようにできます。詳細は、WebSphereのドキュメントを参照してください。［Next］をクリックします。
各プロファイルには、ウィザードの次に表示されるセキュリティ証明書が必要です。証明書をまだ生成していない場合は、個人証明書と署名証明書を生成するオプションを選択し、［Next］をクリックします。
証明書が生成されたら、キーストアのパスワードを設定します。［Next］をクリックします。
このサーバープロファイルが使用するポートをカスタマイズできます。マシンで開いているポートを選択してください。ポートを選択すると、ウィザードは既存のWebSphereインストールを自動的に検出し、アクティビティが見つかると、ポートを1つ増やします。
マシンの起動時にこのプロファイルを開始するかどうかを選択します。［Next］をクリックします。
WebSphereにはIBM HTTP Serverが付属しています。このJVMがHTTPサーバーから転送された要求を受信できるように、Webサーバー定義が必要かどうかを選択します。詳細は、WebSphereのドキュメントを参照してください。完了したら、［Next］をクリックします。
ウィザードに選択された内容の概要が表示され、選択内容を保持したり、前の画面に戻って内容を変更したりできます。完了したら、［Next］をクリックします。

WebSphereはプロファイルを作成し、プロファイルが正常に作成されたことを示すメッセージで終了します。

図2：プロファイルを作成する前の設定例

最後に、アプリケーションサーバーをシャットダウンします。

このバージョンのWebSphereでは、サーブレットフィルターはWebアプリケーションの起動時ではなく、最初のアクセス時に初期化されます。これにより、特定のアプリをDXPにデプロイするときに問題が発生する可能性があります。アプリケーションの起動時(つまり、デプロイ時）に初期化するようにサーブレットフィルターを構成するには、WebSphereアプリケーションサーバーで以下のwebcontainerプロパティを設定します。

com.ibm.ws.webcontainer.initFilterBeforeInitServlet = true
com.ibm.ws.webcontainer.invokeFilterInitAtStartup = true

WebSphereアプリケーションサーバーでwebcontainerプロパティを設定するには、WebSphereのドキュメンテーションの指示に従ってください。

Liferay DXPのJVMパラメータの設定

次のファイルの変更から始めます。

[Install Location]/WebSphere/AppServer/profiles/your-profile/config/cells/your-cell/nodes/your-node/servers/your-server/server.xml

ベースラインとして、jvmEntriesタグ内にmaximumHeapSize="2560"を追加します。以下に例を示します。

<jvmEntries xmi:id="JavaVirtualMachine_1183122130078" ... maximumHeapSize="2560">

note

DXPのインストール後、これらの構成(これらのJVMオプションを含む）をさらに調整して、パフォーマンスを向上させることができます。詳細については、 Liferayの調整および JVMの調整を参照してください。

server.xmlの<jvmEntries genericJvmArguments=.../>属性でUTF-8プロパティを設定できます。これは必須です。設定しないと、国際文字は正しく解析されません。ヒープサイズの最大値と最小値も増やします。 jvmEntriesタグ内に以下を追加します。

<jvmEntries xmi:id="JavaVirtualMachine_1183122130078" ...genericJvmArguments="-Dfile.encoding=UTF-8 -Djava.locale.providers=JRE,COMPAT,CLDR -Djava.net.preferIPv4Stack=true -Dlog4j2.formatMsgNoLookups=true -Duser.timezone=GMT -Xms6144m -Xmx6144m -XX:MaxNewSize=1536m -XX:MaxMetaspaceSize=768m -XX:MetaspaceSize=768m -XX:NewSize=1536m -XX:SurvivorRatio=7">

important

DXPが適切に機能するには、アプリケーションサーバーJVMがGMTタイムゾーンとUTF-8ファイルエンコーディングを使用する必要があります。

Javaオプションとメモリ引数について以下に説明します。

JVMオプションの説明

オプション	説明
`-Dfile.encoding=UTF-8`	DXPにはUTF-8ファイルエンコーディングが必要です。
`-Djava.locale.providers=JRE,COMPAT,CLDR`	これは、JDK 11で4桁の日付を表示するために必要です。
`-Djava.net.preferIPv4Stack=true`	IPv6よりもIPv4スタックを優先します。
`-Dlog4j2.formatMsgNoLookups=true`	リモートコード実行(RCE）の脆弱性を解決します。詳細は、 LPS-143663 を参照してください。
`-Duser.timezone=GMT`	DXPでは、アプリケーションサーバーのJVMがGMTタイムゾーンを使用する必要があります。

メモリ引数の説明

メモリ引数	説明
`-Xms`	ヒープの初期スペース。
`-Xmx`	ヒープの最大スペース。
`-XX:NewSize`	最初の新しいスペース。通常、新しいサイズをヒープ全体の半分に設定すると、より小さな新しいサイズを使用するよりもパフォーマンスが向上します。
`-XX:MaxNewSize`	最大の新しいスペース。
`-XX:MetaspaceSize`	静的コンテンツ用の初期スペース。
`-XX:MaxMetaspaceSize`	静的コンテンツ用の最大スペース。
`-XX:SurvivorRatio`	新しいスペースとSurvivor領域の比率。 Survivor領域は、古い世代の領域に昇格する前に、若い世代のオブジェクトを保持します。

`secureSessionCookie`タグの削除

同じプロファイルで、DXP起動エラーの原因となる可能性のあるsecureSessionCookieタグを削除します。これは単なるデフォルト設定であることに注意してください。 DXPがインストールされたら、使用環境に基づいてWebSphereを適切に調整してください。

［Install Location］/WebSphere/AppServer/profiles/your-profile/config/cells/your-cell/cell.xmlで、xmi:id="SecureSessionCookie_1"を含むsecureSessionCookieタグを削除します。

このタグを削除しないと、次のようなエラーが発生する可能性があります。

WSVR0501E: Error creating component com.ibm.ws.runtime.component.CompositionUnitMgrImpl@d74fa901
com.ibm.ws.exception.RuntimeWarning: com.ibm.ws.webcontainer.exception.WebAppNotLoadedException: Failed to load webapp: Failed to load webapp: SRVE8111E: The application, LiferayEAR, is trying to modify a cookie which matches a pattern in the restricted programmatic session cookies list [domain=*, name=JSESSIONID, path=/].

構成チェックポイント

この時点で、次の手順が完了している必要があります。

WebSphereアプリケーションサーバーのプロファイルが作成されている。
サーブレットフィルターが、webcontainer設定でアプリケーションの起動時に初期化するように構成されている。
JVMパラメータがserver.xmlファイルに設定されている。
ファイルのエンコーディングとしてUTF-8が設定されている。
サーバーのタイムゾーンがGMTに設定されている。
secureSessionCookieタグが削除されている。

依存関係のインストール

OSGi依存関係ZIPファイルを解凍し、その内容を［Liferay Home］/osgiフォルダに置きます(まだ存在しない場合は、このフォルダを作成します)。 LiferayのOSGiランタイムは、これらのモジュールに依存しています。
DXP 7.4+ WARファイルには、MariaDBおよびPostgreSQLのドライバーが含まれています。以前のDXP WARにはそれらがありません。 7.4以降のWARに、使用中のサポートされているデータベースのドライバーがない場合は、DXP WARを任意の場所に解凍し、データベースベンダーのJDBC JARファイルを展開されたDXP WARのWEB-INF/shielded-container-libフォルダーに配置し、DXP WARを再度圧縮します。

サポートされているデータベースの一覧については、互換性マトリックスを参照してください。

note

HypersonicデータベースはDXPにバンドルされており、テスト目的に役立ちます。本番環境インスタンスにはHSQLを使用しないでください。

note

DXP 7.3以前の場合は、依存関係のZIPファイルを解凍し、そのコンテンツをWebSphereアプリケーションサーバーの[Install Location]/WebSphere/AppServer/lib/extフォルダに配置します。データベースベンダーのJDBC JARファイルもこのフォルダに入れてください。

Elasticsearchのインストール

Liferayを起動すると、デフォルトのsidecar Elasticsearchサーバーがインストールされて起動します。 WebSphereにインストールするときは、最初からリモートElasticsearchサーバーをセットアップする必要があります。 Elasticsearchを開始するを参照してください。

Elasticsearchが既に構成済みで実行されている状態でLiferay DXPを構成して(Elasticsearchコネクターの.configファイルを使用）開始すると、Elasticsearchへの接続が有効になります。

DXP portlet.jarのインストール

DXPのportlet.jar(バージョン3）は、バージョン2.0との下位互換性があります。 DXP 7.4 .warにはportlet.jarが含まれており、以前のDXPバージョンの依存関係ZIPにも含まれています。 WebSphereのportlet.jarバージョン2.0をオーバーライドする必要があります。

[インストール場所]/WebSphere/AppServer/profiles/your-profile/フォルダに、app_shared_librariesというフォルダを作成します。
DXP WAR(7.4以降）または[インストール場所] /WebSphere/AppServer/lib/extフォルダからDXP portlet.jarを、作成したapp_shared_librariesフォルダにコピーします。
サーバーに関連付けられた共有ライブラリを使用するためのIBMの手順に従ってください。手順4dで、 最初にローカルクラスローダー(parent_Last）がロードされたクラス を選択してください。
設定を保存します。

DXP Portlet.jarが最初に読み込まれるようにする

DXPのportlet.jarをサーバーに関連付けられた共有ライブラリに配置することに加えて、config.iniファイルを最初にロードされるように構成します。

[インストール場所]/WebSphere/AppServer/configuration/config.iniファイルを開きます。
プロパティcom.ibm.CORBA,com.ibmを検索します。
プロパティjavax.portlet,javax.portlet.filter,javax.portlet.annotationsをcom.ibm.CORBAの後、com.ibmの前に挿入します。
ファイルを保存します。

依存関係チェックポイント

DXP依存関係がインストールされている。
DXPのportlet.jarがインストールされている。
config.iniファイルが設定されている。

アプリケーションサーバープロファイルを起動します。

データベース設定

DXPには組み込みのHypersonicデータベースが含まれています。これはデモンストレーション目的には最適ですが、本番環境では使用しないでください。デモの目的以外に、フル機能のサポートされているRDBMSを使用することをお勧めします。データベースのセットアップについては、データベースの設定を参照してください。

Liferay DXPは、DXPに組み込まれているデータソースを使用する(推奨）か、アプリケーションサーバー上に作成したデータソースを使用してデータベースに接続できます。

初めてDXPを実行するときにDXPの組み込みデータソースをデータベースで設定するには、セットアップウィザードを使用します。または、データベースのデータベーステンプレート基づいて、データソースを portal-ext.properties ファイルで構成できます。

WebSphereを使用してデータベース接続を管理する場合は、以下の手順に従ってください。それ以外の場合、DXPの組み込みデータソースを使用する場合は、このセクションをスキップしてください。

warning

Liferayは、デモ目的でデフォルトでHSQLを使用しています。 HSQLは、Liferay DXPの本番環境インスタンスでは使用しないでください。

図3：WebSphere JDBCプロバイダー

DXP WAR(7.4以降）またはデータベースベンダーからJDBC JARを入手し、[インストール場所]/WebSphere/AppServer/lib/extフォルダにコピーします。
WebSphereを起動します。
管理コンソールを開き、ログインします。
［Resources］ → ［JDBC Providers］をクリックします。
スコープを選択し、［New］をクリックします。
データベースの種類、プロバイダーの種類、実装の種類を選択します。事前定義されたデータベースを選択すると、ウィザードによって名前と説明のフィールドが自動的に入力されます。目的のデータベースがリストにない場合は、［データベースの種類］フィールドから［User-defined］を選択して、［Implementation Class Name］を入力します。たとえば、MySQLを使用している場合は、［データベースの種類］ → ［User-defined］を選択し、［Implementation Class Name］にcom.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSourceと入力します。［Next］をクリックします。
クラスパス設定のテキストをすべてクリアします。必要なJARは、サーバーのクラスパス上の場所にすでにコピーされています。［Next］をクリックします。
設定を確認し、［Finish］をクリックします。最終的な構成は次のようになります。
新しいプロバイダー構成が表に表示されたらクリックします。
［Additional Properties］の下の［Data Sources］をクリックします。
［New］をクリックします。
［データソース名］フィールドにliferaydatabasesourceと入力し、［JNDI name］フィールドにjdbc/LiferayPoolと入力します。［Next］をクリックします。
ウィザードの残りの画面で［Next］をクリックして、デフォルト値を受け入れます。次にすべての変更を確認し、［Finish］をクリックします。
データソースが表に表示されたらクリックし、［Custom Properties］をクリックします。
［Show Filter Function］ボタンをクリックします。このボタンは、［New］ボタンと［削除］ボタンの下にある小さいアイコンの最後から2番目です。
user を検索語句に入力し、［Go］をクリックします。
user プロパティを選択し、ユーザー名の値をデータベースに付与します。
［OK］をクリックして、マスター構成に保存します。
url プロパティに対して別のフィルター検索を実行します。このプロパティに、データベースを指す値を指定します。たとえば、MySQLのURLは次のようになります。
```
jdbc:mysql://localhost/lportal?useUnicode=true&characterEncoding=UTF-8&useFastDateParsing=false
```
tip

URLの例については、データベーステンプレートのjdbc.default.urlの値を参照してください。

［OK］をクリックして、マスター構成に保存します。
password プロパティに対して別のフィルター検索を実行します。このプロパティの値として、前に追加したユーザーIDのパスワードを入力します。［OK］をクリックして、マスター構成に保存します。
パンくずリストでデータソースページをクリックして、そのページに戻ります。［Test Connection］ボタンを使用して、この時点までの構成を検証します。
[Liferay_Home] のportal-ext.propertiesファイルで、データソースを指定します。例:
```
jdbc.default.jndi.name=jdbc/LiferayPool
```

メール設定

DXPの組み込みメールセッションを使用する場合は、このセクションをスキップしてください。 DXPの組み込みメールセッションの使用方法については、メールの設定の記事をご覧ください。

WebSphereを使用してメールセッションを管理する場合は、次の手順に従います。

WebSphere管理のメールセッションの作成

［Resources］ → ［Mail］ → ［Mail Providers］の順にクリックします。
ノードとサーバーの組み込みメールプロバイダーをクリックします。
［Mail Sessions］をクリックし、［New］ボタンをクリックします。
メールセッションにliferaymailの名前とmail/MailSessionのJNDI名を付けます。［Outgoing Mail Properties］セクションと［Incoming Mail Properties］セクションにメールサーバーの正しい情報を入力します。［OK］をクリックして、マスター構成に保存します。
表に表示されたメールセッションをクリックし、［Additional Properties］セクションの下で［Custom Properties］を選択します。プロトコル、ポート、SSLを使用するかどうかなど、メールサーバーに必要なその他のJavaMailプロパティを設定します。
［セキュリティ］ → ［グローバルセキュリティ］をクリックし、［Use Java 2 security to restrict application access to local resources］が選択されている場合は選択を解除します。
［適用］をクリックします。
Liferay Homeのportal-ext.propertiesファイルで、メールセッションを指定します。例:
```
mail.session.jndi.name=mail/MailSession
```

メールサーバーからSSL証明書を取得し、それをWebSphereのトラストストアに追加する必要がある場合があることに注意してください。この手順については、WebSphereのドキュメントを参照してください。

WebSphereメールプロバイダーの検証

メールセッションが正しく構成されていることを検証するには、WARがデプロイされ、サーバーが起動し、ユーザーがシステム管理者としてサインインした後で、これをテストする方法がいくつかあります。検証する簡単な方法の1つは、有効なメールアカウントで新しいユーザーを作成することです。新しく作成されたユーザーは、電子メール通知を受信します。ログには、リストされている正しいポート番号でSMTPサーバーがpingされていることが表示されます。

HTTPセッションのCookieを有効にする

WebSphereでは、デフォルトでCookieをHTTPSセッションに制限しています。 HTTPを使用している場合、ユーザーはDXPにサインインできなくなり、コンソールに次のエラーが表示されます。

20:07:14,021 WARN  [WebContainer : 1][SecurityPortletContainerWrapper:341]
User 0 is not allowed to access URL http://localhost:9081/web/guest/home and portlet com_liferay_login_web_portlet_LoginPortlet

これは、HTTPの使用時にDXPがHTTPS Cookieを使用できないために発生します。その結果、ページが更新されるたびに新しいセッションが作成されます。 WebSphereでこの問題を解決するには、以下の手順に従ってください。

［アプリケーションサーバー］ → ［server1］ → ［Session Management］ → ［Enable Cookies］の順にクリックします。
［Restrict cookies to HTTPS sessions］の選択を解除します。
［適用］をクリックします。
［保存］をクリックします。

DXPのデプロイ

WebSphereの管理コンソールで、［アプリケーション］ → ［新規アプリケーション］ → ［New Enterprise Application］の順にクリックします。
DXP .warファイルを参照して選択し、［Next］をクリックします。
［Fast Path］を選択したままにして、［Next］をクリックします。［Distribute Application］がオンになっていることを確認し、もう一度［Next］をクリックします。
DXPをデプロイするWebSphereランタイムまたはクラスター、あるいはその両方を選択します。［Next］をクリックします。
DXPをデプロイする仮想ホストを選択し、［Next］をクリックします。
DXPをルートコンテキスト(/）にマップし、［Next］をクリックします。
目的の metadata-complete属性 設定を選択し、［Next］をクリックします。
設定が正しいことを確認し、［Finish］をクリックします。
DXPがインストールされたら、［Save to Master Configuration］をクリックします。

DXPがインストールされました。 DXPを開始する前に、いくつかの必要な手順があります。

JSPをコンパイルするためのJDKバージョンの設定

DXPでは、JSPをJava 8バイトコード形式にコンパイルする必要があります。 WebSphereがこれを行うようにするには、DXP .warファイルをデプロイした後にWebSphereをシャットダウンします。 WEB_INFフォルダに移動し、次の設定をibm-web-ext.xmlに追加します(ほとんどの場合、ibm-web-ext.xmiファイルです）。

<jsp-attribute name="jdkSourceLevel" value="18" />

ibm-web-ext.xmiファイルへの正確なパスは、WebSphereのインストール場所とDXPのバージョンによって異なりますが、以下に例を示します。

/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/config/cells/localhostNode01Cell/applications/liferayXX.ear/deployments/liferayXX/liferayXX.war/WEB-INF/ibm-web-ext.xmi

DXP .warは、ibm-web-ext.xmiファイルにあらかじめパッケージ化されていることに注意してください。この形式は機能的に.xmlと同じで、WebSphereは両方の形式を認識します。 WebSphereによるJSPのコンパイル方法に関する一般的な情報については、IBMの WebSphere Application Server 9.0.0.x の公式ドキュメントを参照してください。

DXPの開始

セットアップウィザードを使用する場合は、次の手順にスキップしてください。ただし、WebSphereのデータソースとメールセッションを使用していて、セットアップウィザードをバイパスする場合は、portal-ext.propertiesファイルで次のポータルプロパティを設定します。
```
setup.wizard.enabled=false
```
アプリケーションサーバーを起動します。
WebSphere管理コンソールで、［Enterprise Applications］に移動し、DXPアプリケーションを選択して、［Start］をクリックします。 DXPの起動中、WebSphereには回転する図が表示されます。
DXPのセットアップウィザードで、データベースの種類を選択して設定します。［Finish］をクリックします。 DXPは、データベースに必要なテーブルを作成します。

DXPをデプロイした後、PhaseOptimizerに関連する以下のような警告やログメッセージが過剰になることがあります。これらは良性なので、無視しても構いません。このようなログメッセージを回避するために、必ずアプリケーションサーバーのログレベルまたはログフィルターを調整してください。

|     May 02, 2018 9:12:27 PM com.google.javascript.jscomp.PhaseOptimizer$NamedPass process
|     WARNING: Skipping pass gatherExternProperties
|     May 02, 2018 9:12:27 PM com.google.javascript.jscomp.PhaseOptimizer$NamedPass process
|     WARNING: Skipping pass checkControlFlow
|     May 02, 2018 9:12:27 PM com.google.javascript.jscomp.PhaseOptimizer$NamedPass process
|     INFO: pass supports: [ES3 keywords as identifiers, getters, reserved words as properties, setters, string continuation, trailing comma, array pattern rest, arrow function, binary literal, block-scoped function declaration, class, computed property, const declaration, default parameter, destructuring, extended object literal, for-of loop, generator, let declaration, member declaration, new.target, octal literal, RegExp flag 'u', RegExp flag 'y', rest parameter, spread expression, super, template literal, modules, exponent operator (**), async function, trailing comma in param list]
|     current AST contains: [ES3 keywords as identifiers, getters, reserved words as properties, setters, string continuation, trailing comma, array pattern rest, arrow function, binary literal, block-scoped function declaration, class, computed property, const declaration, default parameter, destructuring, extended object literal, for-of loop, generator, let declaration, member declaration, new.target, octal literal, RegExp flag 'u', RegExp flag 'y', rest parameter, spread expression, super, template literal, exponent operator (**), async function, trailing comma in param list, object literals with spread, object pattern rest]

Liferay DXP Enterpriseサブスクリプションをお持ちの場合、DXPはアクティベーションキーを要求します。詳細は、 Liferay DXPのアクティブ化を参照してください。

　 Liferay DXPをWebSphereで実行しています。