Configuration for your Modules

While all Forge apps have a set of core configuration and APIs exposed to them, the majority of functionality is made available by independent modules which have their own API. This section covers how to manage the modules included in your app, and configure those which require it.

Adding modules

You can manage what modules are included in your app from the Toolkit UI:

Module configuration

You can search for and add modules here, or browse the module index:

Add and browse module index

And activate a module from a module's details page:

Activate modules from the index

Removing modules

If you decide you don't want to include a module in your build, simply go to the module configuration view and use the module remove button:

Remove a module

Disabling modules

If you find that you want to prevent a module from being included in a build, but don't want to:

  • Have to lookup the module again to add it.
  • Re-enter any configuration for that module.

Instead of removing the module, you can disable it:

Disable a module

Clicking the disable button again will re-enable the module.

Including your own modules in your app

If you have written any native modules, then any app in the same project can use them. You should see a Private Modules section for such an app:

Viewing private modules

Configuring these is much the same as modules available from the module index, with the only exception being that you can switch module version within the Toolkit UI.

Updating modules

It is highly recommended that you keep up to date with your module versions, to get the latest features and fixes.

In the event of a module having a new version marked as the "current stable" by the maintainer, you will see a warning in Toolkit, and be able to view the details of the new version:

Outdated module

This should show the details for the current stable version. Just click "Activate" to change the version used by your app:

Updating a module

Important: After changing module versions, check the configuration: it may be expecting more information from you!