Configuring a Module Template

Last edit: Jun 10, 2019
  • Contributors:
  • pavelloz

This guide will help you edit the configuration file of a module template.

If the Partner Portal detects that a module has a configuration template, it allows you to edit it before the module is deployed.

For example, this guide will show you how to specify upon installing a module, where the module's admin page will be available after the module has been installed. This guide uses the AdminCMS module as an example.

Requirements

This is an advanced tutorial. To follow it, you should be familiar with basic platformOS concepts, the topics in the Get Started section, modules, and module templates. You should also know how to install a module.

Steps

Configuring a module template is a three-step process:

Step 1: Start module installation

On the Partner Portal, select the Instance you'd like to install the module on, and start the installation process as described in the Installing a Module tutorial. Once you click on Install and the process starts, a page is displayed asking for confirmation about the deployment of the module and showing the module configuration file.

Step 2: Edit configuration file

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


{
  "slug": "admincms_index",
  "title": "This is AdminCMS",
  "subtitle": "A very nice admin page",
}

Edit the configuration file to:


{
  "slug": "admin_index",
  "title": "THIS IS A TEST",
  "subtitle": "A very nice admin page",
}

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

Step 3: Test your changes

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

https://test.staging.oregon.platform-os.com/admin_index

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

Questions?

We are always happy to help with any questions you may have.