Capability

Security

Liferay DXP is built with security in mind. A variety of standards based authentication methods and integrations can be used to ensure secure access to a site and its resources. Robust role-based access control with permissions gives you fine grained control over what authenticated and unauthenticated users can access, share, or edit. Liferay DXP’s web services also have a multi-layered and configurable approach to security and authorization.

Feature
Deployment Approach
Capability
Captcha API Basics
Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...
Published Date: May 9, 2024 6:52 PM
Liferay Security APIs
Liferay Security APIs You can use headless APIs to interface with important Liferay security features, including CAPTCHA configurations and SCIM. Here are resources to help you understand and...
Published Date: Jun 28, 2025 6:30 PM
Installing and Upgrading a Search Engine
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,...
Published Date: May 9, 2024 6:59 PM
Connecting to Elasticsearch
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...
Published Date: May 9, 2024 6:59 PM
Elasticsearch Connector Configuration Reference
Elasticsearch Connector Configuration Reference The configuration information here applies to the latest available (bundled or through Marketplace) version of the Elasticsearch 6 and Elasticsearch...
Published Date: May 9, 2024 6:59 PM
Installing Elasticsearch
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...
Published Date: Jan 18, 2025 2:51 AM
Troubleshooting Elasticsearch Installation
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...
Published Date: May 9, 2024 6:59 PM
Advanced Configuration of the Liferay Elasticsearch Connector
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...
Published Date: May 9, 2024 6:59 PM
Exercise: Run Liferay and Elasticsearch Using Docker
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...
Published Date: May 9, 2024 6:59 PM
Getting Started with Elasticsearch
Getting Started with Elasticsearch Compatibility: See the Search Engine Compatibility Matrix for details on the compatible Elasticsearch versions, available Liferay connectors, and required...
Published Date: Jan 18, 2025 2:51 AM
Troubleshooting the Elasticsearch Connection
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...
Published Date: Jan 18, 2025 2:51 AM
Getting Started
Getting Started
Published Date: May 9, 2024 6:59 PM
Search Overview
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...
Published Date: May 9, 2024 6:59 PM
What's New in Search for 7.3?
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...
Published Date: May 9, 2024 6:59 PM
Searching for Content
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...
Published Date: May 9, 2024 6:59 PM
What's New in Search for 7.4?
What's New in Search for 7.4? There are several highlights and new features added to Liferay's search infrastructure for the 7.4 release. New features include those added to the product for Liferay...
Published Date: May 9, 2024 6:59 PM
Elasticsearch
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...
Published Date: May 9, 2024 6:59 PM
Securing Elasticsearch
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. ...
Published Date: Jan 18, 2025 2:51 AM
Troubleshooting Elasticsearch: Common Issues
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...
Published Date: May 9, 2024 6:59 PM
Upgrading Elasticsearch
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...
Published Date: May 9, 2024 6:59 PM
Upgrading Search Infrastructure
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...
Published Date: May 9, 2024 6:59 PM
Using the Sidecar or Embedded Elasticsearch
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...
Published Date: Jan 18, 2025 2:51 AM
OpenSearch
OpenSearch Subscription Required [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md) Elasticsearch is Liferay's native search engine. Beginning...
Published Date: Nov 28, 2024 3:14 PM
Upgrading to Elasticsearch 7
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...
Published Date: Jan 18, 2025 2:51 AM
Upgrading to Elasticsearch 8
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...
Published Date: May 9, 2024 6:59 PM
Solr
Solr Solr is in maintenance mode in Liferay 7.4. Solr Limitations Installing Solr
Published Date: May 9, 2024 6:59 PM
Backing Up Elasticsearch
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...
Published Date: Jan 18, 2025 2:51 AM
Installing a Search Engine
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...
Published Date: May 9, 2024 6:59 PM
Installing OpenSearch
Installing OpenSearch Subscription Required [Beta Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) You can connect OpenSearch with Liferay. For...
Published Date: Nov 28, 2024 3:14 PM
OpenSearch Connector Configuration Reference
OpenSearch Connector Configuration Reference Subscription Required [Beta Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) Configure Liferay's...
Published Date: Nov 28, 2024 3:14 PM
Installing Solr
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...
Published Date: May 9, 2024 6:59 PM
Solr Limitations
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...
Published Date: May 9, 2024 6:59 PM
Liferay Enterprise Search
Liferay Enterprise Search A Liferay Enterprise Search (LES) subscription provides access and support for additional search features. Detailed installation and usage instructions are available in...
Published Date: May 9, 2024 6:59 PM
Configuring CCR: Settings Reference
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...
Published Date: May 9, 2024 6:59 PM
Monitoring Elasticsearch
Monitoring Elasticsearch [LES Subscription](./activating-liferay-enterprise-search.md) If you have a Liferay Enterprise Search (LES) subscription, you can integrate Elastic's Kibana monitoring UI...
Published Date: May 9, 2024 7:00 PM
Search Blueprints
Search Blueprints [LES Subscription](./activating-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 ...
Published Date: May 9, 2024 7:00 PM
Creating Elements
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...
Published Date: May 9, 2024 7:00 PM
Collapsing Search Results
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...
Published Date: May 9, 2024 7:00 PM
Collections with Search Blueprints
Collections with Search Blueprints [Release Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) When you create a search blueprint, you can enable it...
Published Date: May 9, 2024 7:00 PM
Creating and Managing Elements
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...
Published Date: May 9, 2024 7:00 PM
Custom Element Examples
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...
Published Date: Jan 11, 2025 4:54 PM
Managing Elements
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...
Published Date: May 9, 2024 7:00 PM
Predefined Element Variables Reference
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...
Published Date: May 9, 2024 7:00 PM
Configuring an Example CCR Installation: Replicating Between Data Centers
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...
Published Date: May 9, 2024 6:59 PM
Activating Liferay Enterprise Search
Activating Liferay Enterprise Search Starting with Liferay DXP 7.4, the Liferay Enterprise Search (LES) applications are included out-of-the-box. You can begin using LES right away, then purchase...
Published Date: Jul 29, 2025 8:56 PM
Cross Cluster Replication
Cross Cluster Replication Cross Cluster Replication Configuring an Example Cross Cluster Replication Installation Configuring a Cross Cluster Replication in a Remote Leader Data Center ...
Published Date: Jul 29, 2025 8:56 PM
Learning to Rank
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...
Published Date: May 9, 2024 7:00 PM
Configuring CCR in a Local Follower Data Center
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...
Published Date: May 9, 2024 6:59 PM
Configuring CCR In a Remote Leader Data Center
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...
Published Date: May 9, 2024 6:59 PM
Cross-Cluster Replication
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...
Published Date: May 9, 2024 6:59 PM
Troubleshooting Cross-Cluster Replication
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...
Published Date: May 9, 2024 7:00 PM
Optimizing Search Response Size
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]...
Published Date: May 9, 2024 7:00 PM
Creating and Managing Search Blueprints
Creating and Managing Search Blueprints You can create Search Blueprints from the Global menu's Applications section → Search Experiences. If you already have a Blueprint and want to apply it's...
Published Date: May 9, 2024 7:00 PM
Installing Search Experiences on Liferay 7.3
Installing Search Experiences on Liferay 7.3 [LES Subscription](./activating-liferay-enterprise-search.md) DXP 7.4 U5+; 7.3 U6+ The Liferay Enterprise Search Experiences app includes a suite of...
Published Date: May 9, 2024 7:00 PM
Semantic Search
Semantic Search 7.4 U70+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md) Semantic search evaluates the intent behind a searched phrase....
Published Date: May 9, 2024 7:00 PM
Search Blueprints Elements Reference
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) →...
Published Date: May 9, 2024 7:00 PM
Understanding Search Blueprints
Understanding Search Blueprints Use Search Blueprints to tailor the search page experience to your users' needs, without deploying any custom code. With Blueprints you can Create context-aware...
Published Date: May 9, 2024 7:00 PM
Using a Search Blueprint on a Search Page
Using a Search Blueprint on a Search Page By default, a search page does not have a search blueprint associated with it. A blueprint must be applied to a search page to affect the Liferay search...
Published Date: May 9, 2024 7:00 PM
Personalizing the Search Experience
Personalizing the Search Experience One of the premier use cases for Search Blueprints is to personalize Liferay's search results. With a personalized search experience, each user sees results...
Published Date: May 9, 2024 7:00 PM
Search Blueprints Configuration Reference
Search Blueprints Configuration Reference The Search Blueprints user interface has a Query Builder for creating Blueprints. Beyond adding Elements and configuring the query settings, there are...
Published Date: May 9, 2024 7:00 PM