Search Results

Capability
Feature
Deployment Approach
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, 2024 10:49 PM
Installation and Upgrades
Installation and Upgrades
Published Date: Nov 22, 2024 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, 2024 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, 2024 10:49 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: Jan 18, 2025 2:46 AM
Using External Reference Codes
Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...
Published Date: May 9, 2024 6:51 PM
Sample API Tutorials
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
Published Date: May 9, 2024 6:51 PM
Authorizing Account Access with OAuth2
Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....
Published Date: Nov 22, 2024 10:48 PM
Making Unauthenticated Requests
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
Published Date: May 9, 2024 6:51 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
Using OAuth 2.0
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...
Published Date: May 9, 2024 6:51 PM
Using OAuth2 to Authorize Users
Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...
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
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, 2024 10:49 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, 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
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
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, 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
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
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
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
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
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, 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
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
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, 2024 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, 2024 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, 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](./updating-liferay.md) if you are applying an Update. All Hotfixes are patches....
Published Date: Nov 22, 2024 10:49 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, 2024 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, 2024 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: Jan 18, 2025 2:47 AM
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: Jan 18, 2025 2:47 AM
Reference
Reference Installing the Patching Tool Configuring the Patching Tool Getting Patch Information Uninstalling Patches Accessing DXP Patche Code
Published Date: Jan 18, 2025 2:47 AM
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

Capabilities

Product

Education

Contact Us

Connect

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