Search Results

All Results 6965
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Configuring a Message Boards Category Mailing List
Official Documentation
Configuring a Message Boards Category Mailing List The Message Boards widget is deprecated as of Liferay DXP 2024.Q4/Portal GA129. See 2024.Q4 Maintenance Mode and Deprecations for details. You...
Creating Message Boards Categories
Official Documentation
Creating Message Boards Categories The Message Boards widget is deprecated as of Liferay DXP 2024.Q4/Portal GA129. See 2024.Q4 Maintenance Mode and Deprecations for details. Message Boards...
Using OAuth2 to Authorize Users
Official Documentation
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...
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,...
Authorizing Account Access with OAuth2
Official Documentation
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)....
Creating an OAuth2 Application
Official Documentation
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. Open the Global Menu...
OAuth 2 Scopes
Official Documentation
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: ...
DXP
Official Documentation
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,...
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...
Using Domain-Specific Language Queries
Using Domain-Specific Language Queries Liferay 7.4+ DSL Query is an acronym for Domain-Specific Language Query. The foundation is based upon using a domain-specific language for the...
React Component Utilities Reference
Official Documentation
React Component Utilities Reference Several useful tools are available to help you build high-performance components and applications in Liferay DXP using React: frontend-js-react-web module ...
Listening for Registration Events
Official Documentation
Listening for Registration Events Liferay DXP 2023.Q3/Portal GA92 and Below The messaging API supports listening for destination and message listener registration events. Here are some reasons to...
Using Asynchronous Messaging
Official Documentation
Using Asynchronous Messaging Message Bus's asynchronous option provides fire and forget behavior; send a message and continue processing without waiting for a response. An asynchronous message is...
Using Default Synchronous Messaging in Previous Versions
Official Documentation
Using Default Synchronous Messaging in Previous Versions Liferay DXP 7.4 U48/Portal GA49 and Below In default synchronous messaging, the sender blocks while a Message Bus thread dispatches the...
Using Dynamic Query
Using Dynamic Query Liferay's Dynamic Query API wraps Hibernate's Criteria API. It helps you think in terms of objects and member variables instead of tables and columns. Complex queries can be...
Aggregating Resource Bundles
Official Documentation
Aggregating Resource Bundles When working with a module that shares localized messages, the bnd header must specify the resource bundles you want to associate with the module. Liferay provides a...
Working with Client Extensions
Official Documentation
Working with Client Extensions Liferay Self-Hosted Liferay SaaS Liferay PaaS Liferay 7.4 Using client extensions, you can extend Liferay without deploying OSGi modules. Just like traditional...
Using Direct Synchronous Messaging in Previous Versions
Official Documentation
Using Direct Synchronous Messaging in Previous Versions Liferay DXP 7.4 U48/Portal GA49 and Below Direct synchronous messaging is the easiest way to block processing until all listeners receive a...
Themes
Official Documentation
Themes Themes customize the default look and feel of your site. You can define the style and visual identity of your brand or label across your whole site. You can use a theme CSS client...
Fundamentals
Official Documentation
Fundamentals Liferay development projects consist primarily of simple .jar files. These contain a few extra configuration files that make them OSGi modules, but they're easily understandable by...
Customizing the Submit Button
Official Documentation
Customizing the Submit Button Available 7.4+ When a User is finished entering data into a form, they must submit the form. By default a button that says Submit is displayed for this purpose. ...
Translating Forms
Official Documentation
Translating Forms Forms can be translated and presented in any language that is currently enabled on the current site. To add a translation: Begin by viewing an existing form (e.g., Guest...
Using Storage Adapters
Official Documentation
Using Storage Adapters When a User adds a form record, Liferay routes the processing of the request through a storage adapter API. The same is true for the other CRUD operations performed on form...
Customizing Liferay's Look and Feel
Official Documentation
Customizing Liferay's Look and Feel One of the easiest ways to get started developing on Liferay's platform is to modify its look and feel. You can change everything from its favicon to its entire...
Field Autocompletion
Official Documentation
Field Autocompletion You can configure form field autocompletion in the Forms application: Autocompletion TypeConfigurationField Types ManualType a list of autocompletion optionsText Data...
Forms Configuration Reference
Official Documentation
Forms Configuration Reference Here's an overview of all the Forms configurations so you can quickly find a configuration you need. Forms Options You can export and import forms between sites. To...
Forms Permissions Reference
Official Documentation
Forms Permissions Reference This article serves as a guide for all permissions associated with the Forms application. Form Widget Permissions Navigate to the site page where the Form widget has...
Providing Help Text and Predefined Values
Official Documentation
Providing Help Text and Predefined Values Form fields can be configured to have help text, placeholder text, and predefined values that assist users in understanding and filling out a form. Help...
Displaying Categories using Display Pages
Official Documentation
Displaying Categories using Display Pages Available: Liferay DXP/Portal 7.4+. Using a display page template, you can render web content, documents, and blog entries in a display page. Starting...
Using Multiple Display Page Templates to Create Multi-Step Applications
Official Documentation
Using Multiple Display Page Templates to Create Multi-Step Applications Liferay DXP 2023.Q4+/Portal GA102+ Display page templates display content at a dedicated URL. To use this URL and view the...
Displaying Assets Using the Asset Publisher Widget
Official Documentation
Displaying Assets Using the Asset Publisher Widget As you create web content, remember that pieces of content are assets like message board entries and blog posts. The most common type of asset is...
Migration from Audience Targeting
Official Documentation
Migration from Audience Targeting If you're upgrading from a Liferay version that used Audience Targeting, you must migrate to the built-in Segmentation and Personalization features introduced in...
Migrating to Segmentation and Personalization
Official Documentation
Migrating to Segmentation and Personalization Starting with Liferay 7.2, Segmentation and Personalization functionality was integrated into the core product. Users of Audience Targeting must...
Getting Analytics for User Segments
Official Documentation
Getting Analytics for User Segments Subscribers To use Analytics Cloud with User Segments, you must first connect your DXP data source to Analytics Cloud and enable synchronization of users and...
Segmentation By Geolocation
Official Documentation
Segmentation By Geolocation Liferay DXP 7.4 U44+/GA44+ You can configure Segments by geolocation to display different pages dynamically or content based on the user's country. To display different...
Segments Admin Settings
Official Documentation
Segments Admin Settings Liferay DXP/Portal 7.3+ You can configure Segments behavior at the system or instance level. With these settings, you can enable/disable segmentation, set the interval for...
Segments Editor UI Reference
Official Documentation
Segments Editor UI Reference You can use segments to organize users into different groups with common sets of properties. Follow these steps to access the segments editor UI. Go to Site...
Adding Users to Organizations
Official Documentation
Adding Users to Organizations With Liferay organizations, you can manage users and permissions to model your real-life organizational hierarchy, which can then be quickly implemented in...
Organization Roles
Official Documentation
Organization Roles Liferay Organizations provide a convenient way to implement distributed User management. With them, you can use Organization-scoped Roles to assign standard permissions to all...
Assigning Roles to User Segments
Official Documentation
Assigning Roles to User Segments Liferay DXP 7.2 SP2+, Liferay CE 7.3.1 GA2+ User segments are dynamically assigned user collections. If a segment can be well-defined with the available criteria,...
Configuring a Password Policy
Official Documentation
Configuring a Password Policy Password policies enhance the security of your installation. You can use the default policy that ships with Liferay (modified or as is), or you can create your own...
Understanding Roles and Permissions
Official Documentation
Understanding Roles and Permissions To give users the necessary permissions to perform their intended function within Liferay DXP, you must first associate the set of permissions with a role. ...
User Groups
Official Documentation
User Groups Creating and Managing User Groups Managing Site Membership and Permissions with User Groups User Group Sites
Creating and Managing Organizations
Official Documentation
Creating and Managing Organizations If you're not sure what Organizations are or whether you need them, start here. Adding Organizations Click Users and Organizations from Control Panel → Users....
Organization Sites
Official Documentation
Organization Sites Liferay Organizations enable distributed User management, providing a convenient way to organize and manage instance users and roles to reflect your organizational hierarchy....