Search Results

All Results 7025
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Maintaining a Liferay Installation
Official Documentation
Maintaining a Liferay Installation Starting with Liferay DXP 7.3 SP3+ and 7.4 GA1+, Liferay adopted a new release model for delivering updates and fixes. This new approach is referred to as Bundle...
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...
Maintaining Clustered Installations
Official Documentation
Maintaining Clustered Installations Setting up your Liferay DXP installation to function in a cluster provides performance and scalability improvements, but also requires additional consideration...
Migrating Liferay Instances
Official Documentation
Migrating Liferay Instances Liferay DXP 2025.Q2+/Portal GA148+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) You can...
Accessing DXP Patch Code
Official Documentation
Accessing DXP Patch Code Subscribers Liferay DXP Fix Pack and Hotfix source code is available in a private GitHub repository called liferay-dxp. The source code facilitates identifying and...
Slimming Down Patched Installations
Official Documentation
Slimming Down Patched Installations Subscribers In Liferay DXP 7.2, patch information is retained in Patch Files in the installation by default. This facilitates restoring DXP to a previous patch...
Using Slim Bundles
Official Documentation
Using Slim Bundles Subscribers Liferay DXP 7.2 Fix Packs and Service Packs are also released bundled with the Tomcat application server. They are available as traditional bundles and Slim Bundles....
Running Liferay on any Kubernetes Cluster
Official Documentation
Running Liferay on any Kubernetes Cluster These instructions are purposefully generic. They install a cluster that works on any Kubernetes implementation, but additional work is needed to make that...
Backing Up
Official Documentation
Backing Up Once you have your DXP installation running, you should implement a comprehensive backup plan that accounts for unforeseen events. Backup copies are also valuable for testing updates...
Blue-Green Deployments
Official Documentation
Blue-Green Deployments Blue-green is a deployment technique in which you duplicate your production environment (the blue environment) and modify the duplicate (the green environment) with software...
Performing Rolling Restarts
Official Documentation
Performing Rolling Restarts The rolling restart cluster maintenance process involves shutting down and updating nodes one at a time (while the other nodes are running) until they're all updated....
Patching Liferay
Official Documentation
Patching Liferay Liferay DXP uses Bundle Releases for its latest releases. Please see Updating Liferay if you are applying an Update. All Hotfixes are patches. If you're applying a Hotfix,...
Custom Code and Patch Compatibility
Official Documentation
Custom Code and Patch Compatibility Subscribers If you deploy code that customizes or patches your DXP 7.2 installation, you must maintain its compatibility with all patches you're using. The...
Advanced Patching for DXP 7.2
Official Documentation
Advanced Patching for DXP 7.2 Here are the DXP 7.2 advanced patching topics: Using Slim Bundles demonstrates conserving disk space by using DXP fix pack bundles that don't include Patch Files. ...
Applying a Hotfix
Official Documentation
Applying a Hotfix Subscribers A Hotfix is a fix or collection of fixes delivered between Updates (or between Fix Packs for versions before DXP 7.3 SP3) to address a customer's confirmed critical...
Configuring the Patching Tool
Official Documentation
Configuring the Patching Tool Subscribers The Patching Tool can be adapted to any DXP installation. The tool's auto-discovery option is the easiest way to configure the Patching Tool. If you...
Getting Patch Information
Official Documentation
Getting Patch Information Subscribers You can see patch information at a glance, which helps maintain your installation and get help from Liferay Support. The Patching Tool's info command lists...
Installing Patches in Earlier Versions
Official Documentation
Installing Patches in Earlier Versions Subscribers The Patching Tool applies Fix Packs (including Security Fix Packs and Service Packs) for versions prior to Liferay DXP 7.3 SP3. It also applies...
Installing the Patching Tool
Official Documentation
Installing the Patching Tool Subscribers The Patching Tool is easy to install and update. Installation Download the Patching Tool from the Customer Portal. For DXP 7.3+, download the latest...
Uninstalling Patches
Official Documentation
Uninstalling Patches Subscribers After you install a patch, you may decide to restore your installation to a previous patch level. Here you'll learn how to Uninstall Patches Revert (uninstall)...
Updating Liferay
Official Documentation
Updating Liferay Liferay DXP 7.3 SP3+/Portal 7.4 GA1+ Update your Liferay installation with Bundle Releases. The latest features, security releases, as well as library updates are all delivered...
Updating Previous Versions of Liferay
Official Documentation
Updating Previous Versions of Liferay Staying current with updates gives you the best security and quality. Security Updates are releases that address the latest security issues immediately. ...
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,...
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...
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...
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...
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...
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 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...
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...
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) ...
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...
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...
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...
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 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....
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...
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...
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...
Configuring Mail
Official Documentation
Configuring Mail Liferay can be configured to use a mail server to send email notifications for a variety of purposes: user registration, password management, site membership notifications, content...
Configuring Default Email Senders
Official Documentation
Configuring Default Email Senders By default, emails sent by Liferay DXP use the name and email address of the default admin user. This behavior can be configured for each of the different email...
Sharing Widgets with Other Sites
Official Documentation
Sharing Widgets with Other Sites The Sharing options for widgets are deprecated as of Liferay DXP 2024.Q4/Portal GA129 and are scheduled for removal in a future release. Currently, this feature...
Setting Widget Scopes
Official Documentation
Setting Widget Scopes The Scope configuration is deprecated as of Liferay DXP 2024.Q4/Portal GA129 and is scheduled for removal in a future release. By default, Liferay's page widgets are scoped...
Page Settings
Official Documentation
Page Settings In Liferay, effective page management is crucial for maintaining an organized and user-friendly site. Page settings go beyond the physical layout and content of your pages to help you...
Configuring Locked Pages
Official Documentation
Configuring Locked Pages Liferay DXP 2023.Q3+/Portal GA92+ Liferay locks pages during editing to avoid conflicts when multiple users try to edit the same page. This feature works with content,...
Updating Page Permissions
Official Documentation
Updating Page Permissions By default, when users join a site, they can see all of its pages. However, you can configure permissions for individual pages to restrict access based on user roles. ...
Default Widgets Reference
Official Documentation
Default Widgets Reference Liferay provides a variety of widgets out-of-the-box, so you can start building your solution right away. Widgets can be placed on content pages, widget pages, and page...
Setting a Default Widget Template
Official Documentation
Setting a Default Widget Template You can change the widget template for individual widgets through their own configuration; however you can also configure a default widget template to apply to all...
Using a Widget Template Example
Official Documentation
Using a Widget Template Example Widget Templates are great tools for customizing how widgets look and feel on your site. This example shows changing the default configuration of the Media Gallery...
Page Settings UI Reference
Official Documentation
Page Settings UI Reference You can configure individual pages to meet your needs. All changes made in this way are scoped to the selected page. To configure a specific page, open the Site Menu...
Creating a Widget Template
Official Documentation
Creating a Widget Template Widget Templates use FreeMarker to determine how widgets are rendered in site pages. Each template is designed for a specific widget type and can be selected while...
Configuring Widget Look and Feel
Official Documentation
Configuring Widget Look and Feel Customize your widget's appearance using the Look and Feel Configuration menu when using widget pages. Adjust text styles, background colors, borders, margins,...
Configuring Your Page's Friendly URL
Official Documentation
Configuring Your Page's Friendly URL Liferay 7.3+ You can set friendly URLs for each of your site's pages. These URLs make it easy to understand and recall your page's address while providing key...
Setting Default Permissions
Official Documentation
Setting Default Permissions Liferay DXP 2024.Q3+/Portal GA125+ You can define a set of default permissions for Liferay content pages. The default permissions setting is available at both instance...
Styling Widgets
Official Documentation
Styling Widgets Once you've added widgets on a page, you can customize the look and feel of the widgets to meet your needs. With a range of configuration options available, you can tailor the...
Configuring Page Sets
Official Documentation
Configuring Page Sets For Liferay 7.4 U22+ and GA22+, private pages are disabled for new installations. They are also deprecated as of Liferay DXP 2024.Q4/Portal GA129 and are scheduled for...
Content Page Editor UI Reference
Official Documentation
Content Page Editor UI Reference For Liferay 7.4 U37+/GA37+ Using the content page editor, you can add and configure elements in a content page. Go to a content page and click Edit (Edit icon)....
Managing Content in Content Pages For Liferay 7.3 and Earlier Versions
Official Documentation
Managing Content in Content Pages For Liferay 7.3 and Earlier Versions For Liferay DXP/Portal 7.3, you can review web content deployed using fragments and widgets in the Contents panel (Contents). ...
Using Page Comments
Official Documentation
Using Page Comments When building content pages, you and your team can collaborate using Liferay's page comments feature. Comments are enabled out-of-the-box in Liferay DXP 7.3+. Use page comments...
Converting Widget Pages to Content Pages
Official Documentation
Converting Widget Pages to Content Pages In older versions, widget pages provided exclusive features, such as custom layouts and customizable columns. Many of these exclusive features are available...