Documentation

Remote Apps

Remote Apps is an application for extending Liferay DXP without developing and deploying OSGi modules to the Liferay server. It uses Liferay’s front-end infrastructure to integrate external applications with the platform and render them as Page widgets. Use Remote Apps to integrate applications from any domain.

Register external JS applications with the Liferay platform and render them as Page widgets.

You create remote app entries at the company level, including the necessary URLs and details for registering the application with Liferay. Liferay then generates a widget for each entry and renders the application according to its entry type.

Liferay provides two types of remote app entries: Iframe and Custom Element. While both types are incorporated into a Page during the render Page life cycle, they are hosted and rendered differently. They also have different levels of access to Liferay services and runtime data.

  • IFrame: This type renders the application into an IFrame element (<iframe>) and can allow for limited interaction with the host page using Liferay’s optional client SDK API. Each entry of this type stores a URL reference to where the application is running.

  • Custom Element: This type renders the application as an HTML custom element, which extends the Page’s HTML by creating new tags and associating them with custom logic. Each entry of this type stores URL references to the application’s code (i.e., the essential .js and .css files stored in a document or cloud library).

Using Remote Apps, you can decouple your custom application’s development cycle from the platform while building Liferay-compatible applications that are less dependent on a specific Liferay version.

This approach can benefit all kinds of development environments. For on-premise scenarios, it helps to reduce dependence on the Liferay platform and simplify the upgrade path. In multi-tenant and SaaS environments, Remote Apps provides powerful customization capabilities without requiring deploying modules to the Liferay server.

To get started, see Creating a Basic Remote App.