Search Results

All Results 6987
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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...
Database Upgrade Tool Reference
Database Upgrade Tool Reference Before Liferay 7.4 U82/GA82, the db_upgrade_client.sh file was called db_upgrade.sh. Here's an overview of Liferay's upgrade tool. Start the upgrade tool using...
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...
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:...
Installing Apps and Other Artifacts to Containers
Official Documentation
Installing Apps and Other Artifacts to Containers Applications and other artifacts (such as DXP activation keys) are installed to DXP Docker containers via the container's /mnt/liferay/deploy...
Upgrading via Docker
Upgrading via Docker Running a Liferay Docker image with auto-upgrade enabled uses the Database Upgrade Tool to upgrade your database transparently on Liferay startup. After the upgrade completes,...
Building Liferay Docker Images
Official Documentation
Building Liferay Docker Images Liferay is open-source and fully customizable. You can create your own Liferay Docker images using Dockerfiles to suit the needs of your installation. For example,...
Docker Packages
Official Documentation
Docker Packages These are the packages Liferay installs in the Ubuntu OS to support a full Liferay DXP environment. This list includes neither the JDK nor the dependencies the packages require. ...
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...
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...
Providing Files to the Container
Official Documentation
Providing Files to the Container The Liferay container uses the files you provide to execute the following use cases: Configure Liferay with .properties Files and .config files Configure Tomcat...
Patching DXP in Docker
Official Documentation
Patching DXP in Docker Liferay patches fix DXP issues and the Patching Tool applies the patches. On Docker Hub, Liferay provides images pre-populated with each new Fix Pack, Security Fix Pack, and...
Adding a Site
Official Documentation
Adding a Site Sites are customizable spaces within Liferay, designed for building personalized digital experiences that engage specific audiences and meet unique organizational goals. Creating a...
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....
Sites
Official Documentation
Sites Sites are customizable spaces for building personalized digital experiences. They are a fundamental component of Liferay DXP. At its core, a site is a collection of pages that contains...
Creating Pages
Official Documentation
Creating Pages Pages form the foundation of your site's content and user experience. With Liferay, you can create dynamic and engaging web experiences using flexible, low-code tools to define...
Upgrading to a New Docker Image
Official Documentation
Upgrading to a New Docker Image As new Liferay versions are released as Docker images, you can upgrade to them. Upgrading Liferay describes the process. Always back up your data and installation...
Adding Pages
Official Documentation
Adding Pages Managing a Liferay site involves adding and customizing pages to deliver content and create a personalized user experience. Learn how to create new pages and child pages from the...
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+...
Creating a Page Template
Official Documentation
Creating a Page Template Liferay DXP/Portal 7.3+ With page templates, you can create pages based on predefined layouts and content. There are several basic page templates available out-of-the-box....
Exporting and Importing Page Templates
Official Documentation
Exporting and Importing Page Templates Sometimes, it's easier to edit templates in a code editor. After you create a page template, you can export it for local editing. Once you've made the...
Creating a Master Page Template
Official Documentation
Creating a Master Page Template Available: Liferay DXP/Portal 7.3+ Although there are default master page templates you can use to define the look and feel of the headers and footers for your...
Using the Full Page Application Page Type
Official Documentation
Using the Full Page Application Page Type Create a new page and select Full Page Application under Other. Enter a name and click Add. Under Layout, select the Full Page Application you want...
Defining Headers and Footers
Official Documentation
Defining Headers and Footers Headers and footers define the structure and appearance of your site. Use master page templates to apply these elements consistently across pages while maintaining...
Using Utility Pages
Official Documentation
Using Utility Pages 7.4 U86+ and GA86+ Utility pages serve specific operational tasks and actions and are usually essential for users to interact with a website or application effectively. Utility...
Managing Master Page Templates
Official Documentation
Managing Master Page Templates Available: Liferay DXP/Portal 7.3+ Master Page Templates control the design of content pages, enabling consistent styling and layouts across your site. You can...
Master Page Templates
Official Documentation
Master Page Templates Available: Liferay DXP/Portal 7.3+ Master page templates define common elements (e.g., headers and footers) for pages using fragments, allowing easier management without...
Page Fragments and Widgets
Official Documentation
Page Fragments and Widgets Liferay provides page fragments and widgets for building site pages and page templates. Fragments cannot be used in widget pages. They are only available in content...
Using Fragments
Official Documentation
Using Fragments Page fragments are extensible and reusable drag-and-drop elements for building content pages and templates (i.e., masters, pages, and display pages). Built with HTML, CSS, and...
Configuring Fragments
Official Documentation
Configuring Fragments You can configure fragments and their sub-elements. Available options can vary, though some are common to all. To view available configuration options, begin editing a page or...
Advanced Settings Reference
Official Documentation
Advanced Settings Reference Available 7.4 U37+/GA37+ All Liferay's default fragments include advanced settings except for the Collection Display fragment. Advanced settings can add custom CSS to a...
Styles Reference
Official Documentation
Styles Reference All fragments have a Styles settings section except for the Collection Display fragment. Use the style settings to configure your fragments' look and feel. Many of these options...
Adding Marketplace Fragments to Pages
Official Documentation
Adding Marketplace Fragments to Pages Liferay DXP 2025.Q3+ Liferay Marketplace offers a range of apps and fragments that integrate seamlessly into the Page Editor. Access, configure, and use these...
Configuring Fragment Visibility
Official Documentation
Configuring Fragment Visibility Liferay DXP/Portal 7.4+ Fragments can be used to assemble content pages with a variety of layouts and information. Starting with Liferay DXP 7.4, you can configure...
Fragment Sub-Elements Reference
Official Documentation
Fragment Sub-Elements Reference In addition to General and Style settings, many fragments include sub-elements with their own configuration options. To access these options, begin editing a page or...
General Settings Reference
Official Documentation
General Settings Reference All fragments have general settings. Some options are standard (e.g., visibility and frame), while others are unique to each fragment. Follow these steps to access a...
Localizing Fragment Configuration Fields
Official Documentation
Localizing Fragment Configuration Fields Liferay DXP/Portal 7.4+ When using Liferay Fragments, you can localize the following Fragment configuration fields to match your target audience's...
Creating Dropdown Menus with Fragments
Official Documentation
Creating Dropdown Menus with Fragments Liferay DXP/Portal 7.4+ Liferay provides the Dropdown fragment to create advanced drop-down menus (A). With it, you can define drop zones for additional page...
Exporting and Importing Fragments
Official Documentation
Exporting and Importing Fragments Export fragments from one environment and import them into another to move content, replicate setups, share fragment collections, or back up custom work. ...
Mapping and Linking Fragment Elements
Official Documentation
Mapping and Linking Fragment Elements You can map and link fragments together as reusable components for your digital experiences (e.g., form submissions and navigation actions). Not all...
Default Fragments Reference
Official Documentation
Default Fragments Reference Liferay provides many out-of-the-box fragments, so you can start building your solution immediately. To view available fragments, begin editing a content page or page...
Propagating Fragment Changes
Official Documentation
Propagating Fragment Changes By default, changes made to a custom fragment's code are not propagated to deployed instances of the fragment. Using fragment propagation, you can propagate changes to...
Using Form Fragments
Official Documentation
Using Form Fragments Liferay DXP 2023.Q3+/Portal GA92+ Liferay includes form fragments for building forms in content pages. To build a form, add a form container to a content page or page template...
Duplicating Fragments
Official Documentation
Duplicating Fragments When building a page or template with fragments, you can duplicate configured fragments to save time. A duplicated fragment includes the original fragment's settings,...
Managing Fragments
Official Documentation
Managing Fragments Liferay DXP provides tools for managing fragments in the Liferay UI. With out-of-the-box tools, you can edit fragment code, export/import fragment sets between sites, and more. ...
Saving Fragment Compositions
Official Documentation
Saving Fragment Compositions Layout and composition are the foundation of your page design. They make pages easier to read and navigate, resulting in a richer and more consistent user experience....
Creating Form Fragments
Official Documentation
Creating Form Fragments Liferay 7.4 U45+/GA45+ The form components fragments are for building your object's forms in a content page. If Liferay's form fragments don't satisfy your use case, create...
Creating Forms Using Form Fragments
Official Documentation
Creating Forms Using Form Fragments Use form fragments to create and manage forms on content pages or page templates. With form fragments, you can map fields to objects, organize layouts, and...
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...
Using Layout Elements
Official Documentation
Using Layout Elements For Liferay 7.4 U22+/GA22+ Layout elements define drop zones for designing page or template layouts. By default, Liferay includes two layout elements: containers and grids....
Configuring Widgets
Official Documentation
Configuring Widgets Widgets available out-of-the-box with Liferay DXP share several configurable features: look and feel, import/export of widget data, inter-widget communication, and more.
Personalizing Forms Using Form Fragments
Official Documentation
Personalizing Forms Using Form Fragments Form fragments auto-generate forms based on custom objects. If Liferay's out-of-the-box form fragments don't satisfy your use case, you can create form...
Using Widgets
Official Documentation
Using Widgets Widgets are full-blown web applications that must be deployed to a Liferay instance. Built on the Portlet specification, widgets provide a way to create customized web experiences for...
Translating Fields in Form Containers
Official Documentation
Translating Fields in Form Containers Liferay DXP 2025.Q1+/Portal GA132+ Localize text inputs in form containers directly in the Page Editor to provide multilingual support for fields listed in...
Communication Between Widgets
Official Documentation
Communication Between Widgets Portlet widgets can communicate with each other using public render parameters and events. Some Liferay portlets provide a configuration UI to help you get the most...
Configuring Templates
Official Documentation
Configuring Templates Once you've configured a widget, Configuration Templates can save those settings in a reusable template. Configuration templates are only available for widgets placed on a...
Exporting/Importing Widget Data
Official Documentation
Exporting/Importing Widget Data Export data from individual widget instances without affecting the rest of the site. Many widgets support exporting and importing their data separately, including: ...
Default Widgets Reference
Official Documentation
Default Widgets Reference Liferay provides a variety of widgets out-of-the-box, so you can start building your solution right away. Widgets can be placed on content pages, widget pages, and page...
Sharing Widgets with Other Sites
Official Documentation
Sharing Widgets with Other Sites The Sharing options for widgets are deprecated as of Liferay DXP 2024.Q4/Portal GA129 and are scheduled for removal in a future release. You can share widgets...
Setting Widget Scopes
Official Documentation
Setting Widget Scopes The Scope configuration is deprecated as of Liferay DXP 2024.Q4/Portal GA129 and is scheduled for removal in a future release. By default, Liferay's page widgets are scoped...