Mastering Liferay Content Search

This repository contains the Mastering Liferay Content Search course materials.

Course Setup Instructions

Liferay's Course Launcher tool automatically prepares your system and sets up a dedicated workspace for course exercises. Use this tool to streamline course environment setup — with no technical expertise required.

This tool:

• Checks if Java 21 is installed in your system. If not, it installs Zulu JRE 21 from Azul.
• Downloads and configures the course workspace.
• Initializes the local Liferay DXP bundle.

Table of Contents

• Setting Up the Clarity Workspace
• Manual Setup (Optional)

Setting Up the Clarity Workspace

Here, you'll execute the course launcher tool to prepare your system and set up the Clarity workspace you'll use in course exercises.

1. Open your terminal and run this command according to your operating system:

   Linux/Unix:

   /bin/bash -c "$(curl -fsSL https://raw.github.com/liferay/liferay-enablement-script-library/main/content-manager-course-setup.sh)" -- --content-search linux

   Mac:

   /bin/bash -c "$(curl -fsSL https://raw.github.com/liferay/liferay-enablement-script-library/main/content-manager-course-setup.sh)" -- --content-search mac

   Windows:

   powershell Set-ExecutionPolicy Bypass -Scope Process -Force; iex "& { $(irm https://raw.githubusercontent.com/liferay/liferay-enablement-script-library/refs/heads/main/content-manager-course-setup.ps1); install-course --content-search }"

   This executes the course launcher tool, which automatically checks for and installs Java JDK 21, downloads the course's files, and prepares the Liferay DXP bundle.

Note

The full process may take a few minutes to complete.

2. Once the "Liferay bundle initialized" message displays, verify the liferay-course-content-search/ folder was created.

3. Go to the workspace's root folder in your terminal:

   cd liferay-course-content-search/

4. Run this command to start the Liferay server:

   Unix-based:

   ./bundles/tomcat/bin/startup.sh

   Windows:

   .\bundles\tomcat\bin\startup.bat

5. Verify the “Tomcat started“ message displays.

   This indicates that the server has initiated its startup process in the background.

6. Access your Liferay DXP instance by going to localhost:8080 in your browser.

Note

Server startup may take a few minutes to complete.

7. Sign in using these credentials:

   • Username: [email protected]
   • Password: learn

8. Open the Global Menu, go to the Control Panel tab, and click Search.

9. Go to the Index Actions tab and click Reindex for All Search Indexes.

10. When prompted, click Execute to confirm.

11. Take some time to explore the site and resources included in the training workspace.

Note

To shutdown your Liferay server, run this command in your terminal:

Unix-based:

./bundles/tomcat/bin/shutdown.sh

Windows:

.\bundles\tomcat\bin\shutdown.bat

Great! With your environment set up, you’re ready to start contributing to Clarity’s applications.

Manual Setup (Optional)

Alternatively, you can set up your course environment manually.

Note

This process involves more technical steps. If you're using a company system, you may need to contact your company's IT support.

1. Ensure your system satisfies the following prerequisites:

   • Git (macOS | Windows | Linux/Unix)
   • Java JDK 21 (macOS | Windows | Linux)

2. Open your terminal and clone the training workspace to your computer:

   git clone https://github.com/liferay/liferay-course-content-search

   This saves a copy of the project in your current terminal directory.

Note

If you've cloned the repo previously, ensure your workspace is up to date by running git pull origin main.

3. Go to the workspace's root folder in your terminal:

   cd liferay-course-content-search

4. Initialize your Liferay bundle.

   Unix-based:

   ./gradlew initBundle

   Windows:

   .\gradlew.bat initBundle

   This downloads and builds dependencies for running Liferay, including the Liferay Tomcat server.

5. Follow steps 3-9 of the previous section.