Site Search - Liferay Learn

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,...

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 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...

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...

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) ...

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 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...

Configuring Microsoft Office 365 with OAuth

Official Documentation

Configuring Microsoft Office 365 with OAuth Liferay DXP 7.4 U79+/Liferay Portal 7.4 GA79+ Connect your Microsoft email service to Liferay with the use of OAuth 2.0 authorization. Note, Microsoft...

Initial Instance Localization

Official Documentation

Initial Instance Localization Liferay DXP supports localization by language, time zone, and more. The English (US) language translation and GMT time zone are the defaults, but DXP has over 40...

Tuning Liferay

Official Documentation

Tuning Liferay There are several ways to tune Liferay's performance. This involves configuring the Java Virtual Machine and frameworks that support the Liferay application, monitoring performance...

Using a CDN

Official Documentation

Using a CDN A Content Delivery Network (CDN) is a distributed infrastructure for caching static, file-based content. When visitors hit your site, your static content is loaded from the server...

Upgrade Report

Upgrade Report Available 7.4+ When you perform upgrades, it is important to know the changes made and any issues that occurred. The upgrade status returns combined results for core upgrades,...

Updating Customizations

Official Documentation

Updating Customizations Plugins (e.g., themes, apps, and customizations) you've developed must be adapted to the new Liferay version. This can be as simple as updating dependencies or involve...

Migrating Configurations and Properties

Migrating Configurations and Properties Your current DXP installation's OSGi configurations (7.0+) and properties (such as portal properties and system properties) set up your DXP instance to fit...

Using Google Sheets with Objects

Official Documentation

Using Google Sheets with Objects Liferay 7.4+ These articles explain how to use webhooks to trigger sync tasks between Liferay Objects and Google Sheets using a variety of third party tools.

Picklists

Official Documentation

Picklists Liferay 7.4+ Liferay picklists are predefined lists of string values that consist of a name/key pair and can include any number of items. Once a list is created, you can use it to add a...

Workflow

Official Documentation

Workflow Liferay DXP ships with a workflow engine that allows reviewing and approving content such as Blogs, Web Content, or Wikis before publication. Define any number of business...

Adding Addresses to an Account for Commerce 2.1 and Earlier Versions

Official Documentation

Adding Addresses to an Account for Commerce 2.1 and Earlier Versions This article documents how to update an account's billing and shipping addresses using either the Control Panel. Navigate to...

Monitoring Upgrades with MBeans

Monitoring Upgrades with MBeans Liferay DXP 7.4 U76 / Liferay Portal 7.4 GA76 When upgrade upon startup is enabled, the upgrade process can be monitored with MBeans through a JVM management tool...

Upgrading Modules Using Gogo Shell

Upgrading Modules Using Gogo Shell To troubleshoot upgrade issues with particular modules, it may be necessary to test and perform upgrades on a per-module basis, instead of en-masse. Liferay has...

Updating the File Store

Updating the File Store File store options and configuration values changed in Liferay DXP 7.0. If you're on 7.0 or earlier and are affected by these changes, you must update your file store before...

Upgrading Clustered and Sharded Environments

Upgrading Clustered and Sharded Environments If you're upgrading a clustered installation, you must follow an upgrade approach that fits your cluster requirements. See Maintaining Clustered...

Upgrading a Sharded Environment

Upgrading a Sharded Environment Since Liferay DXP 7.0, Liferay removed its own physical partitioning implementation (also known as sharding) in favor of the capabilities provided natively by...

Upgrading via Auto Upgrade

Upgrading via Auto Upgrade You can upgrade your database automatically by enabling auto upgrade via the portal property before starting up your instance. Always back up your database and existing...

Upgrading via Docker

Upgrading via Docker Running a Liferay Docker image with auto-upgrade enabled uses the Database Upgrade Tool to upgrade your database transparently on Liferay startup. After the upgrade completes,...

Database Upgrade Tool Reference

Database Upgrade Tool Reference Before Liferay 7.4 U82/GA82, the db_upgrade_client.sh file was called db_upgrade.sh. Here's an overview of Liferay's upgrade tool. Start the upgrade tool using...

Using Liferay Docker Images

Official Documentation

Using Liferay Docker Images Docker Hub hosts Liferay DXP and Liferay Portal Docker images, bundled with Tomcat on Linux. The Liferay Docker Hub pages provide image details and tags for the...

Container Lifecycle and API

Official Documentation

Container Lifecycle and API At a high level, the container starts Tomcat with Liferay deployed on it. Additionally, however, the container entry point provides an API for executing these use cases:...

Building Liferay Docker Images

Official Documentation

Building Liferay Docker Images Liferay is open-source and fully customizable. You can create your own Liferay Docker images using Dockerfiles to suit the needs of your installation. For example,...

Docker Image Versions

Official Documentation

Docker Image Versions Liferay Docker image tags begin with a Liferay software version and end with an image version. [Liferay software version] [image version] For example, Liferay DXP 7.4.13...

