Search Results

All Results 6965
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Widgets Reference
Official Documentation
Widgets Reference Widgets are building blocks you can use to add content and dynamic functionality to your site. While Liferay includes a wide variety of generic widgets, it also includes dedicated...
Liferay Commerce Configuration Overview
Official Documentation
Liferay Commerce Configuration Overview You can find options to configure Commerce from the Global Menu. Access Commerce via the Global Application menu. Open the Global Menu (Global Menu) and go...
Configuring the Commerce Notification Queue
Official Documentation
Configuring the Commerce Notification Queue When channel events trigger notifications, Commerce logs them in the channel's Notification Queue tab with the Unsent status. By default, Liferay checks...
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...
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 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,...
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. ...
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...
Job Scheduler Dispatch Framework Reference
Official Documentation
Job Scheduler Dispatch Framework Reference Liferay Self-Hosted Liferay PaaS Liferay Job Scheduler is a flexible framework built on top of Liferay's Scheduler Engine. You can use it to add,...
Micro Frontends
Official Documentation
Micro Frontends Micro frontends extend the concept of microservices to the frontend side of development. You can build a fully-featured and powerful browser application that uses a microservice...
Bundle Classloading Flow
Bundle Classloading Flow The OSGi container searches several places for imported classes. It's important to know where it looks and in what order. Liferay DXP's classloading flow for OSGi bundles...
Building Liferay Source
Building Liferay Source This section aims to provide instructions for building Liferay Portal from source as quickly as possible. Using a nightly snapshot bundle no longer requires a full build...
APIs as OSGi Services
Official Documentation
APIs as OSGi Services After you've learned what a module is and how to deploy one, you can use modules to define APIs and implement them. Liferay APIs are OSGi services, defined by Java interfaces...
Configuring Dependencies
Official Documentation
Configuring Dependencies Liferay provides a container where modules can publish and consume functionality through their Java packages. Modules can leverage packages from other modules or...
Organizing the Source
Organizing the Source It is important to have a solid understanding of how the Liferay source is organized when working on fixing a bug or adding a new feature to the product. The Liferay Source...
Configuration Form Renderer
Official Documentation
Configuration Form Renderer When you create a configuration interface, a configuration UI is automatically generated. But in some cases you want customize the look and feel of the UI. For example,...
Field Options Provider
Official Documentation
Field Options Provider You can populate a drop-down list manually in the @Meta.AD annotation of the configuration interface. But you can also populate the option labels and values automatically...
Module Life Cycle
Module Life Cycle In OSGi, all components, Java classes, resources, and descriptors are deployed via modules (OSGi bundles). The MANIFEST.MF file describes the module's physical characteristics,...
OSGi and Modularity
OSGi and Modularity Modularity makes writing software, especially as a team, fun! Here are some benefits to modular development on Liferay: Liferay's runtime framework is lightweight, fast, and...
Job Scheduler UI Reference
Official Documentation
Job Scheduler UI Reference Liferay Self-Hosted Liferay PaaS Job Scheduler Triggers View, create, and manage Job Scheduler Tasks. The Job Scheduler Triggers tab lists all tasks added to the...
Data Set Sorting
Official Documentation
Data Set Sorting Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can set default sorting rules for Data Sets...
Finding Artifacts
Official Documentation
Finding Artifacts To use external artifacts in your project, you must configure their dependencies in your build.gradle Gradle script. Before specifying an artifact as a dependency, you must first...
Contributing to Liferay Development
Official Documentation
Contributing to Liferay Development The first thing to do in learning to fix bugs or contributing a feature is to become familiar with how to build the system. The Liferay Portal build system now...
Issuing JWT Access Tokens
Official Documentation
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...
JSON Web Token Assertions
Official Documentation
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...
Liferay DXP 2025.Q1 Breaking Changes
Official Documentation
Liferay DXP 2025.Q1 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay DXP 2025.Q1. As the...
Document Types and Metadata Sets API Basics
Official Documentation
Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...
Multishipping
Official Documentation
Multishipping Liferay DXP 2025.Q1+/Portal GA132+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) With multishipping, your...
Language Client Extensions
Official Documentation
Language Client Extensions Liferay DXP 2025.Q1+/Portal GA132+ A language client extension adds new language keys or overrides existing keys and their translations. For example, you can translate...
Accounts API Basics
Official Documentation
Accounts API Basics Liferay DXP/Portal 7.4+ You can manage accounts from the Applications menu or use Liferay's REST APIs. Call these services to create and manage accounts. Adding an Account ...