/flashlight-search

An instanceable and customizable search portlet for Liferay 7

Primary LanguageJavaGNU Lesser General Public License v3.0LGPL-3.0

Flashlight search system

Flashlight is a set of OSGi modules aiming to provide a more personalized search experience inside Liferay 7/DXP.

Installing Flashlight from source

Installing the BOM

The project depends on a Maven artifact that is not yet deployed on Maven Central.

  1. Download the following artifact: https://github.com/savoirfairelinux/liferay-7-boms/blob/master/sp1/pom.xml
  2. Install it using: mvn -C clean install

Compiling

You can produce the JARs by performing the following command in the source tree:

mvn -C clean package

This will produce OSGi bundles in each of the modules' target directory. Deploy them in Liferay's deploy folder.

If you also activate a Maven profile with a property name liferay.deploy.folder leading to Liferay's deploy folder, you may use the following command to compile and deploy the modules directly to your Liferay instance:

mvn -C -P local-deploy clean install

This will produce the OSGi modules, install them in your local repository and copy the artifacts to the path declared in your profile's liferay.deploy.folder.

Using and extending Flashlight Search

After deploying all the Flashlight modules on your Liferay instance, you will be able to access the system's documentation by placing a Flashlight Search Portlet on a page and accessing its "Help" mode.