Capability

DXP Self-Hosted Installation, Maintenance, and Administration

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
Category
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...
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...
Installing Patches in Earlier Versions
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...
Using the AWS Chart to Run Liferay in AWS
Using the AWS Chart to Run Liferay in AWS Using the AWS chart is a CLI-only method for provisioning Liferay in AWS. Launch Liferay Set and export an environment variable to hold the Liferay AWS...
Patching Liferay
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,...
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...
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...
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...
Viewing Metrics from Kubernetes
Viewing Metrics from Kubernetes It is important to track resource usage in the Kubernetes cluster. To view your resource usage, you must use a collector and an exporter. Before you can view...
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...
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...
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...
Running Liferay on any Kubernetes Cluster
Running Liferay on any Kubernetes Cluster These instructions are purposefully generic. They install a cluster that works on any Kubernetes implementation, but additional work is needed to make that...
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....
Migrating Liferay Instances
Migrating Liferay Instances Liferay DXP 2025.Q2+/Portal GA148+ [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) You can...
JVM Configuration
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...
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. ...
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...
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....
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...
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...
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)...
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. ...
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...
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...
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...
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...
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...
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:...
Docker Packages
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. ...
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...
Building Liferay Docker Images
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,...
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...
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...
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...
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....
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. Upgrading Liferay describes the process. Always back up your data and installation...