Installing a module tutorial

  Written by The Jahia Team
 
Sysadmins
   Estimated reading time:

This tutorial shows you how to deploy and enable a module. A module is a package that you deploy on a Jahia platform to extend or modify the platform. Modules act like plug-ins. To make a module available to your system, you:

  • Deploy it on your server
  • Enable it for your websites
  • If necessary, perform additional configuration specific to the module

You deploy and enable modules in Digital Experience Manager (DX).

After completing the tutorial you will be able to enable and deploy any module in DX. In the example in this tutorial, you deploy and enable the Content Reports module. The Content Reports module provides reports that you can use to monitor and troubleshoot content on your sites. For example, you can run reports to show pages that have untranslated content, are missing titles, or are marked as work in progress.

Note: For more information on content reports, see Generating reports on your content.

Deploying your module

You deploy a module by adding the module's JAR file to DX. You can get JAR file for a module by:

  • Searching for the module in DX in the Administration page
  • Downloading it from the Jahia AppStore. After downloading the module, you upload it in DX or copy the module to the digital-factory-data/modules directory on your server.

To deploy your module from DX:

  1. On the server on which DX is running, in Edit mode, choose Administration>System components>Modules.
  2. On the Modules page, click Available modules and enter Content as search criteria in the search box.
    administration-available-modules.png
  3. Click the content reports module to view more information about the module, including:
    • A description of the module.
    • Dependencies or the other modules required by this module.
    • Dependants of the module. Use this information to decide which modules you may want to install next. 
    • Specific install information for the module. Install information is either included on the page or links are provided to install topics in the documentation.
    Note: The modules list also includes packages, which contain multiple modules. When you deploy a package, you deploy the modules contained in the package. For example, the Marketing Factory - Enterprise Distribution package includes the modules necessary to run Marketing Factory.
    When you view information about a package, modules display under Embedded modules.
  4. To start the module automatically after downloading it, select Start modules automatically after download.
  5. Select the package and click the Download arrow 
    download-icon.png
     beside Content Reports (content-reports) in the Download column. A message indicates that the modules was uploaded and started.
  6. Click Installed modules tab to view the status of the module. Use the Search box to locate the module that you deployed, as shown in the following image. For each module, you can view the version number, whether the module is stopped or started, and whether the module has been enabled for any sites.
    module-install-tab.png

You can stop a module by clicking the Stop button module-stop.png, and then start it using the Start button module-start.png or remove it from DX by stopping it and then clicking the Undeploy button module-undeploy.png.

Next, enable the module for specific websites.

Enabling your module

After deploying the module, you enable it for specific websites to make content reports available to those sites.

To enable the module:

  1. In DX, choose Administration>System components>Modules.
  2. On the Modules page, click Installed modules and enter search criteria to locate the module, as shown in the following example.
    module-install-tab.png
  3. In the Status column, click on the module version number and status. The Content Reports page opens.
    content-reports-page.png
  4. In Usage in sites, move the slider to Enabled for each site that you want to enable the module for.
    module-enabled-for-sites.png
  5. Content reports are now available in System site settings>Content Reports.
    content-reports-byauthor-date.png

What you have learned

This tutorial showed you how to deploy and enable a module for your sites.

In some cases, you may need to perform additional configuration to use the module. For example, when you deploy and enable the Marketing Factory Core module, you also install additional modules and install and configure Apache Unomi and Elasticsearch.