Installing Apps and Other Artifacts to Containers

Official Documentation

Installing Apps and Other Artifacts to Containers Applications and other artifacts (such as DXP activation keys) are installed to DXP Docker containers via the container's /mnt/liferay/deploy...

Licensing DXP in Docker

Official Documentation

Licensing DXP in Docker If you're using a DXP trial license that's expiring or you have a new license (activation key) you must install, you can replace your container's existing license. Here's...

Patching DXP in Docker

Official Documentation

Patching DXP in Docker Liferay patches fix DXP issues and the Patching Tool applies the patches. On Docker Hub, Liferay provides images pre-populated with each new Fix Pack, Security Fix Pack, and...

Providing Files to the Container

Official Documentation

Providing Files to the Container The Liferay container uses the files you provide to execute the following use cases: Configure Liferay with .properties Files and .config files Configure Tomcat...

Running Scripts in Containers

Official Documentation

Running Scripts in Containers If there's more that you want to do in the Liferay container beyond setting up Tomcat and Liferay files, deploying arifacts, and applying patches, you can use scripts....

Upgrading to a New Docker Image

Official Documentation

Upgrading to a New Docker Image As new Liferay versions are released as Docker images, you can upgrade to them. Upgrading Liferay describes the process. Always back up your data and installation...

Sites

Official Documentation

Sites Sites are customizable spaces for building personalized digital experiences. They are a fundamental component of Liferay DXP. At its core, a site is a collection of pages that contains...

Adding a Site

Official Documentation

Adding a Site Sites are customizable spaces within Liferay, designed for building personalized digital experiences that engage specific audiences and meet unique organizational goals. Creating a...

Creating Pages

Official Documentation

Creating Pages Pages form the foundation of your site's content and user experience. With Liferay, you can create dynamic and engaging web experiences using flexible, low-code tools to define...

Adding Pages

Official Documentation

Adding Pages Managing a Liferay site involves adding and customizing pages to deliver content and create a personalized user experience. Learn how to create new pages and child pages from the...

Adding a Page to a Site

Official Documentation

Adding a Page to a Site Adding and customizing pages is a key part of managing your Liferay site. You can add pages using the Pages application or through the Page Tree menu. For Liferay 7.4 U22+...

Exporting and Importing Page Templates

Official Documentation

Exporting and Importing Page Templates Sometimes, it's easier to edit templates in a code editor. After you create a page template, you can export it for local editing. Once you've made the...

7.2 Breaking Changes

Official Documentation

7.2 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...

Data Cleanup

Data Cleanup Before database upgrades, Liferay executes data cleanup processes to repair databases with obsolete data. This lightens the load of the upgrade tool, improving performance and reducing...

Database Tuning for Upgrades

Database Tuning for Upgrades Performing an upgrade impacts the database differently from daily running in production. Because of this, you should tune your database for the upgrade process before...

Example: Removing Intermediate Journal Article Versions

Example: Removing Intermediate Journal Article Versions These instructions and code samples demonstrate removing intermediate Journal Article versions. In the script console, you can remove...

Troubleshooting Upgrades

Official Documentation

Troubleshooting Upgrades Liferay has many out-of-the-box tools and features to identify and solve issues that may arise when performing an upgrade. To troubleshoot, you can upgrade modules...

7.4 Breaking Changes

Official Documentation

7.4 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay 7.4, starting with the latest quarterly...

Post-Upgrade Considerations

Official Documentation

Post-Upgrade Considerations After upgrading the database, you should configure Liferay for production again and check up on feature changes that might affect your Liferay instance. Re-enable...

Liferay DXP 2024.Q2 Breaking Changes

Official Documentation

Liferay DXP 2024.Q2 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay DXP 2024.Q2. As the...

Liferay DXP 2024.Q3 Breaking Changes

Official Documentation

Liferay DXP 2024.Q3 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay DXP 2024.Q3. As the...

2024 Deprecations and Breaking Changes

2024 Deprecations and Breaking Changes Liferay quarterly releases introduce new features and enhancements while phasing out older or less-used functionality. Some features move to Maintenance Mode,...

Maintenance Mode and Deprecations in Liferay DXP 2024.Q3

Maintenance Mode and Deprecations in Liferay DXP 2024.Q3 Features moved to Maintenance Mode or marked as Deprecated in Liferay DXP 2024.Q3 appear here. For details about these statuses and their...

Maintenance Mode and Deprecations in 7.3

Maintenance Mode and Deprecations in 7.3 With each new DXP release, a feature may not warrant continued enhancements or may become obsolete. Stopping enhancements for a feature puts it in...

Maintenance Mode and Deprecations in 7.2

Maintenance Mode and Deprecations in 7.2 With each new DXP release, a feature may not warrant continued enhancements or may become obsolete. Stopping enhancements for a feature puts it in...

Renamed Language Keys

Renamed Language Keys In Liferay DXP/Portal 7.4, module language keys were centralized to a module called portal-language-lang. Source location: ...

Search Results