Insites Docs Developers guide ModulesConfiguring a Module Template

Configuring a Module Template

Last updated on June 26, 2024.

This guide shows you how to edit the configuration file of a module template. As an example, this guide shows you how to specify that the module's dashboard page will be available after the module has been installed. This guide uses a sample module as an example.

Prerequisites

To understand this tutorial, you must comprehend basic Insites concepts, the topics in the 'Get Started' section, modules, and module templates.

Steps

Configuring a module template is a three-step process:

  • Step 1: Starting the module installation
  • Step 2: Editing the configuration file
  • Step 3: Testing your changes

Step 1: Starting the module installation

Start the module installation process using the Insites CLI. Once the process starts, a page is displayed asking for confirmation about the module's deployment and showing the module configuration file.

Step 2: Editing the configuration file

The configuration file contains configurable elements of the module, for example:

Edit the configuration file to:

Click on . A message saying, "Module is being deployed. Check your email in a few minutes." is displayed.

Step 3: Testing your changes

Load the URL of your Instance appending the slug you specified, for example, 

The module's page is displayed with the modified "THIS IS A TEST" title.

Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.