Search Results

Capability
Feature
Deployment Approach
Introduction to the Admin Account
Introduction to the Admin Account The Admin User account is created by default in any new installation of Liferay DXP and has full permissions to modify every facet of a Liferay DXP instance. The...
Published Date: May 9, 2024 6:51 PM
Navigating DXP
Navigating DXP Liferay DXP's out-of-the-box navigation is organized into three major areas: Site Menu, Personal Menu, and Global Menu. Site Menu The DXP Site Menu on the left side of the screen...
Published Date: May 9, 2024 6:51 PM
Starting with a Docker Image
Starting with a Docker Image The latest versions of Liferay are available as Docker images on Docker Hub. They're in two categories: Liferay/Portal Liferay/DXP Follow the steps below to...
Published Date: May 9, 2024 6:51 PM
Headless Delivery
Headless Delivery
Published Date: May 9, 2024 6:51 PM
API Builder
API Builder Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently behind a beta feature...
Published Date: May 9, 2024 6:51 PM
Producing and Implementing APIs with REST Builder
Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...
Published Date: May 9, 2024 6:51 PM
Building a Sample API Application
Building a Sample API Application Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) The API Builder is...
Published Date: May 9, 2024 6:51 PM
APIs with REST Builder
APIs with REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate...
Published Date: May 9, 2024 6:51 PM
API Headers Reference
API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...
Published Date: May 9, 2024 6:51 PM
API Query Parameters
API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...
Published Date: May 9, 2024 6:51 PM
Consuming APIs
Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...
Published Date: May 9, 2024 6:51 PM
Batch Engine API Basics - Exporting Data
Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...
Published Date: May 9, 2024 6:51 PM
Batch Engine API Basics - Importing Data
Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...
Published Date: May 9, 2024 6:51 PM
Configuring JSON Web Services
Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...
Published Date: Nov 16, 2024 3:32 PM
Consuming GraphQL APIs
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here's how to consume them in three steps: Identify the API you wish to consume. Identify the site...
Published Date: May 9, 2024 6:51 PM
Consuming REST Services
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
Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently, this feature is behind a...
Published Date: May 9, 2024 6:51 PM
Making Unauthenticated Requests
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
Using External Reference Codes
Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...
Published Date: May 9, 2024 6:51 PM
Sample API Tutorials
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
Using Liferay as a Headless Platform
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
Published Date: Nov 22, 2024 10:48 PM
Using OAuth 2.0
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...
Published Date: May 9, 2024 6:51 PM
Authorizing Account Access with OAuth2
Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....
Published Date: Nov 22, 2024 10:48 PM
Creating an OAuth2 Application
Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Open the Global Menu...
Published Date: Nov 22, 2024 10:48 PM
JSON Web Tokens (JWTs)
JSON Web Tokens (JWTs) JSON Web Tokens (JWTs) represent encoded data. They are compact, self-contained, and secure. There are two primary types of JSON Web Tokens: Encrypted JWT: ensures the...
Published Date: Feb 25, 2025 12:39 PM
Configuring the JWT Bearer Flow
Configuring the JWT Bearer Flow To use JWT Bearer as a grant type in Liferay, you must create an OAuth 2 client with the Client Authentication Method set to Client Secret Basic or Post. The client...
Published Date: Feb 25, 2025 12:39 PM
Issuing JWT Access Tokens
Issuing JWT Access Tokens Liferay DXP 7.4 U45+/GA45+ You can configure Liferay to issue access tokens in the JWT format from System Settings. Enabling JWT Tokens Open the Global Menu...
Published Date: Feb 25, 2025 12:39 PM
JSON Web Token Assertions
JSON Web Token Assertions An assertion helps in sharing identity and security information across different domains. There are two uses for assertions: Authorization grants Client authentication...
Published Date: Feb 25, 2025 12:39 PM
Using Private Key JWT (JSON Web Token)
Using Private Key JWT (JSON Web Token) Liferay supports private key JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion. Liferay authenticates...
Published Date: Mar 6, 2025 4:05 PM
OAuth 2 Scopes
OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...
Published Date: Nov 22, 2024 10:48 PM
Using OAuth2 to Authorize Users
Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...
Published Date: Nov 22, 2024 10:48 PM
DXP
DXP Welcome to the official documentation for the latest versions of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used around the world,...
Published Date: Nov 22, 2024 10:49 PM
Configuring a Database
Configuring a Database 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,...
Published Date: Nov 22, 2024 10:49 PM
Installation and Upgrades
Installation and Upgrades
Published Date: Nov 22, 2024 10:49 PM
Installing Liferay
Installing Liferay Liferay runs on an application server. There are three ways to host Liferay: Using a Docker container Using a Liferay Tomcat bundle, on premises On a supported application...
Published Date: Nov 22, 2024 10:49 PM
Installing a Liferay-Tomcat Bundle
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...
Published Date: Nov 22, 2024 10:49 PM
Installing Liferay on an Application Server
Installing Liferay on an Application Server You can install Liferay DXP or Liferay Portal on any supported application server. This is typically the most practical installation type to use in...
Published Date: Jan 18, 2025 2:46 AM
Installing on Tomcat
Installing on Tomcat Using a Liferay-Tomcat bundle or Docker image is the fastest way to get started using Liferay DXP. This article is for users who want to have full control over their Tomcat...
Published Date: Nov 22, 2024 10:49 PM
Installing on WebLogic
Installing on WebLogic If you are using WebLogic as your application server, it is highly recommended to install DXP to a WebLogic Managed server. A managed server can start and stop DXP quickly...
Published Date: Nov 22, 2024 10:49 PM
Installing on JBoss EAP
Installing on JBoss EAP Installing on JBoss EAP requires installing the DXP WAR, installing dependencies, configuring JBoss, and deploying DXP on JBoss. You must also configure your database and...
Published Date: Nov 22, 2024 10:49 PM
Installing on WebSphere
Installing 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 Liferay DXP on...
Published Date: Nov 22, 2024 10:49 PM
Installing on WildFly
Installing on WildFly Installing on WildFly requires installing the DXP WAR, installing dependencies, configuring WildFly, and deploying DXP on WildFly. You must also configure your database and...
Published Date: Nov 22, 2024 10:49 PM
Configuring Cluster Link
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....
Published Date: May 9, 2024 6:52 PM
Clustering for High Availability
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...
Published Date: May 9, 2024 6:52 PM
Configuring Unicast over TCP
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...
Published Date: May 9, 2024 6:52 PM
Database Configuration for Cluster Nodes
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...
Published Date: May 9, 2024 6:52 PM
Example: Creating a Simple DXP Cluster
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...
Published Date: May 9, 2024 6:52 PM
Using Liferay's Delta Manager for Improved Session Replication Performance
Using Liferay's Delta Manager for Improved Session Replication Performance Liferay DXP 2024.Q3+/Portal GA92+ To ensure user session data is synchronized across all instances in the cluster,...
Published Date: Jan 18, 2025 2:47 AM
Configuring Microsoft Office 365 with OAuth
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...
Published Date: May 9, 2024 6:52 PM
Initial Instance Localization
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...
Published Date: May 9, 2024 6:52 PM
Tuning Liferay
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...
Published Date: May 9, 2024 6:52 PM
Tuning Your JVM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
Other Upgrade Scenarios
Other Upgrade Scenarios If you're upgrading a clustered installation, you must follow an upgrade approach that fits your cluster requirements. See Maintaining Clustered Installations to learn the...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
Default Setting and Feature Flag Changes in 7.4
Default Setting and Feature Flag Changes in 7.4 Most new versions of Liferay DXP include changes to the default settings. If you rely on the defaults from your old version, you should review the...
Published Date: May 9, 2024 6:52 PM
Default Setting Changes in 7.2
Default Setting Changes in 7.2 Most new versions of Liferay include changes to the default settings. If you rely on the defaults from your old version, you should review the changes and decide to...
Published Date: May 9, 2024 6:52 PM
Multi-Factor Authentication Checkers
Multi-Factor Authentication Checkers Liferay DXP 7.4 ships with two additional factor checkers for Multi-Factor Authentication. Both of them are disabled by default, because they're only useful in...
Published Date: May 9, 2024 6:52 PM
Fast IDentity Online 2
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
Securing Web Services
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...
Published Date: May 9, 2024 6:52 PM

Capabilities

Product

Education

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy