Site Search - Liferay Learn

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Liferay's Default Cookies Reference

Liferay's Default Cookies Reference Strictly Necessary Cookies Cookie NamePurposeDuration COOKIE_SUPPORTStores the user's preference (true/false) to store cookies in the browser.365 Days...

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

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

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

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

SAML Authentication Process Overview

Official Documentation

SAML Authentication Process Overview Both the IdP and the SP can initiate the Single Sign On process, and the SSO flow is different depending on each one. Regardless of how it's initiated, SSO is...

Securing Liferay

Official Documentation

Securing Liferay Liferay is built with security in mind. This includes mitigation of common security vulnerabilities and exploits like those described by the OWASP Top 10 and the CWE/SANS Top 25. ...

Configuring Sign-In

Official Documentation

Configuring Sign-In By default, Liferay DXP uses the Sign In widget to authenticate users. The Sign In widget appears on the default home page at http[s]://[server-name:port]/web/guest/home. If...

Configuring Single Sign-On

Official Documentation

Configuring Single Sign-On Liferay Portal/DXP supports many ways of authenticating, from token-based solutions to standards such as OpenID Connect and SAML. With all the available options, you...

Authenticating with CAS (Central Authentication Service)

Official Documentation

Authenticating with CAS (Central Authentication Service) CAS was deprecated as of Liferay DXP 7.2 and removed as of Liferay DXP 7.4. Please use SAML instead. CAS is a widely used open source...

Authenticating with Kerberos

Official Documentation

Authenticating with Kerberos You can use Kerberos to authenticate Microsoft Windows™ accounts with Liferay DXP. This is done by using a combination of Liferay DXP's LDAP support and a web server...

Authenticating with SAML

Official Documentation

Authenticating with SAML The SAML (Security Assertion Markup Language) adapter provides Single Sign On (SSO) and Single Log Off (SLO) in your deployment. SAML works by using Identity Providers...

Configuring SAML at the Instance Level

Official Documentation

Configuring SAML at the Instance Level Each portal instance can be a SAML provider, either an Identity Provider (IdP) or a Service Provider (SP). Whichever role your DXP instance fills, you can...

Configuring SAML at the System Level

Official Documentation

Configuring SAML at the System Level Before allowing any portal instances to enable SAML authentication, you should configure it at the system level so those instances have a foundation from which...

Importing User Groups' Memberships from an External IdP through SAML

Official Documentation

Importing User Groups' Memberships from an External IdP through SAML This feature was released behind a dev feature flag. It was made Generally Available (GA) in Liferay DXP 2024.Q2/Portal GA120....

SAML Admin

Official Documentation

SAML Admin The SAML Admin panel is the best place to configure your SAML instance. Use it instead of Instance Settings to streamline your SAML administration experience. Starting from Liferay...

Configuring Liferay Authentication With Okta Using OpenId Connect

Official Documentation

Configuring Liferay Authentication With Okta Using OpenId Connect This tutorial guides you through the basic steps needed to integrate Okta, your Identity Provider (IdP), with your environment...

Configuring Liferay Authentication With PingOne Using SAML

Official Documentation

Configuring Liferay Authentication With PingOne Using SAML This tutorial guides you through the basic steps needed to integrate PingOne, your Identity Provider (IdP), with your Liferay environment...

Using OpenAM

Official Documentation

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

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

Configuring Liferay Authentication With Auth0 Using OpenId Connect

Official Documentation

Configuring Liferay Authentication With Auth0 Using OpenId Connect This tutorial guides you through integrating Auth0, your Identity Provider (IdP), with your Liferay environment using OpenID...

Token-based Single Sign On Authentication

Official Documentation

Token-based Single Sign On Authentication Token-based SSO authentication was introduced in Liferay Portal 7.0 to standardize support for Shibboleth, SiteMinder, Oracle OAM, and any SSO product that...

Using OpenID Connect

Official Documentation

Using OpenID Connect OpenID Connect is a lightweight authentication layer that enables users to authenticate using accounts they have on other systems. It's built on top of the OAuth 2.0...

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

Multi-Factor Authentication

Official Documentation

Multi-Factor Authentication Liferay DXP 7.3+ Multi-Factor Authentication (MFA) provides better security by requiring users to prove their identity in multiple ways, or factors. The basic user...

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

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

Configuring Content Security Policy Headers

Official Documentation

Configuring Content Security Policy Headers Modern browsers use Content Security Policy HTTP response headers to enhance web pages' security to mitigate certain types of attacks (like Cross-Site...

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

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

Using Multi-Factor Authentication

Official Documentation

Using Multi-Factor Authentication To enhance your installation's security, you should disable less secure, one-factor forms of authentication, such as Basic Auth, Digest Auth, and WebDAV. You can...

Securing Web Services

Official Documentation

Securing Web Services Liferay DXP provides four security layers for web services: IP permission layer: The IP address from which a web service invocation request originates must be white-listed in...

Setting Service Access Policies

Official Documentation

Setting Service Access Policies Service Access Policies define what services or service methods can be invoked remotely. You can apply many of them at once to produce a combined effect. They are...

Setting Up CORS

Official Documentation

Setting Up CORS CORS stands for Cross-Origin Resource Sharing. An Origin is a web server at a different domain, and a Resource is some asset stored on the server, like an image, PDF, or HTML file....

Using Authentication Verifiers

Official Documentation

Using Authentication Verifiers Authentication Verifiers authenticate remote invocations of Liferay Portal's API in a centralized and extensible way. They have two main responsibilities: Verify...

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

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

Search Results