Search Results

All Results 6965
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Alerts and Announcements
Official Documentation
Alerts and Announcements Use the Alerts or the Announcements widgets to broadcast important information. Alerts are for high-priority information (e.g. planned downtime alerts, security alerts,...
Message Boards
Official Documentation
Message Boards The Message Boards widget is deprecated as of Liferay DXP 2024.Q4/Portal GA129. See 2024.Q4 Maintenance Mode and Deprecations for details. Liferay's Message Boards application is a...
Knowledge Base System Settings
Official Documentation
Knowledge Base System Settings Administrators can use the System Settings UI to set the Knowledge Base’s global configuration (across Sites). You can access this UI in Control Panel → Configuration...
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 Knowledge Base Articles
Official Documentation
Creating Knowledge Base Articles Liferay 7.4 U72+/GA72+ Knowledge Base provides tools for creating and managing a repository of articles. You can create articles using the application's WYSIWYG...
Knowledge Base API Basics
Official Documentation
Knowledge Base API Basics You can Create Knowledge Base Articles and Manage the Knowledge Base with Liferay's Knowledge Base app, but you can also use Liferay's REST APIs. Call these services to...
Importing Knowledge Base Articles
Official Documentation
Importing Knowledge Base Articles Liferay 7.4 U72+/GA72+ You can draft Knowledge Base articles as Markdown files and import them to Liferay. To do this, you must ensure each Markdown file is...
Knowledge Base Templates
Official Documentation
Knowledge Base Templates Liferay 7.4 U72+/GA72+ Templates give authors a starting point with default headers or other content for articles. Templates help foster consistent formatting and content...
Managing the Knowledge Base
Official Documentation
Managing the Knowledge Base Liferay 7.4 U72+/GA72+ With Knowledge Base, you can draft product documentation quickly and organize it into hierarchies that end users can navigate. Add folders and...
Responding to Knowledge Base Feedback
Official Documentation
Responding to Knowledge Base Feedback Liferay 7.4 U72+/GA72+ You can view and manage article feedback in the Knowledge Base application. To do this, Open the Site Menu (Site Menu) and go to...
Other Knowledge Base Widgets
Official Documentation
Other Knowledge Base Widgets There are other Knowledge Base widgets you can add to pages besides the Knowledge Base Display widget: Knowledge Base Article: Display a single article’s content. ...
Knowledge Base
Official Documentation
Knowledge Base Liferay 7.4 U72+/GA72+ Knowledge Base provides tools for creating and managing product documentation. You can write articles in the Liferay UI or import existing Markdown files....
Installing Apps and Other Artifacts to Containers
Official Documentation
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...
Patching DXP in Docker
Official Documentation
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
Official Documentation
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...
Upgrading to a New Docker Image
Official Documentation
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...
Using Liferay Util Param
Official Documentation
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...
Using Localized Messages in an MVC Portlet
Official Documentation
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...
Client Extensions
Official Documentation
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...
Instance Settings YAML Configuration Reference
Official Documentation
Instance Settings YAML Configuration Reference You can use an instance settings client extension to configure a wide variety of Liferay configurations. Each configuration is referenced by its PID...
Core Frameworks
Official Documentation
Core Frameworks
Using Spring
Official Documentation
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...
Reference
Official Documentation
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...
PortletMVC4Spring Annotations
Official Documentation
PortletMVC4Spring Annotations PortletMVC4Spring provides several annotations for mapping requests to controller classes and controller methods. @RenderMapping Annotation Examples The following...
Using React
Official Documentation
Using React Build your own solutions using Liferay and React.
Remote Applications with Headless APIs
Official Documentation
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...
Using Object Data with React Charts
Official Documentation
Using Object Data with React Charts Here you'll use Objects, Headless APIs, and custom element remote applications to create a dynamic chart for data dashboards. First, you'll set up a new DXP...
Packaging Client Extensions
Official Documentation
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...
Configuration as Code
Official Documentation
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...
OAuth Headless Server YAML Configuration Reference
Official Documentation
OAuth Headless Server YAML Configuration Reference You can define an OAuth headless server client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines...
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...
OAuth User Agent YAML Configuration Reference
Official Documentation
OAuth User Agent YAML Configuration Reference You can define an OAuth user agent client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines an OAuth...
Categorizing a Configuration
Official Documentation
Categorizing a Configuration When you register a configuration interface, the UI for your application is generated in System Settings → Platform → Third Party. If you prefer a different section and...
Configuration Framework
Official Documentation
Configuration Framework Setting and Accessing Configurations Categorizing a Configuration Scoping Configurations Portlet Level Configuration Configuration Form Renderer DDM Form Annotations ...
Completely Custom Configuration
Official Documentation
Completely Custom Configuration A configuration UI is generated automatically when you create a configuration interface. But in some cases you want a completely custom UI for your configuration....
Configuration Model Listener Reference
Official Documentation
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: ...
DDM Form Annotations
Official Documentation
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...
Hiding the Configuration UI
Official Documentation
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...
Portlet Level Configuration
Official Documentation
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...
PortletMVC4Spring Configuration Files
Official Documentation
PortletMVC4Spring Configuration Files A PortletMVC4Spring application has these descriptors, Spring contexts, and properties files in its WEB-INF folder: web.xml → Web application descriptor ...
PortletMVC4Spring Project Anatomy
Official Documentation
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...
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...
Patching Liferay
Official Documentation
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,...
Fragment Specific Tags and Attributes Reference for Liferay 7.3 and Earlier Versions
Official Documentation
Fragment Specific Tags and Attributes Reference for Liferay 7.3 and Earlier Versions Along with standard HTML, CSS, and JavaScript, you can use Liferay-specific tags and attributes to define...
Using an OSGi Service
Official Documentation
Using an OSGi Service Liferay APIs are readily available as OSGi services. You can access a service by creating a field of that service type and annotating the field with @Reference, like this: ...
Using the Gogo Shell
Official Documentation
Using the Gogo Shell The Gogo shell provides a way to interact with the module framework. Among other things, you can Dynamically install/uninstall bundles (modules) Examine package...
Command Line Gogo Shell
Official Documentation
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...
Gogo Shell Commands
Official Documentation
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...
Managing Object Entries Using GraphQL
Official Documentation
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...
Resolving Third Party Library Package Dependencies
Official Documentation
Resolving Third Party Library Package Dependencies An application can rely on multiple OSGi modules. Resolving their Java package dependencies can be challenging. In a perfect world, every package...
Exporting Packages
Official Documentation
Exporting Packages In OSGi, packages are private by default. You must explicitly exporting a package so other modules can import and use them. Here's how to export packages: Open your bnd.bnd...
Importing Packages
Official Documentation
Importing Packages You often find yourself in a position of needing functionality provided by another module. To access this functionality, you must import packages from other modules into your...
Module Projects
Official Documentation
Module Projects Liferay applications and customizations are OSGi modules: .jar files containing Java code and some extra configuration for publishing and consuming APIs. A module project comprises...
Semantic Versioning
Official Documentation
Semantic Versioning Semantic Versioning is a three tiered versioning system for incrementing version numbers based on the degree of API change made in a releasable software component. It's a...