Search Results

Capability
Feature
Deployment Approach
Mapping Repeatable Fields to Fragments
Mapping Repeatable Fields to Fragments Currently, this feature is behind a release feature flag (LPD-11377). Read Release Feature Flags for more information. Liferay DXP 2024.Q3+/Portal GA125+ ...
Published Date: Aug 6, 2024 3:41 PM
Assigning Permissions to Web Content Structures and Templates
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
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
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
Managing Web Content Structures
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
Creating Your First Site
Creating Your First Site Sites are collections of pages that contain and display content. This article walks through creating a new Site based on an existing out-of-the-box template. Creating a...
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
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
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
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
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
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
Headless Delivery
Headless Delivery
Published Date: May 9, 2024 6:51 PM
Creating Web Content Templates
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
Web Content Templates
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
Mapping Web Content Templates to Fragments
Mapping Web Content Templates to Fragments By default, you can map web content structure fields holding a single value (such as date, numeric, image, number, or text) to fragments. For multi-value...
Published Date: May 9, 2024 6:51 PM
Using Taglibs in Web Content Templates
Using Taglibs in Web Content Templates Liferay's taglibs are accessible when developing templates in FreeMarker. There is no need to instantiate these taglibs within your FreeMarker template;...
Published Date: May 9, 2024 6:51 PM
Embedding Widgets in Web Content Templates
Embedding Widgets in Web Content Templates You can embed core or custom widgets, instanceable or not, in web content templates. Below is an example of embedding a web content widget in FreeMarker:
Published Date: May 9, 2024 6:51 PM
Getting Started
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
Changing Your Site's Appearance
Changing Your Site's Appearance Liferay has many ways to customize your site's appearance. Your site's favicon and theme are two of the first elements you may want to change. Themes set a default...
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
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
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
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
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
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
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
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
Installation and Upgrades
Installation and Upgrades
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
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 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 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
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
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
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
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
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 Containers
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...
Published Date: Nov 22, 2024 10:49 PM
Using Liferay Docker Images
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...
Published Date: Nov 22, 2024 10:49 PM
Docker Image Versions
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...
Published Date: Nov 22, 2024 10:49 PM
Running Scripts in Containers
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....
Published Date: Nov 22, 2024 10:49 PM
Upgrading to a New Docker Image
Upgrading to a New Docker Image As new Liferay versions are released as Docker images, you can upgrade to them. Upgrade Basics describes the process. **Always** [back...
Published Date: Nov 22, 2024 10:49 PM

Capabilities

Product

Education

Contact Us

Connect

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