Search Results

Capability
Feature
Deployment Approach
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
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
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
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, 24, 10:48 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, 24, 10:48 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, 24, 10:48 PM
OAuth 2 Scopes
OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...
Published Date: Nov 22, 24, 10:48 PM
Creating an OAuth2 Application
Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Do this by accessing Control...
Published Date: Nov 22, 24, 10:48 PM
DXP
DXP Welcome to the official documentation for the latest versions (7.3 and 7.4+) of Liferay DXP and Liferay Portal! Liferay DXP is the commercially supported and enterprise ready platform used...
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
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
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
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
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
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
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
Tuning Your JVM
Tuning Your JVM Java Virtual Machine (JVM) tuning primarily focuses on adjusting Java heap and non-heap settings and configuring garbage collection. Finding settings that perform well for you...
Published Date: May 9, 24, 6:52 PM
Maintenance Mode and Deprecations in 7.4
Maintenance Mode and Deprecations in 7.4 With each new Liferay DXP and Liferay Portal release, a feature may not warrant continued enhancements or may become obsolete. Stopping enhancements for a...
Published Date: May 9, 24, 6:52 PM
Upgrade Report
Upgrade Report Available 7.4+ When you perform upgrades, it is important to know the changes made and any issues that occurred. The upgrade status returns combined results for core upgrades,...
Published Date: May 9, 24, 6:52 PM
PortletMVC4Spring Configuration Files
PortletMVC4Spring Configuration Files A PortletMVC4Spring application has these descriptors, Spring contexts, and properties files in its WEB-INF folder: web.xml → Web application descriptor ...
Published Date: Nov 22, 24, 10:50 PM
Portlet Level Configuration
Portlet Level Configuration With the configuration framework, you can set your application's configuration for different levels of scope. Where Instance and Site-scoped configurations use...
Published Date: Nov 22, 24, 10:50 PM
Field Options Provider
Field Options Provider You can populate a drop-down list manually in the @Meta.AD annotation of the configuration interface. But you can also populate the option labels and values automatically...
Published Date: Nov 22, 24, 10:50 PM
Hiding the Configuration UI
Hiding the Configuration UI Liferay generates a configuration UI automatically after a configuration interface deploys. But you may have certain use cases where you want to hide the UI. For...
Published Date: Nov 22, 24, 10:50 PM
DDM Form Annotations
DDM Form Annotations The auto-generated configuration interface UI may be too simplistic for some configurations. You can use the Dynamic Data Mapping (DDM) form annotations to customize your...
Published Date: Nov 22, 24, 10:50 PM
Micro Frontends
Micro Frontends Micro frontends extend the concept of microservices to the frontend side of development. You can build a fully-featured and powerful browser application that uses a microservice...
Published Date: Nov 22, 24, 10:50 PM
Job Scheduler UI Reference
Job Scheduler UI Reference Job Scheduler Triggers View, create, and manage Job Scheduler Tasks. The Job Scheduler Triggers tab lists all tasks added to the Liferay instance. Click Add (Add...
Published Date: Nov 22, 24, 10:50 PM
Understanding the Job Scheduler Framework
Understanding the Job Scheduler Framework Liferay Job Scheduler is a flexible framework built on top of Liferay's Scheduler Engine. You can use it to add, execute, and schedule tasks containing any...
Published Date: Nov 22, 24, 10:50 PM
Data Set View Sorting
Data Set View Sorting Liferay DXP 2024.Q1 U112 [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) While managing data set views, you can set...
Published Date: Nov 22, 24, 10:50 PM
Configuration Model Listener Reference
Configuration Model Listener Reference Use model listeners in your own configurations to listen for events and execute code in response. Creating a model listener requires only three steps: ...
Published Date: Nov 22, 24, 10:50 PM
Managing Object Entries Using GraphQL
Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...
Published Date: Nov 22, 24, 10:50 PM
Portal Developer Properties
Portal Developer Properties There are Portal Properties that facilitate development. Liferay's portal-developer.properties file includes all of them. The portal-developer.properties file is enabled...
Published Date: Nov 22, 24, 10:50 PM
Gogo Shell Commands
Gogo Shell Commands The Gogo shell executes Felix Gogo basic commands and Liferay commands. The Gogo shell is accessible in the Control Panel (recommended) and from the command line. Here are some...
Published Date: Nov 22, 24, 10:50 PM
Command Line Gogo Shell
Command Line Gogo Shell If you're in a development environment, you can interact with the module framework locally from the command line. Gogo shell should only be run from the command line in...
Published Date: Nov 22, 24, 10:50 PM
Reference
Reference 7.4 Breaking Changes 7.3 Breaking Changes 7.2 Breaking Changes Exported Third-Party Packages Portal Developer Properties
Published Date: Nov 22, 24, 10:50 PM
Remote Applications with Headless APIs
Remote Applications with Headless APIs Available 7.4+ After creating and publishing objects, headless REST APIs are automatically generated. Here you'll see how to integrate these endpoints to...
Published Date: Nov 22, 24, 10:50 PM
Packaging Client Extensions
Packaging Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Client extension projects are built as deployable archives called Liferay Universal File Format Archives...
Published Date: Nov 22, 24, 10:50 PM
Client Extensions
Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 When you want to extend Liferay, either by modifying its look and feel or by calling functions outside of Liferay, you...
Published Date: Nov 22, 24, 10:50 PM
Configuration as Code
Configuration as Code Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Liferay instance configurations are deployable with client extensions. For example, you can deploy OAuth2...
Published Date: Nov 22, 24, 10:50 PM
PortletMVC4Spring Project Anatomy
PortletMVC4Spring Project Anatomy PortletMVC4Spring portlets are packaged in WARs. Liferay provides Maven archetypes for creating projects configured to use JSP/JSPX and Thymeleaf templates. Their...
Published Date: Nov 22, 24, 10:50 PM
PortletMVC4Spring Annotations
PortletMVC4Spring Annotations PortletMVC4Spring provides several annotations for mapping requests to controller classes and controller methods. @RenderMapping Annotation Examples The following...
Published Date: Nov 22, 24, 10:50 PM
Using React
Using React Build your own solutions using Liferay and React.
Published Date: Nov 22, 24, 10:50 PM
Using Localized Messages in an MVC Portlet
Using Localized Messages in an MVC Portlet Liferay's localization framework is for creating localized messages in your MVC portlet. Deploy the Sample Code Then, follow these steps: Download...
Published Date: Nov 22, 24, 10:50 PM
Using Liferay Util Param
Using Liferay Util Param The param tag lets you set a parameter for an included JSP page. This configuration requires two JSPs. JSP A, the main view of the app, includes JSP B and sets its...
Published Date: Nov 22, 24, 10:50 PM
Using Spring
Using Spring PortletMVC4Spring is a way to develop portlets using the Spring Framework and the Model View Controller (MVC) pattern. While the Spring Framework supports developing servlet-based web...
Published Date: Nov 22, 24, 10:50 PM
Reference
Reference PortletMVC4Spring integrates Spring, the Spring Web Framework, and the MVC design pattern with portlet development. As such, it uses configuration files from each of these areas and...
Published Date: Nov 22, 24, 10:50 PM
OSGi and Modularity
OSGi and Modularity Modularity makes writing software, especially as a team, fun! Here are some benefits to modular development on Liferay: Liferay's runtime framework is lightweight, fast, and...
Published Date: Nov 22, 24, 10:50 PM
APIs as OSGi Services
APIs as OSGi Services After you've learned what a module is and how to deploy one, you can use modules to define APIs and implement them. Liferay APIs are OSGi services, defined by Java interfaces...
Published Date: Nov 22, 24, 10:50 PM
Building Liferay Source
Building Liferay Source This section aims to provide instructions for building Liferay Portal from source as quickly as possible. Using a nightly snapshot bundle no longer requires a full build...
Published Date: Nov 22, 24, 10:50 PM
Organizing the Source
Organizing the Source It is important to have a solid understanding of how the Liferay source is organized when working on fixing a bug or adding a new feature to the product. The Liferay Source...
Published Date: Nov 22, 24, 10:50 PM
Contributing to Liferay Development
Contributing to Liferay Development The first thing to do in learning to fix bugs or contributing a feature is to become familiar with how to build the system. The Liferay Portal build system now...
Published Date: Nov 22, 24, 10:50 PM
Module Life Cycle
Module Life Cycle In OSGi, all components, Java classes, resources, and descriptors are deployed via modules (OSGi bundles). The MANIFEST.MF file describes the module's physical characteristics,...
Published Date: Nov 22, 24, 10:50 PM
Configuring Dependencies
Configuring Dependencies Liferay provides a container where modules can publish and consume functionality through their Java packages. Modules can leverage packages from other modules or...
Published Date: Nov 22, 24, 10:50 PM
Bundle Classloading Flow
Bundle Classloading Flow The OSGi container searches several places for imported classes. It's important to know where it looks and in what order. Liferay DXP's classloading flow for OSGi bundles...
Published Date: Nov 22, 24, 10:50 PM

Capabilities

Product

Contact Us

Connect

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