GETTING_STARTED.markdown

Getting Started with Liferay Workspace

Complete documentation for Liferay Workspace can be found here.

Folder Structure

my-project
├── configs
│ ├── common
│ ├── dev
│ ├── docker
│ ├── local
│ ├── prod
│ └── uat
├── modules
│ ├── apis
│ ├── services
│ ├── java widgets
│ ├── js widgets
│ ├── java ee widgets (spring mvc, jsf, etc)
│ └── java themes
└── themes
    └── js themes

Running Liferay DXP locally

my-project $ blade gw initBundle
my-project $ blade gw deploy
my-project $ blade server run

Running Liferay DXP in Docker

my-project $ blade gw createDockerContainer
my-project $ blade gw startDockerContainer

Creating a Liferay DXP distribution

Creating a tar

my-project $ blade gw distBundleTar

Creating a zip

my-project $ blade gw distBundleZip

Creating multiple bundles

my-project $ blade gw distBundleTarAll
my-project $ blade gw distBundleZipAll

Creating a docker image

my-project $ blade gw buildDockerImage

Create a Liferay DXP module

Creating a new service

my-project $ blade create -t service-builder my-service

Creating a javascript theme

my-project $ blade create -t js-theme my-theme

Creating a Java Widget

my-project $ blade create -t mvc-portlet "my-java-widget"

Create a JS Widget

my-project $ blade create -t js-widget "my-js-widget"

Gradle Properties

Set the following in gradle.properties to change the default settings.

liferay.workspace.product

Set the liferay.workspace.product to set the app.server.tomcat.version, liferay.workspace.bundle.url, liferay.workspace.docker.image.liferay, and liferay.workspace.target.platform.version that matches your Liferay Product Version. To override each of these settings, set them individually.

app.server.tomcat.version

Set this property to override the default setting provided by liferay.workspace.product. Set the app.server.tomcat.version to match what is contained inside the Liferay bundle. Both the TestIntegrationPlugin and LiferayExtPlugin rely on this version to match the bundled Tomcat version. If your configured bundle url points to a bundle with a different Tomcat version, set the property below to match that Tomcat version. If you did not set liferay.workspace.product, the default value is 9.0.40.

liferay.workspace.bundle.url

Set this property to override the default setting provided by liferay.workspace.product. Set the URL pointing to the bundle Zip to download. If you did not set liferay.workspace.product, the default value is https://releases-cdn.liferay.com/portal/7.3.6-ga7/liferay-ce-portal-tomcat-7.3.6-ga7-20210301155526191.tar.gz.

liferay.workspace.docker.image.liferay

Set this property to override the default setting provided by liferay.workspace.product. Set the Liferay Portal Docker image to create your container from. If you did not set liferay.workspace.product, the default value is liferay/portal:7.4.0-ga1.

liferay.workspace.target.platform.version

Set this property to override the default setting provided by liferay.workspace.product. Set the Liferay Portal or DXP version to develop and test against. By setting this property, it enables the target platform features such as dependency management and OSGi resolve tasks. Use the version that matches the Liferay Portal or DXP bundle version in this workspace. See GETTING_STARTED#Overwrite-specific-dependency-in-one-project for overrides.

For a list of all available target platform versions, see https://bit.ly/2IkAwwW for Liferay Portal and https://bit.ly/2GIyfZF for Liferay DXP. If you did not set liferay.workspace.product, the default value is 7.4.0.

liferay.workspace.bundle.cache.dir

Set the directory where the downloaded bundle Zip files are stored. The default value is the .liferay/bundles folder inside the user home directory. The default value is ~/.liferay/bundles.

liferay.workspace.default.repository.enabled

Set this to true to configure Liferay CDN as the default repository in the root project. The default value is true.

liferay.workspace.environment

Set the environment with the settings appropriate for current development. The configs folder is used to hold different environments in the same workspace. You can organize environment settings and generate an environment installation with those settings. There are five environments: common, dev, docker, local, prod, and uat. The default value is local.

liferay.workspace.bundle.dist.include.metadata

Set this to true to append metadata for the current environment settings and timestamp. The default value is false.

liferay.workspace.docker.local.registry.address

Set this to the host and port of the local Docker registry. This will enable the user to interact with a Docker registry other than DockerHub (e.g. myregistryaddress.org:5000).

liferay.workspace.docker.pull.policy

Set this to false to pull the user's local Docker cache first. The default value is true.

liferay.workspace.docker.username

Set this property to the registered user name on DockerHub to avoid conflicts with DockerHub.

liferay.workspace.docker.user.access.token

See https://docs.docker.com/docker-hub/access-tokens on how to generate a Docker access token.

liferay.workspace.ext.dir

Set the folder that contains all Ext OSGi modules and Ext plugins. The default value is ext.

liferay.workspace.home.dir

Set the folder that contains the Liferay bundle downloaded from the liferay.workspace.bundle.url property. The default value is bundles.

liferay.workspace.modules.default.repository.enabled

Set this to true to configure Liferay CDN as the default repository for module/OSGi projects. The default value is true.

liferay.workspace.modules.dir

Set the folder that contains all module projects. Set to * to search all subdirectories. The default value is modules.

liferay.workspace.modules.jsp.precompile.enabled

Set this to true to compile the JSP files in OSGi modules and have them added to the distributable Zip/Tar. The default value is false.

liferay.workspace.node.package.manager

Set this property to npm to build Node.js-style projects using NPM. The default value is yarn.

liferay.workspace.plugins.sdk.dir

Set the folder that contains the Plugins SDK environment. The default value is plugins-sdk.

liferay.workspace.themes.dir

Set the folder that contains Node.js-style theme projects. The default value is themes.

liferay.workspace.themes.java.build

Set this to true to build the theme projects using the Liferay Portal Tools Theme Builder. The default value is false.

liferay.workspace.wars.dir

Set the folder that contains all legacy WAR projects. Set to * to search all subdirectories. The default value is modules.

microsoft.translator.subscription.key

Set the subscription key for Microsoft Translation integration. This is service is used to provide automatic translations for buildLang.

target.platform.index.sources

Set this to true if you have enabled the Target Platform plugin (i.e. you have set the above property) and you want to apply the TargetPlatformIDE plugin to the root workspace project. This will cause all of the BOM artifacts jars and their Java sources to be indexed by your IDE. Setting this property to true can slow down your IDE's project synchronization.

Build Customizations via build.gradle

Overwrite specific dependency in one project

Set force = true to overwrite the version of a specific dependency. See https://docs.gradle.org/current/userguide/dependency_downgrade_and_exclude.html#forced_dependencies_vs_strict_dependencies.

Overwrite dependency in multiple projects

Set the following to overwrite the version of a dependency for the project.

subprojects {
	configurations.all {
		resolutionStrategy.force 'groupId:artifactId:version`
	}
}

platform.bndrun

This file allows each module to be resolved against the target version of Liferay. Invoke the operation using the following command: ./gradlew resolve

SUCCESS: The successful result is a list of all the artifacts needed to run without any resolution errors. FAILURE: A failure will indicate missing a requirement. Correct the missing requirement and rerun the task.