Site Search - Liferay Learn

Using OpenAM Deprecated in Liferay DXP 2024.Q4/Portal GA129 OpenAM 13 is deprecated as of Liferay DXP 2024.Q4/Portal GA129. OpenAM 12 and below were deprecated as of Liferay DXP 7.2. Versions of...

Fast IDentity Online 2

Official Documentation

Fast IDentity Online 2 Available: Liferay DXP/Portal 7.4+ The Fast IDentity Online 2 or FIDO2 standard allows for the use of biometrics (i.e., fingerprint readers), mobile devices, or other...

System for Cross-domain Identity Management (SCIM)

Official Documentation

System for Cross-domain Identity Management (SCIM) Liferay DXP 2024.Q1+ System for Cross-domain Identity Management or SCIM, is an open standard that automates user provisioning. In other words,...

AntiSamy

Official Documentation

AntiSamy Liferay DXP includes an AntiSamy module that protects against user-entered malicious code. If your site allows users to post content in message boards, blogs, or other applications, these...

Enabling Document Creation and Editing with Microsoft Office 365

Official Documentation

Enabling Document Creation and Editing with Microsoft Office 365 Liferay DXP integrates with Microsoft Office 365™ so you can create and edit documents, spreadsheets, and presentations stored in...

Configuring Caching for Documents and Media

Official Documentation

Configuring Caching for Documents and Media Liferay 7.3 U23+, Liferay 7.4 U21+, GA21+ By default, Documents and Media files are not cached by browsers or servers. This is because file visibility...

Enabling FFmpeg for Audio and Video Previews

Official Documentation

Enabling FFmpeg for Audio and Video Previews Documents and Media provides integration with the FFmpeg multimedia framework for generating audio and video file previews. To use this integration, you...

Enabling LibreOffice / OpenOffice Integration

Official Documentation

Enabling LibreOffice / OpenOffice Integration LibreOffice and OpenOffice are open source productivity suites that you can integrate with Liferay. By default Liferay includes PDFBox, which generates...

DevOps

Official Documentation

DevOps :::: 2 :gutter: 3 3 3 3 ::: Local Integrations Configuring Documents and Media Previews Enabling Antivirus Scanning for Uploaded Files Configuring Cache Control for Documents and Media...

Configuring Documents and Media Previews

Official Documentation

Configuring Documents and Media Previews Liferay 7.4 U84+/GA84+ By default, Liferay uses PDFBox to generate previews for files added to the document library. This is because PDFBox is the only...

Enabling Document Creation and Editing with Google Drive

Official Documentation

Enabling Document Creation and Editing with Google Drive Liferay DXP provides integration with Google Drive so you can create and edit Google Docs, Sheets, and Slides via the Documents and Media...

Enabling Links to Google Drive Documents

Official Documentation

Enabling Links to Google Drive Documents Liferay supports Google Drive in Documents and Media. When enabled, you can create shortcuts to your Google Drive files that enable you to view and manage...

Setting Storage Quotas for Documents and Media

Official Documentation

Setting Storage Quotas for Documents and Media You can define storage quotas in Documents and Media by enabling the data.limit.dl.storage.max.size portal property. Once you define a value for this...

Creating SharePoint Repositories in Documents and Media

Official Documentation

Creating SharePoint Repositories in Documents and Media Once you've added a SharePoint OAuth2 configuration, you can use it to create repositories in Documents and Media that are mounted to...

SCIM Group API Basics

Official Documentation

SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...

Captcha API Basics

Official Documentation

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

SCIM Resource Type, Service Provider, and Schema Basics

Official Documentation

SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...

SCIM User API Basics

Official Documentation

SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...

Self-Hosted Installation and Upgrades

Official Documentation

Self-Hosted Installation and Upgrades Liferay's flexibility makes it possible to host it in any way you choose: on any Kubernetes-based cloud platform via Helm charts and Terraform scripts, on...

Installing a Liferay-Tomcat Bundle

Official Documentation

Installing a Liferay-Tomcat Bundle The Tomcat Bundle includes the Apache Tomcat application server with Liferay DXP/Portal pre-deployed. It's the easiest, fastest way to install Liferay on...

Running Liferay for the First Time

Official Documentation

Running Liferay for the First Time Once you've installed Liferay DXP/Portal and configured a database for it, it is ready to run. Start the Server Run the startup script bundled with your...

Installing Liferay On A Local Server

Official Documentation

Installing Liferay On A Local Server Liferay runs on an application server. There are three ways to host Liferay on a local machine: Using a Docker container Using a Liferay Tomcat bundle On a...

Setting Up JNDI on Tomcat

Official Documentation

Setting Up JNDI on Tomcat Liferay 7.4+ To set up JNDI resources, you must put the necessary JDBC drivers in the Tomcat lib folder (i.e. tomcat-9.0.56/lib). For example, if you use an Oracle...

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

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

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

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

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

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

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

File Storage

Official Documentation

File Storage All files uploaded to Liferay DXP are stored in the instance's designated file store. This includes files uploaded using Documents and Media, as well as those uploaded using...

Installing Earlier Liferay Versions on JBoss EAP

Official Documentation

Installing Earlier Liferay Versions on JBoss EAP Liferay DXP 2025.Q2/Portal 2025.Q1 or below Installing on JBoss EAP requires installing the DXP WAR, installing dependencies, configuring JBoss,...

Installing Earlier Liferay Versions on WebLogic

Official Documentation

Installing Earlier Liferay Versions on WebLogic Liferay DXP 2025.Q2/Portal 2025.Q1 or below If you are using WebLogic as your application server, it is highly recommended to install DXP to a...

Installing Earlier Liferay Versions on Wildfly

Official Documentation

Installing Earlier Liferay Versions on Wildfly Liferay DXP 2025.Q2/Portal 2025.1 or below Installing on WildFly requires installing the DXP WAR, installing dependencies, configuring WildFly, and...

Installing on JBoss EAP

Official Documentation

Installing on JBoss EAP Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on JBoss EAP. Installing on JBoss EAP requires installing the DXP...

Installing Earlier Liferay Versions on Tomcat

Official Documentation

Installing Earlier Liferay Versions on Tomcat Liferay DXP 2025.Q2/Portal 2025.Q1 or below Using a Liferay-Tomcat bundle or Docker image is the fastest way to get started using Liferay DXP. This...

Installing Earlier Liferay Versions on Application Servers

Official Documentation

Installing Earlier Liferay Versions on Application Servers As new Liferay versions are released, their dependencies and installation steps change. Liferay made a big change for DXP with the 2025.Q3...

Installing Earlier Liferay Versions on WebSphere

Official Documentation

Installing Earlier Liferay Versions on WebSphere Liferay DXP 2024.Q1/Portal GA112 or below Compatibility with IBM WebSphere application server has been removed in 2024.Q2 and later releases. ...

Installing on Tomcat

Official Documentation

Installing on Tomcat Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on Tomcat. Using a Liferay-Tomcat bundle or Docker image is the...

Installing on WildFly

Official Documentation

Installing on WildFly Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on WildFly. Installing on WildFly requires installing the DXP WAR,...

Using Configuration Files

Official Documentation

Using Configuration Files System Settings provides a user interface for making system-scoped configuration changes and setting default configurations for other scopes. The same configurations in...

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 Containers

Official Documentation

Configuring Containers Everything that is configurable in a Liferay installation is configurable in a Liferay Docker container. Here are the most common things to configure: JVM Options Portal...

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

Search Results