Elasticsearchコネクターの設定リファレンス

ここに記載されている設定情報は、Liferay Portal 7.2-7.4 CEおよびLiferay DXP 7.2-7.4用のElasticsearch 6およびElasticsearch 7コネクタの最新の入手可能なバージョン（バンドル版またはMarketplace経由）に適用されます。 必要に応じて、正確なGA/Service Pack/Fix PackおよびMarketplaceのバージョンに関する適切な情報が提供されます。

Elasticsearch への接続は主にシステム設定の Elasticsearch 6/7 設定エントリで定義されます（または 対応する設定ファイル を介して）。Liferay 7.3+ では、factory configuration を使って Elasticsearch への複数の接続を定義することができます。Elasticsearch Connections_. どちらのエントリも システム設定 かOSGi configuration fileで設定できます。本番環境では設定ファイルが推奨されます。

設定ファイルとシステム設定項目

サーバーの接続	システム設定エントリー／設定ファイル
Liferay 7.2.x Elasticsearch 6.x	Elasticsearch 6 com.liferay.portal.search.elasticsearch6.configuration.ElasticsearchConfiguration.config
Liferay 7.2.x Elasticsearch 7.x	Elasticsearch 7 com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration.config
Liferay 7.3+ Elasticsearch 7.x/8.x	Elasticsearch 7 com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration.config Elasticsearch Connections (factory) com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConnectionConfiguration-[connectionId].config

Liferay 7.3以降では、Elasticsearch接続という接続設定項目が追加されています。 これを使用してElasticsearchへの任意の接続を定義することができますが、1つの接続のみを設定する場合は、メインのElasticsearch 7設定エントリを使用することができます。 7.3で複数の接続を使用する場合は、それに応じたファイル名で接続を定義します。

com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConnectionConfiguration-[connectionId].config

Elasticsearch 6にセキュリティを設定する場合は、別途Liferayの設定（およびLESのサブスクリプション）が必要です。 詳しくは、 Elasticsearchの保護 を参照してください。

[Liferay_Home]/osgi/configs に設定ファイルを配置し、リスナーが設定を自動検出してデータベースに書き込みます。

構成プロパティ

