Search Results

All Results 7006
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Updating the File Store
Updating the File Store File store options and configuration values changed in Liferay DXP 7.0. If you're on 7.0 or earlier and are affected by these changes, you must update your file store before...
Upgrading Clustered and Sharded Environments
Upgrading Clustered and Sharded Environments If you're upgrading a clustered installation, you must follow an upgrade approach that fits your cluster requirements. See Maintaining Clustered...
Upgrading a Sharded Environment
Upgrading a Sharded Environment Since Liferay DXP 7.0, Liferay removed its own physical partitioning implementation (also known as sharding) in favor of the capabilities provided natively by...
Upgrading via Auto Upgrade
Upgrading via Auto Upgrade You can upgrade your database automatically by enabling auto upgrade via the portal property before starting up your instance. Always back up your database and existing...
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,...
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...
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...
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:...
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 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...
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...
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...
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...
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...
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....
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...
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...
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...
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...
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+...
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...
7.2 Breaking Changes
Official Documentation
7.2 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...
Data Cleanup
Data Cleanup Before database upgrades, Liferay executes data cleanup processes to repair databases with obsolete data. This lightens the load of the upgrade tool, improving performance and reducing...
Database Tuning for Upgrades
Database Tuning for Upgrades Performing an upgrade impacts the database differently from daily running in production. Because of this, you should tune your database for the upgrade process before...
Example: Removing Intermediate Journal Article Versions
Example: Removing Intermediate Journal Article Versions These instructions and code samples demonstrate removing intermediate Journal Article versions. In the script console, you can remove...
Troubleshooting Upgrades
Official Documentation
Troubleshooting Upgrades Liferay has many out-of-the-box tools and features to identify and solve issues that may arise when performing an upgrade. To troubleshoot, you can upgrade modules...
7.4 Breaking Changes
Official Documentation
7.4 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay 7.4, starting with the latest quarterly...
Post-Upgrade Considerations
Official Documentation
Post-Upgrade Considerations After upgrading the database, you should configure Liferay for production again and check up on feature changes that might affect your Liferay instance. Re-enable...
Liferay DXP 2024.Q2 Breaking Changes
Official Documentation
Liferay DXP 2024.Q2 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay DXP 2024.Q2. As the...
Liferay DXP 2024.Q3 Breaking Changes
Official Documentation
Liferay DXP 2024.Q3 Breaking Changes Breaking changes break or significantly alter existing functionality or code structure. Here are all of the breaking changes for Liferay DXP 2024.Q3. As the...
2024 Deprecations and Breaking Changes
2024 Deprecations and Breaking Changes Liferay quarterly releases introduce new features and enhancements while phasing out older or less-used functionality. Some features move to Maintenance Mode,...
Maintenance Mode and Deprecations in Liferay DXP 2024.Q3
Maintenance Mode and Deprecations in Liferay DXP 2024.Q3 Features moved to Maintenance Mode or marked as Deprecated in Liferay DXP 2024.Q3 appear here. For details about these statuses and their...
Maintenance Mode and Deprecations in 7.3
Maintenance Mode and Deprecations in 7.3 With each new DXP release, a feature may not warrant continued enhancements or may become obsolete. Stopping enhancements for a feature puts it in...
Maintenance Mode and Deprecations in 7.2
Maintenance Mode and Deprecations in 7.2 With each new DXP release, a feature may not warrant continued enhancements or may become obsolete. Stopping enhancements for a feature puts it in...
Renamed Language Keys
Renamed Language Keys In Liferay DXP/Portal 7.4, module language keys were centralized to a module called portal-language-lang. Source location: ...
Common Upgrade Issues
Common Upgrade Issues Skipping an upgrade step or creating custom references to the Liferay database, can cause upgrade issues. The following questions and answers address some common situations. ...
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...
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...
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...
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...
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...
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...
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...
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...
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...
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...
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...
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,...
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. ...
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. ...
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...
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...
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 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...
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 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...
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...