Capability

Development and Tooling

Liferay offers a comprehensive toolkit to extend or customize your digital experience. Build applications quickly with low-code/no-code features like Objects, or leverage developer tools like Liferay Workspace and Blade CLI for further customizations.

For users on PaaS or running Self-Hosted, Liferay also offers tools deploying customizations.

Feature
Deployment Approach
Capability
Advanced Web Content API
Official Documentation
Advanced Web Content API Using the Liferay DXP REST services, you can create and manage your site's structured content. Structured content is web content that uses a web content structure (or...
Published Date: May 9, 2024 6:51 PM
Managing Web Content Structures and Templates by Using the REST API
Official Documentation
Managing Web Content Structures and Templates by Using the REST API Web content structures define the information included in a web content article. Structures facilitate creating and managing web...
Published Date: May 9, 2024 6:51 PM
Web Content Articles
Official Documentation
Web Content Articles Web content articles are dynamic content entries that can be created, edited, and managed through Liferay’s built-in content management system (CMS). You can use web content...
Published Date: May 9, 2024 6:51 PM
Creating Web Content Articles
Official Documentation
Creating Web Content Articles When you have a lot of content to publish on your site, Liferay's content management system helps you with practical and essential ways to manage it. Web content...
Published Date: May 9, 2024 6:51 PM
Assigning Permissions to Web Content Articles
Official Documentation
Assigning Permissions to Web Content Articles With Liferay's permissions framework, you can control which users can create, view, and manage web content articles. You can set permissions for...
Published Date: May 9, 2024 6:51 PM
Generating Text Content Using AI
Official Documentation
Generating Text Content Using AI Liferay DXP 2023.Q4+/Portal GA98+ Web content provides integration with OpenAI's ChatGPT engine using the AI Creator tool. With an OpenAI API key configured for...
Published Date: May 9, 2024 6:51 PM
Using Expiration and Review Dates in Web Content
Official Documentation
Using Expiration and Review Dates in Web Content Available: Liferay DXP/Portal 7.4+ You can set expiration and review dates for web content articles to manage time-sensitive content. When enabled,...
Published Date: May 9, 2024 6:51 PM
Web Content Structures
Official Documentation
Web Content Structures Web content structures are the building blocks for web content articles. They determine the information you can include when writing web content. Structures provide these key...
Published Date: May 9, 2024 6:51 PM
Assigning Permissions to Web Content Structures and Templates
Official Documentation
Assigning Permissions to Web Content Structures and Templates Web content structures and templates provide direct access to Liferay's API. To avoid unauthorized or unintended access to Liferay DXP...
Published Date: May 9, 2024 6:51 PM
Configuring Web Content Structure Fields
Official Documentation
Configuring Web Content Structure Fields You can edit web content structure fields and their properties: Open the Site Menu (Site Menu) and go to Content & Data → Web Content. Select the...
Published Date: May 9, 2024 6:51 PM
Creating Web Content Structures
Official Documentation
Creating Web Content Structures Create web content structures to serve as building blocks for web content articles and determine the information you can include when writing them. To create a web...
Published Date: May 9, 2024 6:51 PM
Web Content Structures with Data Engine
Official Documentation
Web Content Structures with Data Engine Beginning with Liferay 7.4, web content structures were migrated from using Dynamic Data Mapping (DDM) to Data Engine (DE) as the backend framework for...
Published Date: May 9, 2024 6:51 PM
Creating Web Content Templates
Official Documentation
Creating Web Content Templates Web content templates use the FreeMarker Template Language (FTL) to determine how content fields are rendered on a page. Each template can be associated with a web...
Published Date: May 9, 2024 6:51 PM
Consuming REST Services
Official Documentation
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...
Published Date: May 9, 2024 6:51 PM
Data Migration Center
Official Documentation
Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...
Published Date: May 9, 2024 6:51 PM
Making Unauthenticated Requests
Official Documentation
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
Published Date: May 9, 2024 6:51 PM
Sample API Tutorials
Official Documentation
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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....
Published Date: May 9, 2024 6:51 PM
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. ...
Published Date: May 9, 2024 6:51 PM
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....
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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)...
Published Date: May 9, 2024 6:51 PM
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. ...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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....
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
Getting Started
Official Documentation
Getting Started Liferay DXP is a powerful, open source, enterprise-ready platform for building and deploying web applications. However, all of that power and functionality can make it difficult to...
Published Date: May 9, 2024 6:51 PM
Managing Web Content Structures
Official Documentation
Managing Web Content Structures You can manage structures from the structures page: Open the Site Menu (Site Menu) and go to Content & Data → Web Content. Select the Structures tab. Open the...
Published Date: May 9, 2024 6:51 PM
Web Content Templates
Official Documentation
Web Content Templates With Web Content Templates, you can define how content appears, ensuring that your web content aligns with your brand and functional requirements. Learn how to create...
Published Date: May 9, 2024 6:51 PM