システム設定 フィールド名	設定ファイルの構文とデフォルト値 説明（クリックで展開）	利用可能
	[一般接続設定](#general-connection-settings" id="general-connection-settings)
合計ヒット数を記録	trackTotalHits=B "true" 有効にすると、検索結果が10,000件以上あった場合にヒット数が正確にカウントされる。 これを有効にしておくと、検索ヒット数が多い場合にパフォーマンスに影響が出ることがある。	Liferay 7.2+ (Connector to Elasticsearch 7)
本番モードが有効	productionModeEnabled=B "false" 本番モードを有効にする。 Liferay 7.3では、 productionModeEnabled が、非推奨の設定である operationModeを置き換えています。 これをチェックすると、プロダクションモードが有効になり、Operation Modeの設定は無視されます。 本番モードを有効にするには、リモートのスタンドアロンElasticsearchクラスタに接続する必要があります。 無効のままだと、Operation Modeコンフィギュレーションが使用される。	Liferay DXP 7.3+
インデックス名プレフィックス	indexNamePrefix="liferay-" 検索インデックス名のプレフィックスとして使用する文字列値を設定する。 初期値は通常の状態では変更しないでください。 変更する場合は、ポータルの reindex all オペレーションも実行し、Elasticsearch 管理コンソールを使用して古いインデックスを手動で削除する必要があります。	Liferay 7.2+
7.3.x→Number of Company and System Index Replicas 7.2.x→Index Number of Replicas	indexNumberOfReplicas="0-all" Liferayの会社やシステムのインデックスごとにレプリカの数を設定します。 設定されていない場合は、レプリカを使用しません。 この値を変更するには、すべてのコンテンツのインデックスを再作成する必要があります。 デフォルト値は、コネクタに同梱されている "index-settings-defaults.json "というファイルに定義されています。	Liferay 7.2+
7.3.x→Number of Company and System Index Shards 7.2.x→Index Number of Shards	indexNumberOfShards="1" Liferayの会社とシステムのインデックスを作成するときに使用するシャードの数を設定します。 設定されていない場合は、1つのシャードが使用されます。 この値を変更するには、すべてのコンテンツのインデックスを再作成する必要があります。 デフォルト値は、コネクタに同梱されている "index-settings-defaults.json "というファイルに定義されています。	Liferay 7.2+
例外のみロギングする	logExceptionsOnly=B "true" 真の場合、Elasticsearchからの例外のみをログに記録し、例外を再スローしないブール値の設定。	Liferay 7.2+
コンフリクト時の再試行	retryOnConflict="5" ドキュメントを取得してから更新するまでの間にドキュメントが更新され、バージョンの衝突が発生した場合に再試行する回数を整数値で設定する(詳しくは ここ を参照)。	Liferay 7.1では使用されなくなりました。
最大接続数	maxConnections="75" HTTP接続の最大数を設定する。	Liferay 7.4 U67/GA67+
ルートごとの最大接続数	maxConnectionsPerRoute="75" ルートごとのHTTP接続の最大数を設定する。	Liferay 7.4 U67/GA67+
	[セキュリティ設定](#security-settings" id="security-settings)
認証が有効	authenticationEnabled=B "false" ユーザー名とパスワードによるElasticsearchへの認証を有効または無効にします。	Liferay DXP 7.3+
ユーザー名	username="elastic" Authentication Enabledがチェックされている場合、Elasticsearchに認証するためのユーザー名を設定する。	Liferay DXP 7.3+
パスワード	password="" Authentication Enabledがチェックされている場合に、Elasticsearchに認証するためのパスワードを設定します。	Liferay DXP 7.3+
HTTP SSLが有効	httpSSLEnabled="false" TLS/SSLを有効または無効にする。	Liferay DXP 7.3+
トラストストアの種類	truststoreType="pkcs12" HTTP SSLが有効な場合、トラストストアのタイプを設定します。 JDKのバージョン （例：jksまたはpkcs12）でサポートされている フォーマットを選択する。	Liferay DXP 7.3+
トラストストアのパス	truststorePath="/path/to/localhost.p12" HTTP SSL Enabledがチェックされている場合、トラストストア・ファイルへのパスを設定する。	Liferay DXP 7.3+
トラストストアのパスワード	truststorePassword="" HTTP SSL Enabledがチェックされている場合、トラストストアのパスワードを設定する。	Liferay DXP 7.3+
	[elasticsearch 接続設定](#elasticsearch-connections-settings" id="elasticsearch-connections-settings)
有効	active=B "false" 必要に応じて接続をアクティブにしたり、非アクティブにしたりする。 Elasticsearch 7のコンフィギュレーションのリモートクラスタ接続ID設定で選択されている場合は、接続を非アクティブにしないでください。	Liferay DXP 7.3+
接続ID	connectionId="" 接続の一意なIDを設定する。 アクティブな場合、この接続はElasticsearch 7設定のリモートクラスタ接続IDプロパティで選択できるようになります。	Liferay DXP 7.3+
	[rest クライアント設定](#rest-client-settings" id="rest-client-settings)
ネットワークホストアドレス	networkHostAddresses="[http://localhost:9200]" 接続先のリモートHTTPホストを設定する。 これはLiferay 7.3でRESTクライアント接続を設定するために必要です。	Liferay DXP 7.3+
Restクライアントのロガーレベル	RESTClientLoggerLevel="ERROR" DXP 7.3 U4+, DXP 7.4 GA1+, Portal 7.4 GA5+ からは廃止されました。	Liferay DXP 7.3+
	[トランスポートクライアントの設定（組み込みとリモート）](#transport-client-settings" id="transport-client-settings)
動作モード	operationMode="EMBEDDED" EMBEDDEDとREMOTEの2つのオペレーション・モードから選ぶことができる。 REMOTEに設定すると、リモートのスタンドアロンElasticsearchクラスタに接続します。 EMBEDDEDに設定すると、Liferayを内部のElasticsearchインスタンスで起動します。 EMBEDDED操作モードは、本番環境ではサポートされておらず、「開発モード」機能とみなされる。	Liferay 7.2. Liferay 7.3 で非推奨となり、 Production Mode Enabled に置き換えられました。
クラスター名	clusterName="LiferayElasticsearchCluster" クラスタ名はLiferay 7.2のトランスポートクライアントでのみ必要です。 統合するクラスタを宣言するためのString値を設定します。 接続がRESTクライアントを通して管理されるLiferay 7.3+では、このプロパティは開発モードの時に組み込みクラスタの名前を付けるためだけに使用されます。	Liferay 7.2- 7.3では、開発モードに適用されます。
トランスポート アドレス	transportAddresses= ["localhost:9300"] 接続先のリモート Elasticsearch ノードのアドレスを String 値で設定します。 この値は、オペレーションモードがリモートに設定されている場合に必要です（詳しくは こちら ]をご覧ください）。 ノードの数はいくつでも指定できる。	Liferay DXP 7.2
クライアント・トランスポート・スニフ	clientTransportSniff=B "true" クラスタ・スニッフィングを有効にし、クラスタ内の利用可能なデータ・ノードを動的に検出するには、このブール値をtrueに設定します（詳細については、 ここ を参照してください）。	Liferay DXP 7.2
クライアントのトランスポートは、クラスター名を無視します。	clientTransportIgnoreClusterName=B "false" 接続ノードのクラスタ名検証を無視するには、このブール値を true に設定します（詳細は ここ を参照してください）。	Liferay DXP 7.2
クライアント・トランスポート・Ping タイムアウト	clientTransportPingTimeout="" クライアントノードがノードからのping応答を待つ時間（秒）を設定します。 未設定の場合、デフォルトの Elasticsearch の client.transport.ping_timeout が使用されます。	Liferay DXP 7.2
クライアント・トランスポート・ノード のサンプル間隔	clientTransportNodesSamplerInterval="" このString値を設定することで、リストされ接続されているノードをサンプリング/pingする頻度をクライアントノードに指示します(詳細は ここ を参照)。	Liferay DXP 7.2
	[その他の設定](#other-settings" id="other-settings)
リモートクラスター接続ID	remoteClusterConnectionId= リモートElasticsearchクラスタへの接続IDを選択します。 利用可能な接続は、「Elasticsearch Connections System Settings」エントリで定義されます。 この値が設定されていない場合、リモートクラスタ接続にはElasticsearch 7エントリの接続設定が使用されます。	Liferay 7.3で LES Cross-Cluster Replication を使用する場合。
	[開発モードの設定（組み込みとサイドカー）](#development-mode-settings" id="development-mode-settings)
追加設定	additionalConfigurations="" 組み込みElasticsearchのカスタム設定のString値をYML形式で設定します。 を参照してください： Liferay Elasticsearch Connector の高度な設定 を参照してください。	Liferay 7.2+
Bootstrap Mlock All	bootstrapMlockAll="false" trueに設定すると、プロセスのアドレス空間をRAMにロックし、Elasticsearchのメモリがスワップアウトされないようにするブール値の設定です（詳しくは ここ を参照してください）。	Liferay 7.2+
埋め込みHttpポート	embeddedHttpPort="9201" この設定は EMBEDDED モードにのみ適用されます。 Operation ModeがEMBEDDEDに設定されている場合に作成される組み込みElasticsearchノードのHTTPポートを設定します。	Liferay 7.2. Liferay 7.3.x で非推奨となり、 Sidecar HTTP Port に置き換えられました。
Httpが有効	httpEnabled=B "true" これをチェックすると、HTTPレイヤーが有効になる。 チェックを外すと、RESTリクエストに直接対応しないノードではHTTPレイヤーが無効になる。	Liferay 7.1.xで非推奨となりました。
Http CORS 許可オリジン	httpCORSAllowOrigin="/https?:\//localhost(: [0-9]+)?/" HTTP CORSが有効になっているときに許可するString originを設定する（詳細は ここ ]を参照）。	Liferay 7.2+
Http CORS 設定	httpCORSConfigurations= HTTP CORS のカスタム設定の String 値を YML 形式（elasticsearch.yml）で設定します（詳細は ここ を参照）。	Liferay 7.2+
Http CORSが有効	httpCORSEnabled=B "true" クロスオリジンリソース共有を無効にするには、このブール値をfalseに設定します。 falseに設定すると、他のオリジンのブラウザはElasticsearchへのリクエストを行うことができません。 Elasticsearch Headのようなウェブフロントエンドツールが接続できない場合があります（詳しくはこちら ）。	Liferay 7.2+
ネットワーク ホスト	networkHost="" このString値を設定すると、このホスト名またはIPアドレスにバインドし、クラスタ内の他のノードにこのホストをパブリッシュ（アドバタイズ）するようにノードに指示します。 これはバインドホストとパブリッシュホストを同時に設定するショートカットです（詳しくは こちら を参照）。	Liferay 7.2+
ネットワークバインドホスト	networkBindHost="" ノードが着信要求をリッスンするためにバインドすべきネットワークインターフェー スの文字列値を設定する(詳細は ここ を参照)。	Liferay 7.2+
ネットワーク公開ホスト	networkPublishHost="" クラスタ内の他のノードがそのノードに接続できるように、ノードがクラスタ内の他のノードにアドバタイズする単一のインターフェースの String 値を設定します (詳細については ここ を参照してください)。	Liferay 7.2+
トランスポート Tcpポート	transportTcpPort="" ノード間の通信にバインドするポートの文字列値を設定します。 単一の値または範囲（詳細は ここ を参照）を受け付ける。	Liferay 7.2+
Zenディスカバリー・ユニキャスト・ホストポート	discoveryZenPingUnicastHostsPort="9300-9400" discovery.zen.ping.unicast.hostsの値を作成するときに使用するポートの範囲を文字列で設定します。 ある範囲のポートにある複数のElasticsearchノードが、同じコンピュータでゴスルーターとして動作することができます（詳細は、 こちらの を参照してください）。 7.3では非推奨。	Liferay 7.2
	[サイドカー設定](#sidecar-settings" id="sidecar-settings)
ノード名	nodeName= 組み込みElasticsearchサーバーのノード名を指定します。 リモート Elasticsearch サーバのノード名は elasticsearch.yml で設定する。	Liferay DXP 7.3+
Sidecarデバッグ	sidecarDebug=B "false" これをtrueに設定すると、サイドカー・プロセスのデバッグ・モードが有効になる。	Liferay DXP 7.3+
Sidecarデバッグ設定	sidecarDebugSettings="-agentlib:jdwp=transport=dt_socket,address=8001,server=y,suspend=y,quiet=y" sidecarプロセスのデバッグに使用するJVMオプションを設定する。	Liferay DXP 7.3+
Sidecarのハートビート監視間隔	sidecarHeartbeatInterval="10000" サイドカープロセスの健全性を検出するためのハートビート間隔をミリ秒単位で設定する。	Liferay DXP 7.3+
Sidecarホーム	sidecarHome="elasticsearch7" 、サイドカー処理を開始する際に使用するサイドカーベースフォルダのパスを設定する。	Liferay DXP 7.3+
Sidecar HTTPポート	sidecarHttpPort="9200" このコンフィギュレーションは Liferay 7.3 と sidecar Elasticsearch にのみ適用されます。 サイドカーのElasticsearchノードのHTTPポートレンジを設定します。 AUTOに設定すると、9201～9300番台のポートを自動的に検出します。 未設定の場合、埋め込みHTTPポート（デフォルトでは9201）が使用される。	Liferay DXP 7.3+
Sidecar JVMオプション	sidecarJVMOptions="-Xms1g}-Xmx1g}-XX:+AlwaysPreTouch" サイドカー・プロセスが使用するJVMオプションを設定する。	Liferay DXP 7.3+
Sidecarのシャットダウンタイムアウト	sidecarShutdownTimeout="10000" sidecarプロセスが強制的にシャットダウンされるまでの時間をミリ秒単位で設定する。	Liferay DXP 7.3+
	[詳細設定](#advanced-settings" id="advanced-settings)
追加インデックス設定	additionalIndexConfigurations="" Liferayインデックスのカスタム設定のString値をJSONまたはYML形式で設定します（詳細はElasticsearch Create Index APIを参照してください）。 を参照してください： Liferay Elasticsearch Connector の高度な設定 を参照してください。	Liferay 7.2+
追加タイプマッピング	additionalTypeMappings="" LiferayDocumentType のカスタムマッピングの String 値を JSON 形式で設定します（詳細は Elasticsearch Put Mapping API を参照してください）： Liferay Elasticsearch Connector の高度な設定 を参照してください。	Liferay 7.2+
タイプマッピングを上書き	OverrideTypeMappings="" ここでの設定はLiferayのデフォルトのタイプマッピングをオーバーライドします。 これは高度な機能であり、厳密に必要な場合にのみ使用する必要があります。 この値を設定すると、Liferayのソースコード(例えば liferay-type-mappings.json)にあるデフォルトのマッピングは完全に無視されます。	Liferay 7.2+
プロキシホスト	proxyHost="" クライアント接続のプロキシホストを設定する。	Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7
プロキシポート	proxyPort="0" クライアント接続用のプロキシポートを設定する。	Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7
プロキシユーザー名	proxyUserName="" プロキシ接続のプロキシユーザー名を設定する。	Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7
プロキシパスワード	proxyPassword="" プロキシに接続するためのパスワードを設定する。	Liferay DXP 7.3 FP1 /SP1およびLiferay Portal GA7

関連トピック

• Search for 7.3の新機能は？
• Elasticsearch の保護
• Elasticsearch への接続
• Liferay DXP Elasticsearch コネクタ：技術データシート (KB リファレンス)
• Liferay DXP と Elasticsearch の互換性を理解する (KB リファレンス)