Wasim's Site

Liferay OSGi Config Generator

Generate Liferay OSGi .config files for osgi/configs. Pick a component for a typed property form, or use custom mode for any PID. Correct Felix format.

1. Choose a component

2. Configure properties

Connect to a remote production Elasticsearch cluster. Replaces the deprecated Operation Mode.

Boolean

Deprecated. REMOTE connects to a standalone cluster; EMBEDDED runs a dev-only internal instance.

String

Name of the Elasticsearch cluster to connect to. Must match the remote cluster name.

String

URL of each Elasticsearch node (one per line).

String[]

Username for a secured (X-Pack) cluster.

String

Password for the configured username.

String

Enable HTTPS/TLS when connecting to the cluster.

Boolean

Add another property

3. Generated com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration.config

Drop this file into [Liferay Home]/osgi/configs/.

Prefer the plain .cfg format? (com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration.cfg)

The .config format is preferred — it carries types and supports multi-valued properties. Use .cfg only for simple scalar values.

Liferay Elasticsearch Connector OSGi Configuration

Connects Liferay to an Elasticsearch 7 cluster (the production search engine).

PID: com.liferay.portal.search.elasticsearch7.configuration.ElasticsearchConfiguration

Properties

PropertyTypeDefaultDescription
productionModeEnabledBooleanfalseConnect to a remote production Elasticsearch cluster. Replaces the deprecated Operation Mode.
operationModeStringREMOTEDeprecated. REMOTE connects to a standalone cluster; EMBEDDED runs a dev-only internal instance.
clusterNameStringLiferayElasticsearchClusterName of the Elasticsearch cluster to connect to. Must match the remote cluster name.
networkHostAddressesString[]http://localhost:9200URL of each Elasticsearch node (one per line).
usernameStringUsername for a secured (X-Pack) cluster.
passwordStringPassword for the configured username.
httpSSLEnabledBooleanfalseEnable HTTPS/TLS when connecting to the cluster.

These are the common, verified properties. Add any others for this PID with the custom-property row in the form above, then drop the file into [Liferay Home]/osgi/configs.