Capability

DXP Self-Hosted Installation, Maintenance, and Administration

Search Bar

In addition to SaaS and PaaS deployment approaches for Liferay DXP, you can also opt to self-host Liferay DXP. Self-hosting gives you flexibility to deploy Liferay DXP on-premises or to a cloud computing provider of your choice, giving you complete control over deployment, infrastructure, and maintenance.

Category
  • Capability
  • Deployment Approach
  • Feature
  • Resource Type
Category
  • Capability
  • Deployment Approach
  • Feature
  • Resource Type
Installation and Upgrades
Official Documentation
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...
3.0 Breaking Changes
Official Documentation
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...
4.0 Breaking Changes
Official Documentation
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...
3.0 Release Notes
Official Documentation
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...
Activating Liferay Commerce Enterprise
Official Documentation
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...
Using the Liferay Commerce Docker Image
Official Documentation
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...
Using the Liferay Commerce Tomcat Bundle
Official Documentation
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...
Maintenance Versions
Official Documentation
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...
Upgrading Liferay Commerce
Official Documentation
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...
Installing Commerce 2.1 and Below
Official Documentation
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...
Deploying Liferay Commerce to an Existing Liferay Installation
Official Documentation
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...
Accessing DXP Patch Code
Official Documentation
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...
Getting Patch Information
Official Documentation
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...
Installing the Patching Tool
Official Documentation
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...
Installing Liferay on an Application Server
Official Documentation
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...
Updating Liferay
Official Documentation
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...
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...
Configuring a Database
Official Documentation
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,...
Self-Hosted Installation and Upgrades
Official Documentation
Self-Hosted Installation and Upgrades Liferay's flexibility makes it possible to host it in any way you choose: on any Kubernetes-based cloud platform via Helm charts and Terraform scripts, on...
Installing Liferay On A Local Server
Official Documentation
Installing Liferay On A Local Server Liferay runs on an application server. There are three ways to host Liferay on a local machine: Using a Docker container Using a Liferay Tomcat bundle On a...
Installing a Liferay-Tomcat Bundle
Official Documentation
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...
Installing Earlier Liferay Versions on WebSphere
Official Documentation
Installing Earlier Liferay Versions on WebSphere Liferay DXP 2024.Q1/Portal GA112 or below Compatibility with IBM WebSphere application server has been removed in 2024.Q2 and later releases. ...
Installing on JBoss EAP
Official Documentation
Installing on JBoss EAP Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on JBoss EAP. Installing on JBoss EAP requires installing the DXP...
Installing on Tomcat
Official Documentation
Installing on Tomcat Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on Tomcat. Using a Liferay-Tomcat bundle or Docker image is the...
Installing on WildFly
Official Documentation
Installing on WildFly Liferay DXP 2025.Q3+/Portal 2026.Q1+ For pre-Jakarta Liferay versions, see Installing Earlier Versions on WildFly. Installing on WildFly requires installing the DXP WAR,...
Running Liferay for the First Time
Official Documentation
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...
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:...
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...
Setting Up JNDI on Tomcat
Official Documentation
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...
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...
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...
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...
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....
Maintaining a Liferay Installation
Official Documentation
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...
Patching Liferay
Official Documentation
Patching Liferay Liferay DXP uses Bundle Releases for its latest releases. Please see Updating Liferay if you are applying an Update. All Hotfixes are patches. If you're applying a Hotfix,...
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...
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...
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...
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...
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...
Configuring the Patching Tool
Official Documentation
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...
Uninstalling Patches
Official Documentation
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)...
Updating Previous Versions of Liferay
Official Documentation
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. ...
Reference
Official Documentation
Reference When installing Liferay, you must take into consideration the specifics of your environment. These topics help you integrate Liferay into your existing environment and aid in...
JVM Configuration
Official Documentation
JVM Configuration As of Liferay DXP 2024.Q3+/Portal 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 also...
Activating Liferay DXP
Official Documentation
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...
Upgrading Liferay
Official Documentation
Upgrading Liferay Liferay is continuously being enhanced with new features as new versions are released. To access these features in your current project, you must upgrade your Liferay instance to...
Preparing for an Upgrade
Official Documentation
Preparing for an Upgrade Preparation and planning may be of little consequence for small, casual installations but is mandatory for large enterprise-level installations. Create a Back Up Always...
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...
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...