Liferay Home

This document has been updated and ported to Liferay Learn and is no longer maintained here.

Liferay Home is the location from which Liferay DXP launches applications, applies configurations, loads JAR files, and generates logs.

• In a Liferay DXP bundle, Liferay Home is the installation’s top-level folder and it contains the application server.

• In a manual installation, the Liferay Home folder varies by application server. If you’re doing a manual installation, please refer to the article covering that app server (e.g., Installing Liferay DXP on [app server]) for the Liferay Home location.

Bundles contain this folder structure regardless of application server:

• [Liferay Home]

  • [Application Server]: This folder is named after the application server where Liferay DXP is installed.

  • data (if HSQL database is selected): Stores an embedded HSQL database, Liferay DXP’s file repository, and search indexes. The embedded HSQL database is configured by default, but it’s intended for demonstration and trial purposes only. The Portal property jdbc.default.url sets the Hypersonic embedded HSQL database location.

  • deploy: To auto-deploy plugins, copy them to this folder. It supports application .lpkg files from Liferay Marketplace, plugin .war files, and plugin .jar files. The Portal property auto.deploy.deploy.dir sets the auto-deploy location.

  • license: Liferay DXP’s copyright and version files are here.

  • logs: Log files go here. Examine them as you diagnose problems. portal-impl.jar’s portal-impl/src/META-INF/portal-log4j.xml file sets the log file location. To override the log file location, you must use an ext-impl/src/META-INF/portal-log4j-ext.xml file in an Ext plugin.

  • osgi: All the JAR files and a few configuration files for the OSGi runtime belong in this folder. The Portal property module.framework.base.dir sets the OSGi folder location. Here are its subfolders:

    • configs: Component configuration files.
    • core: Liferay DXP’s core modules.
    • marketplace: Marketplace applications and application suites.
    • modules: Modules you’ve deployed.
    • portal: Liferay DXP’s non-core modules.
    • state: Contains OSGi internal state files for such things as OSGi bundle installation, bundle storage, and more.
    • target-platform: Target platform index.
    • test: Modules that support test integration.
    • war: WAR plugins you’ve deployed.

  • patching-tool: (Liferay DXP only) This folder contains patches and a utility for installing the patches.

  • tools: For Liferay DXP upgrade and target platform indexer.

  • work: Module Jasper work files.

Note: If Liferay DXP cannot create resources in the Liferay Home folder or if it finds itself running on certain application servers, it creates a folder called liferay in the home folder of the operating system user that is running Liferay DXP. In this case, that liferay folder becomes Liferay Home. For example, if the operating system user’s name is jbloggs, the liferay folder path is /home/jbloggs/liferay or C:\Users\jbloggs\liferay.