Search Results

All Results 6975
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Frontend Data Set Cell Renderer YAML Reference
Official Documentation
Frontend Data Set Cell Renderer YAML Reference You can define a Frontend Data Set cell renderer client extension with a client-extension.yaml file. Usage Details The client-extension.yaml file...
Maintenance and Troubleshooting in Docker
Official Documentation
Maintenance and Troubleshooting in Docker The Liferay Docker container has tools for maintenance and troubleshooting out-of-the-box. You can set various environment variables to modify settings...
Using Custom SQL Queries
Using Custom SQL Queries Service Builder creates finder methods that retrieve entities by their attributes (their column values). When you add a column as a parameter for the finder in your...
Search Suggestions API
Official Documentation
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are two primary...
Search API Basics
Official Documentation
Search API Basics Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search for content from a Liferay search page, but you can also use the /search API endpoints. If you're...
Bundling Resources in a JavaScript Import Map Entry Client Extension
Official Documentation
Bundling Resources in a JavaScript Import Map Entry Client Extension Liferay DXP 2023.Q1+/Portal GA92+ JavaScript import map entry client extensions make JavaScript code or resources available to...
JavaScript Import Map Entry YAML Configuration Reference
Official Documentation
JavaScript Import Map Entry YAML Configuration Reference Usage Details This client-extension.yaml file defines a JavaScript import map entry client extension: assemble: - from: build/static ...
Defining Document Types for Liferay 7.3 and Earlier Versions
Official Documentation
Defining Document Types for Liferay 7.3 and Earlier Versions In Liferay, Document Types are templates used for uploading files and categorizing them in Documents and Media. These templates are...
Defining Metadata Sets For Liferay 7.3 and Earlier Versions
Official Documentation
Defining Metadata Sets For Liferay 7.3 and Earlier Versions With Documents and Media, you can define reusable groups of metadata fields that can be added to custom Document Types. Once created,...
Connecting Liferay DXP 7.3 to Analytics Cloud
Official Documentation
Connecting Liferay DXP 7.3 to Analytics Cloud Liferay DXP 7.3 U30+ The steps to connect Liferay DXP 7.3 to Analytics Cloud differ slightly from the steps to connect Liferay DXP 7.4. Liferay DXP...
Day 1 Exercises for Building Enterprise Websites with Liferay
Introduction page for day 1 Day 1 Exercises for Building Enterprise Websites with Liferay Exercise 1: Exploring Clarity's Public Enterprise Website Exercise 2: Verifying and Launching Liferay...
Training Material
Training Material These materials supplement some recorded and in-person trainings by providing you with opportunities to practice key skills, test your understanding, and gain confidence in...
Building Enterprise Websites with Liferay Exercises
Building Enterprise Websites with Liferay Exercises These exercises supplement the Building Enterprise Websites with Liferay video training and provide an opportunity to solidify your learning....
Day 2 Exercises for Building Enterprise Websites with Liferay
Introduction page for day 2 Day 2 Exercises for Building Enterprise Websites with Liferay Exercise 11: Generating Content with ChatGPT Bonus Exercise: Auto-Tagging Content Exercise 12a:...
Day 3 Exercises for Building Enterprise Websites with Liferay
Introduction page for day 3 Day 3 Exercises for Building Enterprise Websites with Liferay Exercise 19a: Creating an Object Definition Exercise 19b: Building the Form Exercise 19c: Creating a...
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...
Notifications API Basics
Official Documentation
Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...
Service Accounts
Official Documentation
Service Accounts A service account is a common abstraction in systems used to make authenticated API requests on behalf of the system. Every virtual instance in Liferay comes with one service...
Using a Site Initializer Client Extension
Official Documentation
Using a Site Initializer Client Extension Liferay DXP 2023.Q4+/Portal GA100+ Site Initializer client extensions can quickly create or update a site, complete with configurations and content. Start...
Site Initializer YAML Configuration Reference
Official Documentation
Site Initializer YAML Configuration Reference Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Use a client-extension.yaml file to define a Site Initializer client extension. Usage...
Site Initializers
Official Documentation
Site Initializers Liferay DXP 2023.Q4+/Portal GA100+ Site Initializers package pages, content, and configurations to help you jump-start a new site with much of the site already built. You can...
Limiting File Size
Official Documentation
Limiting File Size You can configure file size limits in Documents and Media. Set a maximum file upload size or for more granularity, define file size limits based on MIME Types. This can take...
Adding a Page to a Site
Official Documentation
Adding a Page to a Site Adding and customizing pages is a key part of managing your Liferay site. You can add pages using the Pages application or through the Page Tree menu. For Liferay 7.4 U22+...
Collections and Collection Pages for Liferay 7.2 and Earlier Versions
Official Documentation
Collections and Collection Pages for Liferay 7.2 and Earlier Versions In versions before Liferay DXP 7.3+, collections were called content sets. A content set is exactly what it sounds like: a...
Creating Collections for Liferay 7.2 and Earlier Versions
Official Documentation
Creating Collections for Liferay 7.2 and Earlier Versions In versions before Liferay DXP 7.3+, collections were called content sets. You can create Content Sets through the Content Sets interface...
Displaying Collections for Liferay 7.2 and Earlier Versions
Official Documentation
Displaying Collections for Liferay 7.2 and Earlier Versions In versions before Liferay DXP 7.3+, collections were called content sets. Content sets are primarily displayed through the Asset...
For Liferay 7.3.x and Earlier
Official Documentation
For Liferay 7.3.x and Earlier The Documents and Media application comes with a built-in image editor. Edit images right from your browser and apply filters, adjust contrast, or crop. In the...
Using Servlet Filters
Using Servlet Filters Servlet filters can both pre-process requests as they arrive and post-process responses before they go to the client browser. You can apply functionality to requests and...
Managing Content in Content Pages For Liferay 7.3 and Earlier Versions
Official Documentation
Managing Content in Content Pages For Liferay 7.3 and Earlier Versions For Liferay DXP/Portal 7.3, you can review web content deployed using fragments and widgets in the Contents panel (Contents). ...
Using Fragments to Build Multi-Step Forms
Official Documentation
Using Fragments to Build Multi-Step Forms Liferay DXP 2024.Q4+/Portal GA129+ You can use fragments to create a single-step form or create a multi-step form with the Stepper fragment or by changing...
Handling Friendly URL Conflicts in Site Templates
Official Documentation
Handling Friendly URL Conflicts in Site Templates Currently, this feature is behind a beta feature flag (LPS-174417). Read Beta Feature Flags for more information. Liferay doesn't allow...
Product Delivery API Basics
Official Documentation
Product Delivery API Basics Product API Basics covers the admin API used for creating and managing products. To display product data in your storefront, you must use the Product Delivery API. Call...
Configuring JSON Web Services
Official Documentation
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...
Web Content API Basics Using GraphQL
Official Documentation
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
Channel API Basics
Official Documentation
Channel API Basics You can manage channels from the Applications menu or with REST APIs. Call the headless-commerce-admin-channel services to create and manage channels. Adding a Channel Once...
Knowledge Base API Basics
Official Documentation
Knowledge Base API Basics You can Create Knowledge Base Articles and Manage the Knowledge Base with Liferay's Knowledge Base app, but you can also use Liferay's REST APIs. Call these services to...
Using OAuth2 to Authorize Users
Official Documentation
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...
Configuring a Database
Official Documentation
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,...
Authorizing Account Access with OAuth2
Official Documentation
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)....
Creating an OAuth2 Application
Official Documentation
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...
OAuth 2 Scopes
Official Documentation
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: ...
DXP
Official Documentation
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,...
Self-Hosted Installation and Upgrades
Official Documentation
Self-Hosted Installation and Upgrades Liferay's flexibility makes it possible to host it in any way you choose: on any Kubernetes-based cloud platform via Helm charts and Terraform scripts, on...
Installing Liferay On A Local Server
Official Documentation
Installing Liferay On A Local Server Liferay runs on an application server. There are three ways to host Liferay on a local machine: Using a Docker container Using a Liferay Tomcat bundle On a...
Installing a Liferay-Tomcat Bundle
Official Documentation
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...
Installing Earlier Liferay Versions on WebSphere
Official Documentation
Installing Earlier Liferay Versions 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 on JBoss EAP
Official Documentation
Installing on JBoss EAP Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on JBoss EAP. Installing on JBoss EAP requires installing the DXP...
Installing on Tomcat
Official Documentation
Installing on Tomcat Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on Tomcat. Using a Liferay-Tomcat bundle or Docker image is the...
Installing on WildFly
Official Documentation
Installing on WildFly Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on WildFly. Installing on WildFly requires installing the DXP WAR,...
Running Liferay for the First Time
Official Documentation
Running Liferay for the First Time Once you've installed Liferay DXP/Portal and configured a database for it, it is ready to run. Start the Server Run the startup script bundled with your...
Container Lifecycle and API
Official Documentation
Container Lifecycle and API At a high level, the container starts Tomcat with Liferay deployed on it. Additionally, however, the container entry point provides an API for executing these use cases:...
Docker Image Versions
Official Documentation
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...
Setting Up JNDI on Tomcat
Official Documentation
Setting Up JNDI on Tomcat Liferay 7.4+ To set up JNDI resources, you must put the necessary JDBC drivers in the Tomcat lib folder (i.e. tomcat-9.0.56/lib). For example, if you use an Oracle...
Using Liferay Docker Images
Official Documentation
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...
Configuring Containers
Official Documentation
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...
Licensing DXP in Docker
Official Documentation
Licensing DXP in Docker If you're using a DXP trial license that's expiring or you have a new license (activation key) you must install, you can replace your container's existing license. Here's...
Running Scripts in Containers
Official Documentation
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....
Maintaining a Liferay Installation
Official Documentation
Maintaining a Liferay Installation Starting with Liferay DXP 7.3 SP3+ and 7.4 GA1+, Liferay adopted a new release model for delivering updates and fixes. This new approach is referred to as Bundle...
Using Domain-Specific Language Queries
Using Domain-Specific Language Queries Liferay 7.4+ DSL Query is an acronym for Domain-Specific Language Query. The foundation is based upon using a domain-specific language for the...
React Component Utilities Reference
Official Documentation
React Component Utilities Reference Several useful tools are available to help you build high-performance components and applications in Liferay DXP using React: frontend-js-react-web module ...