Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

V4.1+ only

IdP modules are available in V4.1 and later.

Overview

...

Overview

The IdP includes a configuration management aid to the IdP called "modules", or "IdP modules" to distinguish them from other uses of the term. The point of an IdP module is to encapsulate information about an optional feature of the software, together with a way to install, update, and remove optional files that are needed to use the feature.

As an example, if you're using Duothe Password login flow, the feature requires at least a viewsome views, a set of properties, and occasionally likely an XML file in a particular spot for more advanced configuration. If you're not using it, none of those files are needed. So, if you're not using Duothe feature, having those files installed and in the way is just annoying and confusing. Making the Duo Password login flow a module allows the system to recognize whether the feature is being used, deploy initial versions of the needed files after installation of the IdP, and remove them if the feature is no longer needed.

...

It is possible that future major versions may remove certain features and turn them into optional plugins that would be installable separately to shrink the footprint further. It is also common for existing files to be made legacy-only and modules may disappear as they no longer require the installation of files, to further reduce the number of files needed.

Using Modules

The only real need to interact with the module system is to enable (or occasionally disable) modules in order to populate configuration files to get started using a feature that has been modularized. This will be noted in the documentation where necessary.

...