Search Results

All Results 6987
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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...
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,...
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...
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...
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...
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. ...
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...
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...
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...
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...
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 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...
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...
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 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...
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
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...
Liferay Enterprise Search
Official Documentation
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...
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 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...
Activating Liferay Enterprise Search
Official Documentation
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...
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...
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 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...
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...
Search Blueprints
Official Documentation
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 ...
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...
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...
Monitoring Elasticsearch
Official Documentation
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...
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...
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...
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...
Collections with Search Blueprints
Official Documentation
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...
Database Configuration
Database Configuration By default for demonstration purposes, Liferay DXP/Portal is configured to use an embedded HSQL database. Beyond demonstration purposes, we recommend using a full-featured,...
Viewing Metrics from Kubernetes
Official Documentation
Viewing Metrics from Kubernetes It is important to track resource usage in the Kubernetes cluster. To view your resource usage, you must use a collector and an exporter. Before you can view...
Liferay Home
Liferay Home Liferay Home is the folder from which Liferay DXP/Portal launches applications, reads and applies configurations, loads JAR files, generates logs, and more. Liferay Home's location...
Portal Properties
Portal Properties Configuration options are specified using Portal Properties, sets of name/value pairs read from properties files and Docker environment variables on server startup. Default values...
Viewing Metrics with Glowroot
Viewing Metrics with Glowroot This article describes how to use Glowroot in Liferay installations hosted in AWS. For information on how to set up Glowroot in other circumstances, see Using...
Reference
Reference When installing Liferay, you must take into consideration the specifics of your environment. These topics help you integrate Liferay into your existing environment and aid in...
Viewing Metrics with Prometheus
Viewing Metrics with Prometheus The Liferay Helm chart is prepared to set up the Prometheus JMX Exporter project agent out-of-the-box. Set the JMX_AGENT_YAML environment variable to the following...
Installing Liferay in Amazon Web Services
Official Documentation
Installing Liferay in Amazon Web Services You can run Liferay DXP on AWS using a new or an existing EKS cluster; a plain installation or Liferay's offering on AWS Marketplace. Either installation...
JVM Configuration
Official Documentation
JVM Configuration As of Liferay DXP 2024.Q3+/Portal GA125+, Liferay DXP/Portal requires a Java JDK 17 or 21 (prior versions support JDKs 8 and 11) with specific JVM option settings. There are also...
Portal Developer Properties
Official Documentation
Portal Developer Properties There are Portal Properties that facilitate development. Liferay's portal-developer.properties file includes all of them. The portal-developer.properties file is enabled...
System Properties
System Properties Liferay DXP/Portal runs in the application server's JVM. System properties can be passed directly to the JVM as arguments to java in the format -D[name1]=[value1] or can be loaded...
Database Templates
Database Templates Below are templates (example portal properties and Docker environment variables) for configuring various databases as a built-in data source for Liferay DXP. MariaDB Portal...
Liferay Software Versions
Liferay Software Versions Starting with Liferay 7.4, Liferay adopted a rolling release model for delivering updates and fixes. This means Liferay 7.4 is a long living release with many releases for...
Setting Up Liferay
Official Documentation
Setting Up Liferay After installing Liferay, configure it to meet your needs. Here are common setup tasks. Setup Tasks Preconfigure the System Activate Liferay (Subscription Required) ...
Configuring Cluster Link
Official Documentation
Configuring Cluster Link Enabling Cluster Link activates distributed caching. The cache is distributed across multiple Liferay DXP nodes running concurrently. Cluster Link uses Ehcache replication....
Database Configuration for Cluster Nodes
Official Documentation
Database Configuration for Cluster Nodes At minimum, nodes in a DXP cluster must be configured to share the same database (or database cluster) in order to function. Optimizations discussed here...
Example: Creating a Simple DXP Cluster
Official Documentation
Example: Creating a Simple DXP Cluster A fast, easy way to learn DXP clustering is to set up a two node DXP cluster environment on one machine using Docker containers. This example creates two DXP...
Session Replication with Tomcat
Official Documentation
Session Replication with Tomcat Liferay DXP 2024.Q3+/Portal GA92+ To ensure user session data is synchronized across all instances in the cluster, Liferay supports session replication. If one...
Clustering for High Availability
Official Documentation
Clustering for High Availability Liferay DXP can scale to serve everything from the smallest to the largest web sites. Out-of-the-box, it's configured optimally for a single server environment. If...
Activating Liferay DXP
Official Documentation
Activating Liferay DXP Subscription Required Liferay DXP is activated using an XML (.xml) activation key. It specifies your DXP subscription terms or trial agreement. When you run Liferay DXP for...
Configuring Unicast over TCP
Official Documentation
Configuring Unicast over TCP If your network configuration or the geographical distance between cluster nodes prevents you from using UDP Multicast clustering, you can configure TCP Unicast. You...
Configuring Mail
Official Documentation
Configuring Mail Liferay DXP/Portal can be configured to use a mail server to send email notifications for a variety of purposes: User registration and password management, Site membership...
Configuring Default Email Senders
Official Documentation
Configuring Default Email Senders By default, emails sent by Liferay DXP use the name and email address as the default admin user. This behavior can be configured for each of the different email...