Capability

Cloud

Liferay Cloud Platform provides the infrastructure and tooling necessary to simplify, secure, and deliver applications on Liferay DXP when using the SaaS or PaaS deployment approaches. Using Liferay’s Cloud infrastructure provides a secure, reliable, and scalable platform for building Liferay solutions.

The Liferay Cloud Platform includes DevOps CI/CD tools, automated backups, real-time logs, and much more.

Feature
Deployment Approach
Capability
Managing Translation Permissions
Managing Translation Permissions The required permissions for translating content pages and web content depend on the translation method: Manual translation requires either Update permissions...
Published Date: May 9, 24, 6:51 PM
Using Third Parties for Translation
Using Third Parties for Translation Available Liferay 7.4 U15+ and GA15+ Liferay can integrate with the following service APIs to generate automatic translations of content pages and web content. ...
Published Date: May 9, 24, 6:51 PM
Developer Guide
Developer Guide This Developer Guide serves as a comprehensive resource for understanding and leveraging Liferay’s Web Content API. It supports the integration and management of web content within...
Published Date: May 9, 24, 6:51 PM
Web Content Articles
Web Content Articles Web content articles are dynamic content entries that can be created, edited, and managed through Liferay’s built-in content management system (CMS). You can use web content...
Published Date: May 9, 24, 6:51 PM
Web Content API Basics Using GraphQL
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
Published Date: Nov 19, 24, 3:27 PM
Assigning Permissions to Web Content Articles
Assigning Permissions to Web Content Articles With Liferay's permissions framework, you can control which users can create, view, and manage web content articles. You can set permissions for...
Published Date: May 9, 24, 6:51 PM
Managing Web Content Structures and Templates by Using the REST API
Managing Web Content Structures and Templates by Using the REST API Web content structures define the information included in a web content article. Structures facilitate creating and managing web...
Published Date: May 9, 24, 6:51 PM
Web Content API Basics
Web Content API Basics Using Liferay DXP REST services, you can create and manage structured content on your site. Structured content refers to web content articles that use a web content structure...
Published Date: May 9, 24, 6:51 PM
Web Content Templates
Web Content Templates With Web Content Templates, you can define how content appears, ensuring that your web content aligns with your brand and functional requirements. Learn how to create...
Published Date: May 9, 24, 6:51 PM
Creating Web Content Templates
Creating Web Content Templates Web content templates use the FreeMarker Template Language (FTL) to determine how content fields are rendered on a page. Each template can be associated with a web...
Published Date: May 9, 24, 6:51 PM
API Builder
API Builder Liferay DXP 2023.Q4+/Portal 7.4 GA102+ [Beta Feature](../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently behind a beta feature...
Published Date: May 9, 24, 6:51 PM
Building a Sample API Application
Building a Sample API Application Liferay DXP 2023.Q4+/Portal 7.4 GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) The API Builder is...
Published Date: May 9, 24, 6:51 PM
APIs with REST Builder
APIs with REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate...
Published Date: May 9, 24, 6:51 PM
Consuming GraphQL APIs
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here's how to consume them in three steps: Identify the API you wish to consume. Identify the site...
Published Date: May 9, 24, 6:51 PM
Configuring JSON Web Services
Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...
Published Date: Nov 16, 24, 3:32 PM
Consuming REST Services
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...
Published Date: May 9, 24, 6:51 PM
Data Migration Center
Data Migration Center Liferay DXP 2023.Q4+/Portal 7.4 GA102+ [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently, this feature is behind...
Published Date: May 9, 24, 6:51 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, 24, 6:51 PM
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, 24, 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, 24, 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, 24, 10:48 PM
Using OAuth 2.0
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users can seamlessly share select credentials from your Liferay-based website with various clients. OAuth 2.0 works by...
Published Date: May 9, 24, 6:51 PM
Installing on Tomcat
Installing on Tomcat Using a Liferay-Tomcat bundle or Docker image is the fastest way to get started using Liferay DXP. This article is for users who want to have full control over their Tomcat...
Published Date: Nov 22, 24, 10:49 PM
Installing on WebLogic
Installing on WebLogic If you are using WebLogic as your application server, it is highly recommended to install DXP to a WebLogic Managed server. A managed server can start and stop DXP quickly...
Published Date: Nov 22, 24, 10:49 PM
Installing on WebSphere
Installing on WebSphere Liferay DXP 2024.Q1/Portal 7.4 GA112 or below Compatibility with IBM WebSphere application server has been removed in 2024.Q2 and later releases. Installing Liferay DXP...
Published Date: Nov 22, 24, 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, 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
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
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
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
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
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
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, 24, 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, 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
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
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
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, 24, 6:51 PM
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, 25, 2:47 AM
JVM Configuration
JVM Configuration As of Liferay DXP 2024.Q3+/Portal 7.4 GA125+, Liferay DXP/Portal requires a Java JDK 17 or 21 (prior versions support JDKs 8 and 11) with specific JVM option settings. There are...
Published Date: May 9, 24, 6:51 PM
Liferay Home
Liferay Home Liferay Home is the folder from which Liferay DXP/Portal launches applications, reads and applies configurations, loads JAR files, generates logs, and more. Liferay Home's location...
Published Date: May 9, 24, 6:51 PM
Liferay's Cookies
Liferay's Cookies Strictly Necessary Cookies Cookie NamePurposeDuration COOKIE_SUPPORTStores the user's preference (true/false) to store cookies in the browser.365 Days...
Published Date: Sep 25, 24, 3:44 PM
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, 24, 6:52 PM
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, 25, 2:47 AM
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, 24, 6:52 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, 25, 2:47 AM
Authentication Basics
Authentication Basics By default, Liferay DXP uses the Sign In widget to authenticate users. The Sign In widget appears on the default home page at http[s]://[server-name:port]/web/guest/home. If...
Published Date: May 9, 24, 6:52 PM
Configuring Single Sign-On
Configuring Single Sign-On Liferay Portal/DXP supports many ways of authenticating, from token-based solutions to standards such as OpenID Connect and SAML. With all the available options, you...
Published Date: May 9, 24, 6:52 PM
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](./authenticating-with-saml.md) instead. CAS...
Published Date: May 9, 24, 6:52 PM
Authenticating with Kerberos
Authenticating with Kerberos You can use Kerberos to authenticate Microsoft Windows™ accounts with Liferay DXP. This is done by using a combination of Liferay DXP's LDAP support and a web server...
Published Date: May 9, 24, 6:52 PM
Authenticating with SAML
Authenticating with SAML The SAML (Security Assertion Markup Language) adapter provides Single Sign On (SSO) and Single Log Off (SLO) in your deployment. SAML works by using Identity Providers...
Published Date: May 9, 24, 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, 24, 6:52 PM
Configuring SAML at the System Level
Configuring SAML at the System Level Before allowing any portal instances to enable SAML authentication, you should configure it at the system level so those instances have a foundation from which...
Published Date: May 9, 24, 6:52 PM
Importing User Groups' Memberships from an External IdP through SAML
Importing User Groups' Memberships from an External IdP through SAML This feature was released behind a dev feature flag. It was made Generally Available (GA) in Liferay DXP 2024.Q2/GA120. You...
Published Date: May 9, 24, 6:52 PM
SAML Admin
SAML Admin The SAML Admin panel is the best place to configure your SAML instance. Use it instead of Instance Settings to streamline your SAML administration experience. You can configure an...
Published Date: May 9, 24, 6:52 PM
Upgrade Stability and Performance
Upgrade Stability and Performance When you upgrade a DXP instance for a production release, the data upgrades must be done correctly and swiftly. Here are some ways to help assure success: ...
Published Date: May 9, 24, 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, 24, 6:52 PM
Example: Removing Intermediate Journal Article Versions
Example: Removing Intermediate Journal Article Versions These instructions and code samples demonstrate removing intermediate Journal Article versions. In the script console, you can remove...
Published Date: May 9, 24, 6:52 PM
Database Tuning for Upgrades
Database Tuning for Upgrades Performing an upgrade impacts the database differently from daily running in production. Because of this, you should tune your database for the upgrade process before...
Published Date: May 9, 24, 6:52 PM
Upgrading Custom Development
Upgrading Custom Development Upgrading on 7.4 After upgrading your installation, you must also upgrade your customizations. This includes apps, services, configurations, and more. The steps to...
Published Date: May 9, 24, 6:52 PM

Capabilities

Product

Education

Contact Us

Connect

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