DXP Self-Hosted Installation, Maintenance, and Administration

3.0 Breaking Changes

3.0 Breaking Changes This is a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay Commerce developers or Users in Commerce 3.0. We try our...

Published Date: May 9, 24, 6:45 PM

Installation and Upgrades

Installation and Upgrades Liferay DXP 7.3 and Below Liferay Commerce is a digital commerce platform built on Liferay DXP. See the prerequisites and available options for installing, deploying, and...

Published Date: May 9, 24, 6:45 PM

3.0 Release Notes

3.0 Release Notes Release Highlights Compatibility with Liferay DXP 7.3 Liferay Commerce 3.0 is compatible with the latest version of Liferay DXP. Leverage the new experience management, content...

Published Date: May 9, 24, 6:45 PM

4.0 Breaking Changes

4.0 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay Commerce developers or users in Commerce...

Published Date: May 9, 24, 6:45 PM

Activating Liferay Commerce Enterprise

Activating Liferay Commerce Enterprise Starting with Liferay DXP/Portal 7.3, Commerce ships with all Liferay bundles and Docker containers and doesn't require a separate installation. However, the...

Published Date: May 9, 24, 6:45 PM

Installing Commerce 2.1 and Below

Installing Commerce 2.1 and Below Previous releases of Liferay Commerce required additional installation steps that are no longer necessary on Commerce 3.x and above. Prerequisites Before...

Published Date: May 9, 24, 6:45 PM

Deploying Liferay Commerce to an Existing Liferay Installation

Deploying Liferay Commerce to an Existing Liferay Installation This article documents how to deploy Liferay Commerce to an existing Liferay DXP instance. Because Liferay Commerce is built on...

Published Date: May 9, 24, 6:45 PM

Using the Liferay Commerce Docker Image

Using the Liferay Commerce Docker Image The latest version Liferay Commerce is available as a docker image. Follow these steps to download the latest Docker image release of Liferay Commerce and...

Published Date: May 9, 24, 6:45 PM

Using the Liferay Commerce Tomcat Bundle

Using the Liferay Commerce Tomcat Bundle The Liferay Commerce bundle is available for download from the Liferay Commerce Community Downloads page. The bundle contains the latest version of Liferay...

Published Date: May 9, 24, 6:45 PM

Maintenance Versions

Maintenance Versions Fix Packs are released on a periodic basis and include bug and security fixes. If you are installing a fix pack to an installation that has custom code deployed, we recommend...

Published Date: May 9, 24, 6:45 PM

Upgrading Liferay Commerce

Upgrading Liferay Commerce To enhance the quality of your experience with Liferay Commerce, Liferay provides periodic product upgrades with bug fixes and new features. Users should consider...

Published Date: May 9, 24, 6:45 PM

Installing Liferay on an Application Server

Installing Liferay on an Application Server You can install Liferay DXP or Liferay Portal on any supported application server. This is typically the most practical installation type to use in...

Published Date: May 9, 24, 6:51 PM

Maintenance and Troubleshooting in Docker

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...

Published Date: Aug 16, 24, 3:43 PM

Applying a Hotfix

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...

Published Date: May 9, 24, 6:51 PM

Backing Up

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...

Published Date: May 9, 24, 6:51 PM

Maintaining Clustered Installations

Maintaining Clustered Installations Setting up your Liferay DXP installation to function in a cluster provides performance and scalability improvements, but also requires additional consideration...

Published Date: May 9, 24, 6:51 PM

Blue-Green Deployments

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...

Published Date: May 9, 24, 6:51 PM

Performing Rolling Restarts

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....

Published Date: May 9, 24, 6:51 PM

Advanced Patching for DXP 7.2

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. ...

Published Date: May 9, 24, 6:51 PM

Custom Code and Patch Compatibility

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...

Published Date: May 9, 24, 6:51 PM

Slimming Down Patched Installations

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...

Published Date: May 9, 24, 6:51 PM

Using Slim Bundles

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....

Published Date: May 9, 24, 6:51 PM

Installing Patches

Installing Patches 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 Hotfixes for any DXP...

Published Date: May 9, 24, 6:51 PM

Understanding Patch Types

Understanding Patch Types Subscribers The Liferay Support Team creates and releases fixes to issues discovered in DXP. The fixes are packaged in ZIP files referred to generally as patches. There...

Published Date: May 9, 24, 6:51 PM

Reference

Reference Installing the Patching Tool Configuring the Patching Tool Getting Patch Information Uninstalling Patches Accessing DXP Patche Code

Published Date: May 9, 24, 6:51 PM

Accessing DXP Patch Code

Accessing DXP Patch Code Subscribers Liferay DXP Fix Pack and Hotfix source code is available in a private GitHub repository called liferay-dxp. The source code facilitates identifying and...

Published Date: May 9, 24, 6:51 PM

Configuring the Patching Tool

Configuring the Patching Tool Subscribers The Patching Tool can be adapted to any DXP installation. The tool's auto-discovery option is the easiest way to configure the Patching Tool. If you...

Published Date: May 9, 24, 6:51 PM

Installing the Patching Tool

Installing the Patching Tool Subscribers The Patching Tool is easy to install and update. Installation Download the Patching Tool from the Customer Portal. For DXP 7.3+, download the latest...

Published Date: May 9, 24, 6:51 PM

Getting Patch Information

