 | Plugin configuration is available in Confluence 2.2 and later. Versions of Confluence before 2.1 will simply ignore any of these parameters |
Plugins can specify internal links within Confluence to configure themselves. This is useful where your plugin requires any configuration or user specific settings to work. For example, the Google Maps plugin requires a Google API Key from Google (which needs to be configured on each server) before it will work properly.
- Configuration links will most often point to XWork plugin modules within the plugin itself
- Configuration links can be provided for a whole plugin and/or for any module within a plugin
- Configuration links are relative to the Confluence application
Plugin configuration - to add a configuration link for the whole plugin, place a single param element with the name configure.url within the plugin-info element at the top of the plugin descriptor:
Plugin module configuration - to add a configuration link for a single module, place the same param element with the name configure.url within the descriptor element for that module:
Here is an image showing where the Configure links appear for both a plugin and an individual module:
