JBoss EAPへのインストール
JBoss EAPにインストールするには、DXP WARのインストール、依存関係のインストール、JBossの設定、およびJBossへのDXPのデプロイが必要です。 データベースとメールサーバーの接続も設定する必要があります。
前提条件
Liferay DXPにはJava JDK 8または11が必要です。 詳細は、 互換性マトリクス を参照してください。
これらのファイルを ヘルプセンター (サブスクリプション)または Liferayコミュニティダウンロード からダウンロードします。
- DXP WARファイル
- OSGi依存関係のZIPファイル
- 依存関係のZIPファイル(DXP 7.3以前)
インストール手順では、これらの用語を使用しています。
[Liferay Home]
:JBossサーバーフォルダを含むフォルダ( $JBOSS_HOME
と表記されています。) DXPをインストールしてデプロイした後、data
、deploy
、およびlogs
フォルダを生成します。
$JBOSS_HOME
:JBossサーバーフォルダー。 通常、jboss-eap-[version]
という名前です。
DXP WARのインストール
- クリーンなJBossインストールを開始していて、
$JBOSS_HOME/standalone/deployments/ROOT.war
フォルダが存在する場合は、そのすべてのサブフォルダとファイルを削除します。 - DXP WARファイルを
$JBOSS_HOME/standalone/deployments/ROOT.war
フォルダに解凍します(このフォルダが存在しない場合は作成します)。
WAR ファイル名を変更することで、デフォルトの Liferay Portal の Web コンテキストを変更することができますが(例えば localhost:8080/
から localhost:8080/myportal
)、これは推奨しません。
依存関係のインストール
-
OSGi Dependencies ZIPファイルを
[Liferay Home]/osgi
フォルダーに解凍します(このフォルダーが存在しない場合は作成します)。 LiferayのOSGiランタイムは、これらのモジュールに依存しています。 -
DXP 7.4+ WARファイルには、MariaDBおよびPostgreSQLのドライバーが含まれています。 以前のWARにはそれらがありません。 7.4以降のWARに、使用中のサポートされているデータベースのドライバーがない場合は、データベースベンダーのJDBC JARファイルをダウンロードして、
$JBOSS_HOME/standalone/deployments/ROOT.war/WEB-INF/shielded-container-lib
フォルダーに配置します。サポートされているデータベースの一覧については、 互換性マトリックス を参照してください。
DXPには、テスト目的に役立つHypersonicデータベースが含まれています。 本番環境インスタンスにはHSQLを使用しないでください。
以前のバージョンの依存関係をインストールする
DXP 7.3以前の場合は、次の追加手順に従います。
-
依存関係のZIPファイルを
$JBOSS_HOME/modules/com/liferay/portal/main
フォルダに解凍します(このフォルダが存在しない場合は作成します)。 -
$JBOSS_HOME/modules/com/liferay/portal/main
フォルダにmodule.xml
というファイルを作成します。 ファイルで、ポータルモジュールとそれに必要なすべてのリソースと依存関係を宣言します。<?xml version="1.0"?> <module xmlns="urn:jboss:module:1.0" name="com.liferay.portal"> <resources> <resource-root path="[place your database vendor's JAR file name here]" /> <resource-root path="[place a Liferay dependencies ZIP JAR file name here]" /> <!-- Add a resource-root element for each Liferay dependencies ZIP JAR --> </resources> <dependencies> <module name="javax.api" /> <module name="javax.mail.api" /> <module name="javax.servlet.api" /> <module name="javax.servlet.jsp.api" /> <module name="javax.transaction.api" /> </dependencies> </module>
[place your database vendor's JAR file name here]
をデータベースのドライバーJARに置き換えます。Liferay依存関係ZIPのJARごとに、
path
属性がJAR名に設定されたresource-root
要素を追加します。 たとえば、com.liferay.petra.concurrent.jar
ファイルに次のようなresource-root
要素を追加します。<resource-root path="com.liferay.petra.concurrent.jar" />
スタンドアロンモードとドメインモードのJBoss EAPでのDXPの実行
JBoss EAPは、 スタンドアロン モードまたは ドメイン モードのいずれかで起動できます。 ドメインモードでは、単一のコントロールポイントから複数のアプリケーションサーバーインスタンスを管理できます。 このようなアプリケーションサーバーのコレクションは、 ドメイン と呼ばれます。 スタンドアロンモードとドメインモードの詳細については、 JBoss EAP Product Documentation のこのトピックに関するセクションを参照してください。
DXPは、スタンドアロンモードで実行する場合はJBoss EAPをサポートしますが、ドメインモードで実行する場合はサポートしません。 JBossはファイル(展開または非展開)をコピーして管理対象デプロイメントのコンテンツを管理するため、DXPの自動展開は管理対象デプロイメントでは機能しません。 これにより、JSPフックとExtプラグインが意図したとおりに機能しなくなります。 たとえば、DXPのJSPオーバーライドメカニズムはアプリケーションサーバーに依存しているため、JSPフックは管理対象ドメインモードで実行されているJBoss EAPでは機能しません。 ただし、JSPフックとExtプラグインは非推奨であるため、使用していない可能性があります。
ドメインモードの展開を使用する場合は、コマンドラインインターフェースを使用します。
これにより、DXPが複数のJBossサーバー上のクラスター環境で実行されるのを防ぐことはできません。 スタンドアロンモードで実行されているJBoss EAPサーバーで実行されているDXPインスタンスのクラスターを設定できます。 詳細については、クラスタリングの記事 を参照してください。
JBossの構成
JBossの構成手順は次のとおりです。
- 環境変数を設定する
- プロパティと記述子を指定する
- 不要な構成を削除する
$JBOSS_HOME/standalone/configuration/standalone.xml
に次の変更を加えます。
-
JSPにJava 8 VM互換を使用するようにサーブレットコンテナを設定します。 デフォルトサーブレットコンテナを
<servlet-container name="default">``<subsystem xmlns="urn:jboss:domain:undertow:12.0" ...
要素で探し出します。 サーブレットコンテナの<jsp-config>
要素に、development
、source-vm
、target-vm
属性を以下のように設定します。<jsp-config development="true" source-vm="1.8" target-vm="1.8" />
-
</extensions>
の終了タグを見つけます。 その終了タグの直下に、まだ存在していなければ、以下のシステムプロパティを挿入します。<system-properties> <property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8" /> <property name="org.apache.catalina.connector.USE_BODY_ENCODING_FOR_QUERY_STRING" value="true" /> </system-properties>
-
ログから
WFLYSRV0059
とWFLYEE0007
のメッセージを除外します。<subsystem xmlns="urn:jboss:domain:logging:8.0">
要素の<console-handler>
タグの中に、<level name="INFO"/>
タグの直下に次の<filter-spec>
タグを追加します。<filter-spec value="not(any(match("WFLYSRV0059"),match("WFLYEE0007")))" />
-
deployment-timeout="600"
の設定を、<subsystem xmlns="urn:jboss:domain:deployment-scanner:2.0">
要素内の<deployment-scanner>
タグに追加することで、デプロイメントスキャナーのタイムアウトを追加しています。 例えば、<deployment-scanner deployment-timeout="600" path="deployments" relative-to="jboss.server.base.dir" scan-interval="5000" runtime-failure-causes-rollback="${jboss.deployment.scanner.rollback.on.failure:false}"/>
-
LiferayのJAASセキュリティドメインを
<subsystem xmlns="urn:jboss:domain:security:2.0">
の<security-domains>
要素に追加します。 追加するドメインコードは以下の通りです。<security-domain name="PortalRealm"> <authentication> <login-module code="com.liferay.portal.security.jaas.PortalLoginModule" flag="required" /> </authentication> </security-domain>
-
<subsystem xmlns="urn:jboss:domain:undertow:12.0" ...>
要素からウェルカムコンテンツ要素をコメントアウトします。 例えば、<!--<location name="/" handler="welcome-content"/>-->
そして
<handlers> <!--<file name="welcome-content" path="${jboss.home.dir}/welcome-content"/>--> </handlers>
チェックポイント:
続行する前に、次のプロパティが standalone.xml
ファイルに設定されていることを確認してください。
- 新しい
<system-property>
が追加されます。 - 新しい
<filter-spec>
が追加されていること。 <deployment-timeout>
が600
に設定されていること。- 新しい
<security-domain>
が作成されていること。 - ウェルカムコンテンツが無効になっていること。
次に、JVMと起動スクリプトを構成します。
$JBOSS_HOME/ bin /
フォルダーで、スタンドアロンドメインの構成スクリプトファイル standalone.conf
を変更します。
- ファイルのエンコーディングを
UTF-8
に設定します。 - ユーザーのタイムゾーンを
GMT
に設定します。 - 優先プロトコルスタックを設定します。
- 利用可能なデフォルトのメモリ容量を増やします。
DXPでは、アプリケーションサーバーのJVMが GMT
タイムゾーンとUTF-8
ファイルエンコーディングを使用する必要があります。
standalone.conf
スクリプトを次のように編集します。
-
if [ "x$JAVA_OPTS" = "x" ];
ステートメントの下で、JAVA_OPTS
の割り当てからJVMサイジングオプションを削除します。 例えば、以下のものをJAVA_OPTS="-Xms1303m -Xmx1303m -XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=2560m -Djava.net.preferIPv4Stack=true"
以下のものと置き換えます。
JAVA_OPTS="-Djava.net.preferIPv4Stack=true"
-
次のJavaオプションの設定をファイルの最後に追加します。
JAVA_OPTS="$JAVA_OPTS -Dfile.encoding=UTF-8 -Djava.locale.providers=JRE,COMPAT,CLDR -Djava.net.preferIPv4Stack=true -Dlog4j2.formatMsgNoLookups=true -Duser.timezone=GMT -Xms2560m -Xmx2560m -XX:MaxNewSize=1536m -XX:MaxMetaspaceSize=768m -XX:MetaspaceSize=768m -XX:NewSize=1536m -XX:SurvivorRatio=7"
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領域は、古い世代の領域に昇格する前に、若い世代のオブジェクトを保持します。 |
DXPのインストール後、これらの構成(これらのJVMオプションを含む)をさらに調整して、パフォーマンスを向上させることができます。 詳細については、Liferayの調整およびJVMの調整を参照してください。
IBM JDKの使用
JBossサーバーでIBM JDKを使用する場合は、以下の追加手順を実行します。
-
DXP 7.3 以前の場合、
$JBOSS_HOME/modules/com/liferay/portal/main/module.xml
ファイルに移動して、この依存関係を<dependencies>
要素内に挿入してください:<module name="ibm.jdk" />
-
JBOSS_HOME/modules/system/layers/base/sun/jdk/main/module.xml
ファイルに移動し、これらのパスを<paths>...</paths>
エレメント内に挿入します:<path name="com/sun/crypto" /> <path name="com/sun/crypto/provider" /> <path name="com/sun/image/codec/jpeg" /> <path name="com/sun/org/apache/xml/internal/resolver" /> <path name="com/sun/org/apache/xml/internal/resolver/tools" />
追加されたパスは、ポータルのデプロイメントの例外と画像のアップロードの問題を解決します。
Liferayにおけるデータソースの構成
DXPには組み込みのHypersonicデータベースが含まれています。これはデモンストレーション目的には最適ですが、 本番環境では使用しないでください 。 本番環境では、フル機能のサポートされているRDBMSを使用してください。 データベースのセットアップについては、データベースの設定を参照してください。
Liferay DXPは、DXPに組み込まれているデータソースを使用する(推奨)か、アプリケーションサーバー上に作成したデータソースを使用してデータベースに接続できます。
セットアップウィザードを使用して、DXPを初めて実行するときに、データベースを使用してDXPの組み込みデータソースを構成できます。 または、データベースの データベーステンプレートに 基づいて、データソースを portal-ext.properties
ファイルで構成できます。
JBoss EAPにおけるデータソースの構成
JBossを使用してデータソースを管理する場合は、次の手順に従います。
-
DXP WAR(7.4以降)またはデータベースベンダーからJDBC JARを取得し、
$JBOSS_HOME/modules/com/liferay/portal/main
フォルダにコピーします。 -
$JBOSS_HOME/modules/com/liferay/portal/main
フォルダにmodule.xml
というファイルを作成します。 ファイル内で、portalモジュールとJDBC JARを宣言します。<?xml version="1.0"?> <module xmlns="urn:jboss:module:1.0" name="com.liferay.portal"> <resources> <resource-root path="[place your database vendor's JAR file name here]" /> </resources> <dependencies> <module name="javax.api" /> <module name="javax.mail.api" /> <module name="javax.servlet.api" /> <module name="javax.servlet.jsp.api" /> <module name="javax.transaction.api" /> </dependencies> </module>
-
$JBOSS_HOME/standalone/configuration/standalone.xml
ファイルの<datasources>
要素の中にデータソースを追加します。<datasource jndi-name="java:jboss/datasources/ExampleDS" pool-name="ExampleDS" enabled="true" jta="true" use-java-context="true" use-ccm="true"> <connection-url>[place the URL to your database here]</connection-url> <driver>[place the driver name here]</driver> <security> <user-name>[place your user name here]</user-name> <password>[place your password here]</password> </security> </datasource>
データベースのURL、ユーザー名、パスワードを適切な値に置き換えてください。
noteデータソース
jndi-name
を変更する必要がある場合は、<default-bindings>
タグ内のdatasource
要素を編集してください。 -
<datasources>
要素内にもあるstandalone.xml
ファイルの<drivers>
要素にドライバーを追加します。<drivers> <driver name="[name of driver must match name above]" module="com.liferay.portal"> <driver-class>[place your JDBC driver class here]</driver-class> </driver> </drivers>
MySQLを使用する最終的なデータソースサブシステムは次のようになります。
<subsystem xmlns="urn:jboss:domain:datasources:5.0"> <datasources> <datasource jndi-name="java:jboss/datasources/ExampleDS" pool-name="ExampleDS" enabled="true" jta="true" use-java-context="true" use-ccm="true"> <connection-url>jdbc:mysql://localhost/lportal</connection-url> <driver>mysql</driver> <security> <user-name>root</user-name> <password>root</password> </security> </datasource> <drivers> <driver name="mysql" module="com.liferay.portal"> <driver-class>com.mysql.cj.jdbc.Driver</driver-class> </driver> </drivers> </datasources> </subsystem>
-
Liferay Homeの
portal-ext.properties
ファイルで、データソースを指定します。 例えば、jdbc.default.jndi.name=java:jboss/datasources/ExampleDS
これで、データソースが構成され、データベースに接続する準備ができました。
メールサーバーに接続する
データベース構成と同様に、構成するのが最も簡単なメールセッションはDXPです。 DXPの組み込みのメールセッションを使用する場合は、このセクションをスキップして、コントロールパネルのメールサーバーに接続してください。
JBossでメールセッションを設定する場合は、以下の手順に従ってください。
-
次のように、
$JBOSS_HOME/standalone/configuration/standalone.xml
ファイルでメールサブシステムを指定します。<subsystem xmlns="urn:jboss:domain:mail:3.0"> <mail-session jndi-name="java:jboss/mail/MailSession" > <smtp-server ssl="true" outbound-socket-binding-ref="mail-smtp"> <login username="[place user name here]" password="[place password here]"/> </smtp-server> </mail-session> </subsystem> ... <socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}"> ... <outbound-socket-binding name="mail-smtp"> <remote-destination host="[place SMTP mail host here]" port="[place mail port here]"/> </outbound-socket-binding> </socket-binding-group>
-
Liferay Homeの
portal-ext.properties
ファイルで、メールセッションを参照します。 例:mail.session.jndi.name=java:jboss/mail/MailSession
DXPのデプロイ
ROOT.war
デプロイメントをトリガーするには、$JBOSS_HOME/ standalone/deployments /
フォルダーにROOT.war.dodeploy
という名前の空のファイルを作成します。$JBOSS_HOME/bin
に移動し、standalone.sh
を実行して JBoss アプリケーションサーバーを起動します。 JBoss はROOT.war.dodeploy
ファイルを検出し、ファイルの接頭辞に一致する Web アプリケーションをデプロイします (つまり、ROOT.war
)。
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のアクティブ化 を参照してください。
DXPはJBoss EAPで実行されています。
次のステップ
管理者ユーザーとしてサインインして、DXPでソリューションの構築を開始できます。 または、Liferay DXPのその他のセットアップトピックを参照できます。