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
Using Custom Fields in Page Fragments
Official Documentation
Using Custom Fields in Page Fragments If you've added custom fields to Liferay's users or pages, you can access them in fragments. To get the value of a page custom field, use ...
Published Date: May 9, 2024 6:57 PM
Setting the Order of Elements in a Fragment
Official Documentation
Setting the Order of Elements in a Fragment Liferay 7.4+ The Slider or Tab fragments are typically used to show different areas of information. Sliders present this information in a carousel of...
Published Date: May 9, 2024 6:57 PM
Using the Fragments Editor
Official Documentation
Using the Fragments Editor Liferay DXP includes a built-in editor for developing content page fragments. To access the editor, open the Site Menu ( Site Menu ) and navigate to Design → Fragments....
Published Date: May 9, 2024 6:57 PM
Validating Fragment Configurations
Official Documentation
Validating Fragment Configurations When defining fragment configuration options, you can add validation properties to text type fields that determine rules for valid entries. Determine what type of...
Published Date: May 9, 2024 6:57 PM
Importing/Exporting Data
Official Documentation
Importing/Exporting Data Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 If you want to import or export data from Liferay, you use batch client extensions. Use and reuse your data...
Published Date: May 9, 2024 6:54 PM
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...
Published Date: Oct 16, 2024 4:13 PM
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...
Published Date: Oct 16, 2024 4:33 PM
Batch YAML Configuration Reference
Official Documentation
Batch YAML Configuration Reference Use a client-extension.yaml file to define a batch client extension. Usage Details This client-extension.yaml file defines a client extension of type batch: ...
Published Date: May 9, 2024 6:54 PM
Creating a Basic Custom Element
Official Documentation
Creating a Basic Custom Element Liferay 7.4+ Custom element client extensions use Liferay's frontend infrastructure to register external, remote applications with the Liferay platform and render...
Published Date: May 9, 2024 6:54 PM
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...
Published Date: Oct 16, 2024 4:13 PM
Custom Element YAML Configuration Reference
Official Documentation
Custom Element YAML Configuration Reference You can define a custom element client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a custom...
Published Date: May 9, 2024 6:54 PM
Integrating External Applications
Official Documentation
Integrating External Applications Custom Element and IFrame client extensions register applications with Liferay and render them as widgets on site pages. When you create one of these frontend...
Published Date: May 9, 2024 6:54 PM
Using an IFrame Client Extension
Official Documentation
Using an IFrame Client Extension Liferay 7.4+ IFrame client extensions use Liferay's frontend infrastructure to register external applications as HTML elements. They're added to Liferay pages as...
Published Date: May 9, 2024 6:54 PM
Using Routes with Custom Elements
Official Documentation
Using Routes with Custom Elements Liferay 7.4+ Custom element client extensions use Liferay's frontend infrastructure to register external applications with the Liferay platform and render them as...
Published Date: May 9, 2024 6:54 PM
IFrame YAML Configuration Reference
Official Documentation
IFrame YAML Configuration Reference You can define an IFrame client extension with a client-extension.yaml file. Data Usage This client-extension.yaml file defines an IFrame client extension: ...
Published Date: May 9, 2024 6:54 PM
Integrating Microservices
Official Documentation
Integrating Microservices Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 You can define microservice client extensions to run your own code in response to events in your Liferay...
Published Date: May 9, 2024 6:54 PM
Using a Microservice Client Extension
Official Documentation
Using a Microservice Client Extension A microservice client extension is a standalone server process that relies on OAuth 2 for communication with Liferay. The microservice is a resource server and...
Published Date: May 9, 2024 6:54 PM
Object Action YAML Configuration Reference
Official Documentation
Object Action YAML Configuration Reference You can define an object action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml defines an object action and...
Published Date: May 9, 2024 6:54 PM
Object Validation Rule YAML Configuration Reference
Official Documentation
Object Validation Rule YAML Configuration Reference To define an Object Validation Rule client extension, add the objectValidationRule type to your client-extension.yaml file. Usage Details This...
Published Date: May 9, 2024 6:54 PM
Notification Type YAML Configuration Reference
Official Documentation
Notification Type YAML Configuration Reference You can define a notification type client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a...
Published Date: May 9, 2024 6:54 PM
Workflow Action YAML Configuration Reference
Official Documentation
Workflow Action YAML Configuration Reference You can define a workflow action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a workflow...
Published Date: May 9, 2024 6:54 PM
Liferay Labs
Official Documentation
Liferay Labs Liferay Labs is an innovation hub within Liferay Marketplace dedicated to exploring newer technologies and developing experimental features. It provides a wide range of useful...
Published Date: Jan 7, 2025 4:36 PM
Marketplace
Official Documentation
Marketplace Liferay Marketplace is a platform where you can find, download, and share apps. It features an updated UI and supports Liferay SaaS. To access Marketplace, visit...
Published Date: Aug 16, 2024 3:45 PM
Become a Publisher
Official Documentation
Become a Publisher To publish apps or solutions on Marketplace, you need a Liferay account with publisher permissions. Becoming a publisher is free, but you must submit a request with relevant...
Published Date: Aug 16, 2024 3:45 PM
Connecting Liferay DXP to Marketplace
Official Documentation
Connecting Liferay DXP to Marketplace Liferay DXP 2025.Q1+/GA132+ You can connect Liferay DXP to Marketplace in Instance Settings. With this integration, you can add supported apps from the...
Published Date: Apr 15, 2025 4:54 PM
Tooling
Official Documentation
Tooling Liferay provides a variety of developer tools that include standard build scripting, lightweight CLI utilities, and full IDE based on Eclipse. This is to serve all developers, whether...
Published Date: May 9, 2024 6:55 PM
Publishing Apps in Marketplace
Official Documentation
Publishing Apps in Marketplace The Liferay Marketplace contains Cloud apps (for Liferay SaaS, PaaS, and self-hosted) and DXP apps (for Liferay PaaS and Liferay Self-Hosted). As a publisher, you may...
Published Date: Aug 16, 2024 3:45 PM
Publishing Solutions in Marketplace
Official Documentation
Publishing Solutions in Marketplace The Liferay Marketplace contains business solutions to improve productivity and reduce time to market. Currently, only existing Liferay partners can publish a...
Published Date: Aug 31, 2024 7:45 PM
Provisioning DXP Apps
Official Documentation
Provisioning DXP Apps Free apps can be downloaded, deployed to Liferay DXP, and used immediately without deploying a license. Paid apps have trial, developer, or standard licenses based on the...
Published Date: Nov 8, 2024 3:11 PM
Provisioning Cloud Apps
Official Documentation
Provisioning Cloud Apps You can provision cloud apps to your Liferay instance and start using them immediately. Unlike DXP apps, cloud apps integrate with Liferay SaaS directly and don't require...
Published Date: Feb 11, 2025 12:35 PM
Blade CLI
Official Documentation
Blade CLI Blade CLI can be installed through a command line interface or a graphical installer. If you're behind a proxy, once it's installed you can configure it to operate through the proxy....
Published Date: May 9, 2024 6:55 PM
Generating Projects with Blade CLI
Official Documentation
Generating Projects with Blade CLI Blade CLI exists to create, build, and deploy Liferay projects in Liferay Workspaces. Once created, these projects can be imported into an IDE or worked on...
Published Date: May 9, 2024 6:55 PM
Troubleshooting Blade CLI
Official Documentation
Troubleshooting Blade CLI If Blade CLI isn't working as expected, you may find answers here. The blade command is not available in my CLI The Blade CLI installer adds the blade command to your...
Published Date: May 9, 2024 6:55 PM
Liferay Workspace
Official Documentation
Liferay Workspace Liferay Workspace is a set of folders and Gradle scripts that represents the Liferay-opinionated way of handling a full development life cycle: Creating projects Building...
Published Date: May 9, 2024 6:55 PM
Configuring Liferay Workspace
Official Documentation
Configuring Liferay Workspace Liferay Workspace is simple to use, and you can learn the basics by starting at the beginning. If you're happily creating projects, deploying code, or using a Docker...
Published Date: May 9, 2024 6:55 PM
Configuring a Liferay Docker Container
Official Documentation
Configuring a Liferay Docker Container Creating and deploying containers is an important part of the modern developer workflow. Liferay Workspace makes it easy to use Docker containers both for...
Published Date: May 9, 2024 6:55 PM
Creating A Liferay Workspace
Official Documentation
Creating A Liferay Workspace You can create a Liferay Workspace manually or with Blade CLI. Creating a Liferay Workspace Manually To create a Liferay Workspace manually, you must have Gradle...
Published Date: May 9, 2024 6:55 PM
Creating Code with Liferay Workspace
Official Documentation
Creating Code with Liferay Workspace Liferay Workspace is the developer's tool for creating and managing Liferay development projects. Creating Projects Blade CLI makes it easy to create projects...
Published Date: May 9, 2024 6:55 PM
Creating Deployment Environments
Official Documentation
Creating Deployment Environments There comes a point when your code is ready to share. For that, you must build an environment. In the corporate world, there are usually three environments: ...
Published Date: May 9, 2024 6:55 PM
Liferay CLI Tool
Official Documentation
Liferay CLI Tool The Liferay CLI tool is deprecated as of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The Liferay CLI tool makes it easy to create Angular, JavaScript,...
Published Date: May 9, 2024 6:55 PM
Other Tools (Deprecated)
Official Documentation
Other Tools (Deprecated) These tools are deprecated as of Liferay 2024.Q4/Portal GA129, and they are planned for future removal. Modern browsers (and Liferay DXP) all support including JavaScript...
Published Date: May 9, 2024 6:55 PM
Liferay npm Bundler (Deprecated)
Official Documentation
Liferay npm Bundler (Deprecated) The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal.
Published Date: May 9, 2024 6:55 PM
Bundler Migration Guide
Official Documentation
Bundler Migration Guide The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal.
Published Date: May 9, 2024 6:55 PM
Migrating an Angular Project to Use Liferay npm Bundler 2.x
Official Documentation
Migrating an Angular Project to Use Liferay npm Bundler 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Follow these steps to...
Published Date: May 9, 2024 6:55 PM
Migrating a liferay-npm-bundler Project from 1.x to 2.x
Official Documentation
Migrating a liferay-npm-bundler Project from 1.x to 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. liferay-npm-bundler 2.x offers...
Published Date: May 9, 2024 6:55 PM
Migrating a Plain JavaScript, Billboard JS, JQuery, Metal JS, React, or Vue JS Project to Use Liferay npm Bundler 2.x
Official Documentation
Migrating a Plain JavaScript, Billboard JS, JQuery, Metal JS, React, or Vue JS Project to Use Liferay npm Bundler 2.x The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and...
Published Date: May 9, 2024 6:55 PM
Migrating Your Project to Use liferay-npm-bundler's New Mode
Official Documentation
Migrating Your Project to Use liferay-npm-bundler's New Mode The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. Since issue #303, two...
Published Date: May 9, 2024 6:55 PM
Using an OSGi Service
Official Documentation
Using an OSGi Service Liferay APIs are readily available as OSGi services. You can access a service by creating a field of that service type and annotating the field with @Reference, like this: ...
Published Date: Nov 22, 2024 10:50 PM
Enabling Document Creation and Editing with Microsoft Office 365
Official Documentation
Enabling Document Creation and Editing with Microsoft Office 365 Before you can use Office 365™ to create and edit Documents and Media files, you must configure DXP to connect with an application...
Published Date: May 9, 2024 6:50 PM
Enabling FFmpeg for Audio and Video Previews
Official Documentation
Enabling FFmpeg for Audio and Video Previews Documents and Media provides integration with the FFmpeg multimedia framework for generating audio and video file previews. To use this integration, you...
Published Date: May 9, 2024 6:50 PM
Configuring Caching for Documents and Media
Official Documentation
Configuring Caching for Documents and Media Liferay 7.3 U23+, Liferay 7.4 U21+, GA21+ By default, Documents and Media files are not cached by browsers or servers. This is because file visibility...
Published Date: May 9, 2024 6:50 PM
Configuring Documents and Media Previews
Official Documentation
Configuring Documents and Media Previews Liferay 7.4 U84+/GA84+ By default, Liferay uses PDFBox to generate previews for files added to the document library. This is because PDFBox is the only...
Published Date: May 9, 2024 6:50 PM
Enabling LibreOffice / OpenOffice Integration
Official Documentation
Enabling LibreOffice / OpenOffice Integration LibreOffice and OpenOffice are open source productivity suites that you can integrate with Liferay. By default Liferay includes PDFBox, which generates...
Published Date: May 9, 2024 6:50 PM
Google Drive Integration
Official Documentation
Google Drive Integration Integrate Google Drive with Liferay DXP to create, edit, and manage Google Docs, Sheets, and Slides directly from Documents and Media. This integration provides two main...
Published Date: May 9, 2024 6:50 PM
Gogo Shell Commands
Official Documentation
Gogo Shell Commands The Gogo shell executes Felix Gogo basic commands and Liferay commands. The Gogo shell is accessible in the Control Panel (recommended) and from the command line. Here are some...
Published Date: Nov 22, 2024 10:50 PM
Digital Asset Management
Official Documentation
Digital Asset Management Use Liferay’s Digital Asset Management (DAM) features to store, organize, and reuse documents, images, and other media across your site. The Documents and Media library...
Published Date: Jun 27, 2025 6:49 PM
Developer Guide
Official Documentation
Developer Guide This guide provides comprehensive information and references to help you effectively use the Document API, understand adaptive media modules, and create video shortcut providers.
Published Date: May 9, 2024 6:50 PM
Adaptive Media Modules Reference
Official Documentation
Adaptive Media Modules Reference Adaptive Media's Modules Some modules in the Adaptive Media app are mandatory and must be enabled for Adaptive Media to function, while others can be disabled. The...
Published Date: May 9, 2024 6:50 PM
Creating Video Shortcut Providers
Official Documentation
Creating Video Shortcut Providers Liferay DXP 7.4+ By default, Liferay's external video shortcuts support YouTube, Vimeo, Facebook, and Twitch. However, you can extend this feature to support...
Published Date: May 9, 2024 6:50 PM
Module Projects
Official Documentation
Module Projects Liferay applications and customizations are OSGi modules: .jar files containing Java code and some extra configuration for publishing and consuming APIs. A module project comprises...
Published Date: Nov 22, 2024 10:50 PM