This page last changed on Mar 05, 2007 by jnolen.
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-info>
    <description>A macro which displays Google maps within a Confluence page.</description>
    <vendor name="Atlassian Software Systems Pty Ltd" url="http://www.atlassian.com/"/>
    <version>0.1</version>
    <param name="configure.url">/admin/plugins/gmaps/configurePlugin.action</param>
</plugin-info>

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:

<macro name="gmap" class="com.atlassian.confluence.ext.gmaps.GmapsMacro" key="gmap">
    <description>The individual map macro.</description>
    <param name="configure.url">/admin/plugins/gmaps/configureMacro.action</param>
</macro>

Here is an image showing where the Configure links appear for both a plugin and an individual module:


Document generated by Confluence on Mar 22, 2007 21:00