Getting Patch Information Subscribers You can see patch information at a glance, which helps maintain your installation and get help from Liferay Support. The Patching Tool's info command lists...

Published Date: May 9, 24, 6:51 PM

Uninstalling Patches

Uninstalling Patches Subscribers After you install a patch, you may decide to restore your installation to a previous patch level. Here you'll learn how to Uninstall Patches Revert (uninstall)...

Published Date: May 9, 24, 6:51 PM

Updating Previous Versions of Liferay

Updating Previous Versions of Liferay Staying current with updates gives you the best security and quality. Security Updates are releases that address the latest security issues immediately. ...

Published Date: May 9, 24, 6:51 PM

JVM Configuration

JVM Configuration As of Liferay DXP 2024.Q3+/Portal 7.4 GA125+, Liferay DXP/Portal requires a Java JDK 17 or 21 (prior versions support JDKs 8 and 11) with specific JVM option settings. There are...

Published Date: May 9, 24, 6:51 PM

Activating Liferay DXP

Activating Liferay DXP Subscription Required Liferay DXP is activated using an XML (.xml) activation key. It specifies your DXP subscription terms or trial agreement. When you run Liferay DXP for...

Published Date: May 9, 24, 6:52 PM

Installing on WebSphere

Installing on WebSphere Liferay DXP 2024.Q1/Portal 7.4 GA112 or below Compatibility with IBM WebSphere application server has been removed in 2024.Q2 and later releases. Installing Liferay DXP...

Published Date: Nov 22, 24, 10:49 PM

Installing on WildFly

Installing on WildFly Installing on WildFly requires installing the DXP WAR, installing dependencies, configuring WildFly, and deploying DXP on WildFly. You must also configure your database and...

Published Date: Nov 22, 24, 10:49 PM

Installing on JBoss EAP

Installing on JBoss EAP Installing on JBoss EAP requires installing the DXP WAR, installing dependencies, configuring JBoss, and deploying DXP on JBoss. You must also configure your database and...

Published Date: Nov 22, 24, 10:49 PM

Installing on Tomcat

Installing on Tomcat Using a Liferay-Tomcat bundle or Docker image is the fastest way to get started using Liferay DXP. This article is for users who want to have full control over their Tomcat...

Published Date: Nov 22, 24, 10:49 PM

Installing on WebLogic

Installing on WebLogic If you are using WebLogic as your application server, it is highly recommended to install DXP to a WebLogic Managed server. A managed server can start and stop DXP quickly...

Published Date: Nov 22, 24, 10:49 PM

Installing Liferay

Installing Liferay Liferay runs on an application server. There are three ways to host Liferay: Using a Docker container Using a Liferay Tomcat bundle, on premises On a supported application...

Published Date: Nov 22, 24, 10:49 PM

Configuring a Database

Configuring a Database By default for demonstration purposes, Liferay DXP/Portal is configured to use an embedded HSQL database. Beyond demonstration purposes, we recommend using a full-featured,...

Published Date: Nov 22, 24, 10:49 PM

Setting Up JNDI on Tomcat

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...

Published Date: Nov 22, 24, 10:49 PM

Installing a Liferay-Tomcat Bundle

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...

Published Date: Nov 22, 24, 10:49 PM

Installation and Upgrades

Published Date: Nov 22, 24, 10:49 PM

Configuring Containers

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...

Published Date: Nov 22, 24, 10:49 PM

Providing Files to the Container

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...

Published Date: Nov 22, 24, 10:49 PM

Patching DXP in Docker

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...

Published Date: Nov 22, 24, 10:49 PM

Container Lifecycle and API

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:...

Published Date: Nov 22, 24, 10:49 PM

Running Liferay for the First Time

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...

Published Date: Nov 22, 24, 10:49 PM

Installing Apps and Other Artifacts to Containers

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...

Published Date: Nov 22, 24, 10:49 PM

Licensing DXP in Docker

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...

Published Date: Nov 22, 24, 10:49 PM

Running Scripts in Containers

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....

Published Date: Nov 22, 24, 10:49 PM

Patching Earlier DXP Versions

Patching Earlier DXP Versions Liferay DXP uses Bundle Releases for its latest releases. Please see [Updating Liferay](./updating-liferay.md) if you are applying an Update. All Hotfixes are patches....

Published Date: Nov 22, 24, 10:49 PM

Upgrading to a New Docker Image

Upgrading to a New Docker Image As new Liferay versions are released as Docker images, you can upgrade to them. Upgrade Basics describes the process. **Always** [back...

Published Date: Nov 22, 24, 10:49 PM

Docker Image Versions

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...

Published Date: Nov 22, 24, 10:49 PM

Maintaining a Liferay Installation

Maintaining a Liferay Installation Starting with Liferay DXP 7.3 SP3+ and 7.4 GA1+, Liferay adopted a new release model for delivering updates and fixes. This new approach is referred to as Bundle...

Published Date: Nov 22, 24, 10:49 PM

Starting with a Docker Image

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...

Published Date: May 9, 24, 6:51 PM

Using Liferay Docker Images

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...

Published Date: Nov 22, 24, 10:49 PM

Updating Liferay

Updating Liferay Liferay DXP 7.3 SP3+/Portal 7.4 GA1+ Update your Liferay installation with Bundle Releases. The latest features, security releases, as well as library updates are all delivered...

Published Date: May 9, 24, 6:51 PM