Search Results

All Results 6965
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Importing Packages
Official Documentation
Importing Packages You often find yourself in a position of needing functionality provided by another module. To access this functionality, you must import packages from other modules into your...
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...
Getting Started
Official Documentation
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...
Managing Web Content Structures
Official Documentation
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...
Web Content Templates
Official Documentation
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...
Embedding Widgets in Web Content Templates
Official Documentation
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:
Mapping Web Content Templates to Fragments
Official Documentation
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...
Using Taglibs in Web Content Templates
Official Documentation
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;...
Creating Your First Site
Official Documentation
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...
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...
API Builder
Official Documentation
API Builder Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently...
Building a Sample API Application
Official Documentation
Building a Sample API Application Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) The...
Changing Your Site's Appearance
Official Documentation
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...
Introduction to the Admin Account
Official Documentation
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...
Navigating DXP
Official Documentation
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...
Starting with a Docker Image
Official Documentation
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...
REST Builder
Official Documentation
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 REST and...
Consuming APIs
Official Documentation
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,...
Producing and Implementing APIs with REST Builder
Official Documentation
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...
Batch Engine API Basics - Importing Data
Official Documentation
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...
Consuming GraphQL APIs
Official Documentation
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...
Using External Reference Codes
Official Documentation
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...
Using OAuth 2.0
Official Documentation
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...
API Headers Reference
Official Documentation
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...
API Query Parameters
Official Documentation
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...
Batch Engine API Basics - Exporting Data
Official Documentation
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,...
Consuming REST Services
Official Documentation
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: ...
Data Migration Center
Official Documentation
Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...
Making Unauthenticated Requests
Official Documentation
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...
Sample API Tutorials
Official Documentation
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...
Custom Code and Patch Compatibility
Official Documentation
Custom Code and Patch Compatibility Subscribers If you deploy code that customizes or patches your DXP 7.2 installation, you must maintain its compatibility with all patches you're using. The...
Slimming Down Patched Installations
Official Documentation
Slimming Down Patched Installations Subscribers In Liferay DXP 7.2, patch information is retained in Patch Files in the installation by default. This facilitates restoring DXP to a previous patch...
Applying a Hotfix
Official Documentation
Applying a Hotfix Subscribers A Hotfix is a fix or collection of fixes delivered between Updates (or between Fix Packs for versions before DXP 7.3 SP3) to address a customer's confirmed critical...
Backing Up
Official Documentation
Backing Up Once you have your DXP installation running, you should implement a comprehensive backup plan that accounts for unforeseen events. Backup copies are also valuable for testing updates...
Maintaining Clustered Installations
Official Documentation
Maintaining Clustered Installations Setting up your Liferay DXP installation to function in a cluster provides performance and scalability improvements, but also requires additional consideration...
Blue-Green Deployments
Official Documentation
Blue-Green Deployments Blue-green is a deployment technique in which you duplicate your production environment (the blue environment) and modify the duplicate (the green environment) with software...
Performing Rolling Restarts
Official Documentation
Performing Rolling Restarts The rolling restart cluster maintenance process involves shutting down and updating nodes one at a time (while the other nodes are running) until they're all updated....
Advanced Patching for DXP 7.2
Official Documentation
Advanced Patching for DXP 7.2 Here are the DXP 7.2 advanced patching topics: Using Slim Bundles demonstrates conserving disk space by using DXP fix pack bundles that don't include Patch Files. ...
Using Slim Bundles
Official Documentation
Using Slim Bundles Subscribers Liferay DXP 7.2 Fix Packs and Service Packs are also released bundled with the Tomcat application server. They are available as traditional bundles and Slim Bundles....
Installing Patches in Earlier Versions
Official Documentation
Installing Patches in Earlier Versions Subscribers The Patching Tool applies Fix Packs (including Security Fix Packs and Service Packs) for versions prior to Liferay DXP 7.3 SP3. It also applies...