Site Search - Liferay Learn

Using the Search Results Widget Search results should be easy to navigate, sort, and filter. Give your users an optimal search experience by understanding the default search experience and the many...

Understanding Low Level Search Options

Official Documentation

Understanding Low Level Search Options Low level search works only with Elasticsearch. Low level search doesn't go through the Search and Indexing Framework, which is infrastructure used for...

Using Search Widget Templates

Official Documentation

Using Search Widget Templates The default search widgets views are useful, but your site's widgets likely need a specific design. You can choose from one of the available widget templates or create...

Working with Search Pages

Official Documentation

Working with Search Pages Search Pages Creating a Search Page Using a Search Page Template

Search Pages

Official Documentation

Search Pages Access the default search page at localhost:8080/web/guest/search. If you have a running Liferay DXP with some content in it, you can navigate there and execute a search. By default,...

Search Results Widget Template Reference

Official Documentation

Search Results Widget Template Reference While creating a search results widget template, you can access pre-populated variables in the FreeMarker template editor. The variables listed in the...

Using a Search Page Template

Official Documentation

Using a Search Page Template The default search page is backed by a Global scope page template. Manually created search pages can use that same template as a baseline. Out-of-the-box, the Search...

Similar Results

Official Documentation

Similar Results Subscription [Bundled with DXP 7.3 and 7.4; Liferay Marketplace for DXP 7.2 SP2+/FP5+](https://web.liferay.com/marketplace/-/mp/application/172465398) This feature does not work...

Creating a Search Page

Official Documentation

Creating a Search Page You can create and configure a search page for your Site if you choose not to base it on an existing search page template. This approach is preferable if you do not want to...

What's New in Search for 7.3?

Official Documentation

What's New in Search for 7.3? Elasticsearch Integration Elasticsearch 7 Support Liferay CE 7.3 GA4+, Liferay DXP 7.3 GA1+ Liferay DXP 7.3 comes with out-of-the-box support for Elasticsearch 7. The...

Search Overview

Official Documentation

Search Overview Search is a fundamental component of Liferay. Elasticsearch is bundled with Liferay for testing and development purposes. Production environments require Elasticsearch running on a...

Getting Started

Official Documentation

Getting Started

Searching for Content

Official Documentation

Searching for Content All indexed content (a.k.a. assets in Liferay DXP) can be returned as search results. Custom content can also be indexed, so your installation might have additional asset...

Connecting to Elasticsearch

Official Documentation

Connecting to Elasticsearch After setting up Elasticsearch, connect it to Liferay using the Liferay Connector to Elasticsearch. Connection steps depend on the connector you're configuring. See...

Advanced Configuration of the Liferay Elasticsearch Connector

Official Documentation

Advanced Configuration of the Liferay Elasticsearch Connector The Elasticsearch connection is configured using a configuration file or via System Settings. The Elasticsearch connector has a lot of...

Elasticsearch

Official Documentation

Elasticsearch Elasticsearch is the highly scalable, full-text search engine Liferay uses by default. Elasticsearch is bundled with Liferay for non-production purposes. In production, Liferay...

Installing and Upgrading a Search Engine

Official Documentation

Installing and Upgrading a Search Engine A search engine is a critical component of your Liferay installation. Creating an Example Cluster can get you started with an Elasticsearch installation,...

Backing Up Elasticsearch

Official Documentation

Backing Up Elasticsearch Elasticsearch replicas protect against a node going down, but they won't help you with a catastrophic failure. Only good backup practices can help you then. Backing Up...

Upgrading Search Infrastructure

Official Documentation

Upgrading Search Infrastructure While upgrading Liferay, consider whether an Elasticsearch upgrade is required. The exact steps for upgrading depend on your existing search engine installation and...

Troubleshooting the Elasticsearch Connection

Official Documentation

Troubleshooting the Elasticsearch Connection Listed here are some connection issues you can encounter when configuring the Liferay-Elasticsearch connection, along with the most common solutions to...

Elasticsearch Connector Configuration Reference

Official Documentation

Elasticsearch Connector Configuration Reference The configuration information here applies to the latest available (bundled or through Marketplace) version of the Elasticsearch 6 and Elasticsearch...

Troubleshooting Elasticsearch: Common Issues

Official Documentation

Troubleshooting Elasticsearch: Common Issues Listed here are some common issues you may encounter while configuring Elasticsearch and Liferay. Additional connection-specific errors are discussed in...

Upgrading Elasticsearch

Official Documentation

Upgrading Elasticsearch Liferay supports Elasticsearch 8. The compatibility matrix provides the latest support details. Solr is in maintenance mode in Liferay 7.4. Elasticsearch 6.x is not...

Securing Elasticsearch

Official Documentation

Securing Elasticsearch The very first thing you must do to secure Elasticsearch is enable X-Pack Security. After that you can begin configuring authentication and encrypted communication. ...

Installing Elasticsearch

Official Documentation

Installing Elasticsearch Here's how to install, configure, and start Elasticsearch on-premises. If you have Elasticsearch indexes used for primary data storage (storing data not backed by a...

Exercise: Run Liferay and Elasticsearch Using Docker

Official Documentation

Exercise: Run Liferay and Elasticsearch Using Docker 7.3+ Here you can walk through a minimal Liferay-Elasticsearch setup on your local machine to see how a secure REST Client connection between...

Getting Started with Elasticsearch

Official Documentation

Getting Started with Elasticsearch Compatibility: See the Search Engine Compatibility Matrix for details on the compatible Elasticsearch versions, available Liferay connectors, and required...

Troubleshooting Elasticsearch Installation

Official Documentation

Troubleshooting Elasticsearch Installation Liferay and Elasticsearch are complex systems full of configurations. When connecting them, you can run into difficulty along the way. Included below are...

Using the Sidecar or Embedded Elasticsearch

Official Documentation

Using the Sidecar or Embedded Elasticsearch Sidecar and embedded Elasticsearch are not suitable for production. When using an app server different other than Tomcat, set up a standalone...

Installing a Search Engine

Official Documentation

Installing a Search Engine A search engine is a critical component of your Liferay installation. Creating an Example Cluster can get you started with the installation, but this guide demonstrates...

Upgrading to Elasticsearch 8

Official Documentation

Upgrading to Elasticsearch 8 7.4 U81+, 7.3 U31+ Elasticsearch 8 is supported and recommended for the latest Liferay DXP Quarterly and Portal GA release out of the box. For specific version...

Upgrading to Elasticsearch 7

Official Documentation

Upgrading to Elasticsearch 7 7.1 and 7.2 Liferay's connection to Elasticsearch 7.17.x servers is deprecated due to the End of Life for Elasticsearch 7.17. Connecting to a deprecated Elasticsearch...

Installing Solr

Official Documentation

Installing Solr 7.2-7.3 (CE, DXP); 7.4 DXP U60+ Solr is a popular enterprise search platform built on Apache Lucene. It's reliable, scalable, and fault tolerant. Read more about it here. Solr is...

Cross Cluster Replication

Official Documentation

Cross Cluster Replication Cross Cluster Replication Configuring an Example Cross Cluster Replication Installation Configuring a Cross Cluster Replication in a Remote Leader Data Center ...

Configuring CCR in a Local Follower Data Center

Official Documentation

Configuring CCR in a Local Follower Data Center First configure CCR in the remote/leader data center before following the steps below. The local/follower data center holds Liferay DXP cluster...

Installing OpenSearch

Official Documentation

Installing OpenSearch Subscription Required [Beta Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) You can connect OpenSearch with Liferay. For...

Solr Limitations

Official Documentation

Solr Limitations Liferay's Solr implementation has limitations. Some Liferay features and APIs cannot be used when you choose Solr as the search engine. Install Elasticsearch for the best...

Configuring an Example CCR Installation: Replicating Between Data Centers

Official Documentation

Configuring an Example CCR Installation: Replicating Between Data Centers Liferay Enterprise Search (LES) Subscribers This example configures Liferay DXP's Cross-Cluster Replication module and...

OpenSearch Connector Configuration Reference

Official Documentation

OpenSearch Connector Configuration Reference Subscription Required [Beta Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) Configure Liferay's...

Solr

Official Documentation

Solr Solr is in maintenance mode in Liferay 7.4. Solr Limitations Installing Solr

OpenSearch

Official Documentation

OpenSearch Subscription Required [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md) Elasticsearch is Liferay's native search engine. Beginning...

Liferay Enterprise Search

Official Documentation

Liferay Enterprise Search Liferay's Enterprise Search (LES) features significantly upgrade the default search capabilities. With a LES subscription you gain the following benefits: Search...

Troubleshooting Cross-Cluster Replication

Official Documentation

Troubleshooting Cross-Cluster Replication Known common pitfalls encountered during the CCR setup are covered here, as well as general troubleshooting techniques. For further troubleshooting, look...

Cross-Cluster Replication

Official Documentation

Cross-Cluster Replication Liferay Enterprise Search (LES) Subscribers In a classic Liferay DXP/search engine installation, one Liferay DXP cluster talks to one Elasticsearch cluster, sending all...

Configuring CCR: Settings Reference

Official Documentation

Configuring CCR: Settings Reference To help with the CCR configuration process, the example configurations from the step-by-step instructions in this guide are collected here. These configuration...

Configuring CCR In a Remote Leader Data Center

Official Documentation

Configuring CCR In a Remote Leader Data Center Ensure you have completed the necessary prerequisite steps before following the steps below. This data center holds Liferay DXP cluster nodes with a...

Search Blueprints

Official Documentation

Search Blueprints [LES Subscription](./deactivating-liferay-enterprise-search.md) DXP 7.4 U5+; 7.3 U6+ With Search Blueprints you can Make minor tweaks to Liferay's default search page behavior...

Deactivating Liferay Enterprise Search

Official Documentation

Deactivating Liferay Enterprise Search Starting with Liferay DXP 7.4 and in all quarterly releases, the Liferay Enterprise Search (LES) features are included out-of-the-box. You can begin using LES...

Collapsing Search Results

Official Documentation

Collapsing Search Results Liferay DXP 2023.Q4+/Portal GA102+ You can collapse search results that have identical keyword field values. For example, an internal blog titled Employee of the Month...

Creating Elements

Official Documentation

Creating Elements There are a lot of system Elements that ship with Search Blueprints. If none of the system Elements meets your needs, there are many ways to create your own Search Blueprints...

Learning to Rank

Official Documentation

Learning to Rank Liferay Enterprise Search (LES) Subscribers Search engines like Elasticsearch have well-tuned relevance algorithms, good for general search purposes. LES Learning to Rank...

Collections with Search Blueprints

Official Documentation

Collections with Search Blueprints When you create a search blueprint, you can enable it as a collection provider to display its results. Assets matching the blueprint's query and configuration are...

Custom Element Examples

Official Documentation

Custom Element Examples Here are example elements that use custom fields and nested fields in their contributed query clauses. Using Custom Fields (Expando) in Elements You can add custom fields...

Monitoring Elasticsearch

Official Documentation

Monitoring Elasticsearch [LES Subscription](./deactivating-liferay-enterprise-search.md) If you have a Liferay Enterprise Search (LES) subscription, you can integrate Elastic's Kibana monitoring...

Creating and Managing Elements

Official Documentation

Creating and Managing Elements Elements are one of the fundamental building blocks of Search Blueprints and are managed within the Blueprints application. Open the Global Menu's Applications...

Managing Elements

Official Documentation

Managing Elements To create new Elements, click Add (Add). See Creating Elements for more details. As of Liferay DXP 2023.Q4+/Portal GA102+, the title and description fields are localizable. To...

Creating and Managing Search Blueprints

Official Documentation

Creating and Managing Search Blueprints Create search blueprints to tailor the search experience to your users. You can find the search blueprints application in Global Menu (Global Menu) →...

Predefined Element Variables Reference

Official Documentation

Predefined Element Variables Reference In the Element Source editor, place the cursor in the desired location and click the variable in the left hand sidebar to insert it. In the Custom JSON...

Optimizing Search Response Size

Official Documentation

Optimizing Search Response Size In rare cases, an overly large search response can result in ERROR messages from the search engine: ERROR [http-nio-8080-exec-335][ElasticsearchIndexSearcher:165]...

Search Blueprints Elements Reference

Official Documentation

Search Blueprints Elements Reference Elements are one of the fundamental building blocks of a Search Blueprint. To explore all the available Elements, navigate to the Global Menu (Global) →...