Site Search - Liferay Learn

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 Kerberos

Official Documentation

Authenticating with Kerberos You can use Kerberos to authenticate Microsoft Windows™ accounts with Liferay DXP, using Liferay DXP's LDAP support and a web server that supports the Kerberos...

Authenticating with SAML

Official Documentation

Authenticating with SAML Subscription 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...

Configuring SAML at the Instance Level

Official Documentation

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

SAML Authentication Process Overview

Official Documentation

SAML Authentication Process Overview Subscription 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...

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

SAML Admin

Official Documentation

SAML Admin Subscription 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...

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

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

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

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

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

Fast IDentity Online 2

Official Documentation

Fast IDentity Online 2 Subscription 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,...

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

Multi-Factor Authentication

Official Documentation

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

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

System for Cross-domain Identity Management (SCIM)

Official Documentation

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

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

Multi-Factor Authentication Checkers

Official Documentation

Multi-Factor Authentication Checkers Subscription Liferay DXP 7.4 ships with two additional factor checkers for Multi-Factor Authentication. Both of them are disabled by default, because they're...

Using Multi-Factor Authentication

Official Documentation

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

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

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

Activating Liferay DXP

Official Documentation

Activating Liferay DXP Starting with the 2026.Q1 release, all Liferay DXP installations—including trial and free-tier environments—require an XML (.xml) activation key to enable core features and...

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

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

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

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

Upgrading Liferay

Official Documentation

Upgrading Liferay Liferay is continuously being enhanced with new features as new versions are released. To access these features in your current project, you must upgrade your Liferay instance to...

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

Initial Instance Localization

Official Documentation

Initial Instance Localization Liferay DXP supports localization by language, time zone, and more. The English (US) language translation and UTC 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...

Tuning Your JVM

Official Documentation

Tuning Your JVM Java Virtual Machine (JVM) tuning primarily focuses on adjusting Java heap and non-heap settings and configuring garbage collection. Finding settings that perform well for you...

Serving Static Resources via a CDN

Official Documentation

Serving Static Resources via a CDN This article explains how to configure Liferay to rewrite URLs for static resources (images, CSS, JS) so they are served from a separate CDN domain. A Content...

Preparing for an Upgrade

Official Documentation

Preparing for an Upgrade Preparation and planning may be of little consequence for small, casual installations but is mandatory for large enterprise-level installations. There are specific...

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

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

Upgrading the Database

Official Documentation

Upgrading the Database Liferay's tools and instructions facilitate upgrading DXP and Portal environments safely and quickly. Non-clustered environments that have small data sets, can be upgraded...

Development

Official Documentation

Development Liferay's development platform makes developers faster and more efficient by providing a baseline set of features to build upon. Rather than start from scratch, you can start instead...

Building Applications

Official Documentation

Building Applications For maximum compatibility with all of Liferay's deployment options, you can combine Liferay's Objects, Client Extensions, and other features and tools to build real-world...

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

Building a Custom Ticketing System

Official Documentation

Building a Custom Ticketing System Liferay makes it easy for you to build digital solutions. For example, you can create a custom ticketing application with the styling and features needed for your...

Defining a Custom Data Schema

Official Documentation

Defining a Custom Data Schema The ticketing application requires custom data fields and selections. You use Liferay objects and picklists to define a custom data schema. Creating Custom Picklists...

Deploying a Custom Application

Official Documentation

Deploying a Custom Application You can use a custom element client extension to render a JavaScript application as a widget on a Liferay site page. The application is served by Liferay and...

Implementing a Documentation Referral System

Official Documentation

Implementing a Documentation Referral System The ticketing system can be further enhanced with a documentation referral system. The system searches automatically for relevant documentation based on...

Ticket Management with Cron Jobs

Official Documentation

Ticket Management with Cron Jobs Use Cron jobs to automate managing tickets. For example, have a job to run at a regular schedule to delete any tickets that have a resolution type of duplicate or...

Applying a Custom Theme

Official Documentation

Applying a Custom Theme You can use different front-end client extensions to customize the look and feel of your site. Specifically, theme CSS type client extension can be used as an alternative to...

Building a Time Off Requester

Official Documentation

Building a Time Off Requester Liferay 7.4+ With Liferay Objects, you can build entire applications without writing code or deploying modules. Here, create a Time Off Request application using...

Asset Framework

Official Documentation

Asset Framework The asset framework is behind many of Liferay's most powerful features. It provides tools for displaying and interacting with any type of content and data. For example, if you build...

Enabling Assets

Official Documentation

Enabling Assets Many of Liferay's applications (e.g. Blogs, Documents and Media, Message Boards, etc.) are asset-enabled out of the box. You can publish assets with the Asset Publisher widget or...

Cache

Official Documentation

Cache

Expando

Official Documentation

Expando Accessing Custom Fields with Expando

Data Frameworks

Official Documentation

Data Frameworks

Data Scopes

Official Documentation

Data Scopes

Defining Entities

Official Documentation

Defining Entities Entities are the heart and soul of a service. They represent the map between the model objects in Java and your database fields and tables. Service Builder automatically maps your...

Search Results