Search Results

Capability
Feature
Deployment Approach
Introduction to the Admin Account
Introduction to the Admin Account The Admin User account is created by default in any new installation of Liferay DXP and has full permissions to modify every facet of a Liferay DXP instance. The...
Published Date: May 9, 2024 6:51 PM
Producing and Implementing APIs with REST Builder
Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...
Published Date: May 9, 2024 6:51 PM
Embedding Videos Into Liferay Assets and Pages
Embedding Videos Into Liferay Assets and Pages With Liferay, you can use URLs and video shortcuts to embed videos into Web Content, Knowledge Base articles, Forms, Blog entries, and Site Pages. ...
Published Date: May 9, 2024 6:50 PM
Recycle Bin Overview
Recycle Bin Overview An integrated Recycle Bin can temporarily store content and data you want to remove from your instance before making that removal permanent. By default, the Recycle Bin is...
Published Date: May 9, 2024 6:50 PM
Navigating DXP
Navigating DXP Liferay DXP's out-of-the-box navigation is organized into three major areas: Site Menu, Personal Menu, and Global Menu. Site Menu The DXP Site Menu on the left side of the screen...
Published Date: May 9, 2024 6:51 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, 2024 10:49 PM
Using Liferay as a Headless Platform
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
Published Date: Nov 22, 2024 10:48 PM
DXP
DXP Welcome to the official documentation for the latest versions of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used around the world,...
Published Date: Nov 22, 2024 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, 2024 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, 2024 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, 2024 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, 2024 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, 2024 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, 2024 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, 2024 10:49 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, 2024 3:43 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, 2024 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, 2024 10:49 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, 2024 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, 2024 6:51 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 up your data and installation...
Published Date: Nov 22, 2024 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, 2024 10:49 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, 2024 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, 2024 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, 2024 6:51 PM
Patching Earlier DXP Versions
Patching Earlier DXP Versions 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...
Published Date: Nov 22, 2024 10:49 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, 2024 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, 2024 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: Jan 18, 2025 2:47 AM
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, 2024 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, 2024 6:51 PM
Securing Liferay
Securing Liferay Liferay is built with security in mind. This includes mitigation of common security vulnerabilities and exploits like those described by the OWASP Top 10 and the CWE/SANS Top 25. ...
Published Date: Jan 18, 2025 2:47 AM
Authenticating with CAS (Central Authentication Service)
Authenticating with CAS (Central Authentication Service) CAS was deprecated as of Liferay DXP 7.2 and removed as of Liferay DXP 7.4. Please use SAML instead. CAS is a widely used open source...
Published Date: May 9, 2024 6:52 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, 2024 6:51 PM
Database Configuration
Database Configuration 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: Jan 18, 2025 2:47 AM
Database Templates
Database Templates Below are templates (example portal properties and Docker environment variables) for configuring various databases as a built-in data source for Liferay DXP. MariaDB Portal...
Published Date: Jan 18, 2025 2:47 AM
Liferay Software Versions
Liferay Software Versions Starting with Liferay 7.4, Liferay adopted a rolling release model for delivering updates and fixes. This means Liferay 7.4 is a long living release with many releases for...
Published Date: Jan 18, 2025 2:47 AM
Portal Properties
Portal Properties Configuration options are specified using Portal Properties, sets of name/value pairs read from properties files and Docker environment variables on server startup. Default values...
Published Date: May 9, 2024 6:52 PM
System Properties
System Properties Liferay DXP/Portal runs in the application server's JVM. System properties can be passed directly to the JVM as arguments to java in the format -D[name1]=[value1] or can be loaded...
Published Date: May 9, 2024 6:52 PM
Configuring SAML at the Instance Level
Configuring SAML at the Instance Level Each portal instance can be a SAML provider, either an Identity Provider (IdP) or a Service Provider (SP). Whichever role your DXP instance fills, you can...
Published Date: May 9, 2024 6:52 PM
Using Authentication Verifiers
Using Authentication Verifiers Authentication Verifiers authenticate remote invocations of Liferay Portal's API in a centralized and extensible way. They have two main responsibilities: Verify...
Published Date: May 9, 2024 6:52 PM
Setting Up Liferay
Setting Up Liferay After installing Liferay, configure it to meet your needs. Here are common setup tasks. Setup Tasks Preconfigure the System Activate Liferay (Subscription Required) ...
Published Date: May 9, 2024 6:52 PM
Configuring Unicast over TCP
Configuring Unicast over TCP If your network configuration or the geographical distance between cluster nodes prevents you from using UDP Multicast clustering, you can configure TCP Unicast. You...
Published Date: May 9, 2024 6:52 PM
Alternative Email Configuration Methods
Alternative Email Configuration Methods There are several methods of configuring Liferay DXP to connect to a mail server. The simplest way to get started is to configure mail using through the...
Published Date: May 9, 2024 6:52 PM
Configuring Microsoft Office 365 with OAuth
Configuring Microsoft Office 365 with OAuth Liferay DXP 7.4 U79+/Liferay Portal 7.4 GA79+ Connect your Microsoft email service to Liferay with the use of OAuth 2.0 authorization. Note, Microsoft...
Published Date: May 9, 2024 6:52 PM
Configuring Mail
Configuring Mail Liferay DXP/Portal can be configured to use a mail server to send email notifications for a variety of purposes: User registration and password management, Site membership...
Published Date: May 9, 2024 6:52 PM
Data Removal
Data Removal Available 7.4+ Use the Data Removal tool to erase unnecessary application data, such as expired journal articles and publication previews. To remove data, Open the Global Menu...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
Data Cleanup
Data Cleanup Available 7.3+ When you're done using an obsolete Liferay app or capability, you can remove its data. You can use the Control Panel or a configuration file to do data cleanup. Here's...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
Maintenance Mode and Deprecations in Liferay DXP 2025.Q2
Maintenance Mode and Deprecations in Liferay DXP 2025.Q2 Features moved to Maintenance Mode or marked as Deprecated in Liferay DXP 2025.Q2 appear here. For details about these statuses and their...
Published Date: May 7, 2025 4:42 PM
Using the Database Upgrade Tool
Using the Database Upgrade Tool The Liferay Database Upgrade Tool is a client program for upgrading Liferay DXP and Liferay Portal databases offline. Always back up your data and installation...
Published Date: May 9, 2024 6:52 PM
Database Pruning for Faster Upgrades
Database Pruning for Faster Upgrades The more data you have the longer your data upgrade takes. Unneeded site data is a common occurrence. Pruning the database of unneeded data improves upgrade...
Published Date: May 9, 2024 6:52 PM
2025.Q2 Default Setting and Feature Flag Changes
2025.Q2 Default Setting and Feature Flag Changes Most new versions of Liferay DXP include changes to the default settings. If you rely on the defaults from your old version, review the changes and...
Published Date: Jun 2, 2025 6:29 PM
Database Upgrade Options
Database Upgrade Options When a release, update, or fix pack has database schema changes, it's helpful to know the options for applying the changes. Here you'll find the database upgrade options...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:52 PM
Monitoring Upgrades with MBeans
Monitoring Upgrades with MBeans Liferay DXP 7.4 U76 / Liferay Portal 7.4 GA76 When upgrade upon startup is enabled, the upgrade process can be monitored with MBeans through a JVM management tool...
Published Date: May 9, 2024 6:52 PM
Liferay Faces Alloy
Liferay Faces Alloy Liferay Faces Alloy is distributed in a .jar file. You can add Liferay Faces Alloy as a dependency to your portlet projects, to use AlloyUI in a way that is consistent with JSF...
Published Date: May 9, 2024 6:53 PM
Defining Entity Finder Methods
Defining Entity Finder Methods Finder methods retrieve entity objects from the database based on specified parameters. For each finder defined, Service Builder generates several methods to fetch,...
Published Date: May 9, 2024 6:52 PM
Defining Entities
Defining Entities Entities are the heart and soul of a service. They represent the map between the model objects in Java and your database fields and tables. Service Builder automatically maps your...
Published Date: May 9, 2024 6:52 PM

Capabilities

Product

Education

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy