About Plugins

Installing Plugins

There are a few different ways to make Plugins available for use within Registry, according to how the Plugin is distributed.

1. Core Plugins - Commonly used. These plugins ship with COmanage and enabled by default.
2. Supported Non-core Plugins - Less widely used. Shipped with COmanage, but not enabled by default.  
3. External Plugins - Finally, Plugins can come from other sources (including those you write yourself) to support your needs.

Core Plugins

Many Plugins are already set up, and provided as “Core Plugins”; these Plugins ship with COmanage, and are enabled by default. They can be found in the app/Plugin directory.

Supported Non-core Plugins

In addition, there are some Plugins that are less widely used. While they are shipped with COmanage, they are not enabled by default because of the related overhead (and, in some cases, external dependencies) associated with Plugins that may only be useful to some deployments. These plugins are also shipped with Registry and can be found in the app/AvailablePlugin directory.

The simplest way to enable a Non-Core Plugin (assuming you have met any external dependencies the Plugin may require) is to symlink it from your local/Plugin directory.

After creating the symlink, you should clear caches and then update your database schema to reflect the newly available plugin.

$ cd $REGISTRY/local/Plugin
$ ln -s ../../app/AvailablePlugin/SomePlugin .
$ cd $REGISTRY/app
$ su -c "./Console/clearcache" ${APACHE_USER}
$ su -c "./Console/cake database" ${APACHE_USER}

External Plugins

Plugins that come from other sources (including those you write yourself) should be placed in the local/Plugin directory.

Configuring & Using Plugins

Once a Plugin is installed and enabled for use, how it is actually used and/or configured varies according to the Plugin type.

Creating Your Own Plugins

Building your own plugin is a great was to get started with custom development for COmanage. Through plugins you can build powerful extensions to the existing Registry functionality. Building a Registry Plugin requires knowledge of PHP, CakePHP, and COmanage.

Start Here

The general documentation for building plugins can be found on the Writing Registry Plugins page. All plugins follow some standard conventions which are outlined on this page. In addition, some types have additional requirements as listed below.

Additional Requirements by Plugin Type

As described above, there are several different Plugin Types, each with their own additional requirements. You can find these details at the links below:

• Authenticator Plugins
• Cluster Plugins
• Dashboard Widget Plugins
• Data Filter Plugins
• Enrollment Flow Plugins
• Identifier Validation Plugins
• Invitation Confirmer Plugins
• Job Plugins
• LDAP Schema Plugins
• Normalization Plugins
• Organizational Identity Source Plugins
• Provisioner Plugins

Plugin Library

Below is a list of known plugins that are available to the COmanage Registry community. Please let us know if you know of other plugins that are not listed below. (Or, maybe you have created your own plugin that you want to share here!)