This documentation relates to the latest version of Confluence.
If you are using an earlier version, please go to the documentation home page and select the relevant version.

Confluence Plugin Guide

All Versions

Confluence 3.0 Documentation
Looking for existing plugins? See the existing plugins and extensions written by the community in the Confluence Extensions space.

Confluence's plugin system allows users and developers to customise and extend Confluence.

A plugin is a bundle of code, resources and a special configuration file that can be dropped into a Confluence server to add new functionality, or change the behaviour of existing features.

  • Administrators can drop plugins into their Confluence server to add new functionality to the system.
  • Developers can write plugins for their own Confluence server, or share plugins with other Confluence users.

Some parts of Confluence are implemented entirely as plugins — for example, all macros in Confluence 1.3 and later are written as plugins, even those included with the system.

Where are plugins stored

Category Storage
Manually installed database
Installed via repository database
Bundled plugins conf-home
System plugins WEB-INF/lib

For example, the System plugins LeftNav theme plugin or the Clickr plugin will store data in WEB-INF/lib. Similarly for advanced-formatting macros.

Where are plugins run-time data stored

There is no distinct requirement where actual plugin's run-time data is stored. It is depended on the particular implementation of each plugin. The most common storage location would be: database, BANDANA, conf-home or other.

Plugins and Plugin Modules

Every plugin is made up of one or more plugin modules. A single plugin may do many things, while a plugin module represents a single function of the plugin.

For example, a theme plugin will consist of a colour-scheme module to define the theme's colours, a number of layout modules to define the site's page layouts, and a theme module to combine those pieces together into a single theme.

Some plugins, such as the macro packs that come with Confluence, are just a collection of unrelated modules that just happen to be packaged together. Other plugins, such as theme plugins, have modules that work together to provide some orchestrated functionality.

Contents of the Confluence Plugin Guide

RELATED TOPICS

Internationalising Confluence Plugins

Labels

plugins plugins Delete
plugin-management plugin-management Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Mar 18

    Michael Vescovo says:

    Hi. Is it possible to restrict who can use a particular plugin?

    Hi. Is it possible to restrict who can use a particular plugin?

    1. Mar 23

      Arie Murdianto says:

      Hi, I am sorry the mentioned feature is not available. I think it would be bett...

      Hi,

      I am sorry the mentioned feature is not available. I think it would be better to raise this feature request to Atlassian's JIRA as there maybe another customer wants to have the same feature as yours:

      Cheers,

  2. Apr 03

    Michael Masterson says:

    I got to this page from the Installed Plugins area on the site I admin by clicki...

    I got to this page from the Installed Plugins area on the site I admin by clicking "More about plugins." I was trying to learn more about how plugins work, from a site admin point of view, cause my first try with installing a plugin is giving me an error. But this page seems to be aimed at plugin developers, so I thought I'd mention what explanations seems missing for someone starting with plugins. I hope this is helpful.

    Repository vs. installed vs. loaded vs. enabled.
    Repository vs. Confluence extensions space.
    Basic general outline of steps for installing and using a plugin (browse, choose, install, config, test, whatever, etc.) and where one goes for each.
    What to do when an error occurs on first installation (ticket with Confluence? go to developer?...)
    Where do the four Categories in the chart come from/what do they mean?
    What is meant by each of the Storage locations? (what is database? are those folders on the server? etc.)

    1. Apr 06

      Azwandi Mohd Aris says:

      Hello Michael, Thank you for letting us know your concern. I believe that part ...

      Hello Michael,

      Thank you for letting us know your concern. I believe that part of your questions can be answered by this page and its children. Meanwhile, I have created a task for our technical writer to review this issue.

      Cheers,
      Azwandi

      1. Apr 13

        Michael Masterson says:

        Azwandi, Thanks for the page, that's helpful. Michael

        Azwandi,

        Thanks for the page, that's helpful.

        Michael

  3. Jun 15

    Anonymous says:

    I have an account on a confluence wiki. I am not an admin user. Is there a way f...

    I have an account on a confluence wiki.
    I am not an admin user.
    Is there a way for me to determine what plugins/extensions have been installed ?
    This is possible in some other wiki engines (e.g., MediaWiki)
    Thanks.

    1. Jun 17

      Zed Yap [Atlassian] says:

      Hi, As far as I know, you can try the 500page.jsp. The generic 500page, can be ...

      Hi,

      As far as I know, you can try the 500page.jsp. The generic 500page, can be accessed by entering http://<path-to-confluence>/500page.jsp in the web browser's URL address bar
      Note: please replace the <path-to-confluence> with the URL address to your Confluence (e.g http://localhost:8080/500page.jsp).

      Hope that helps.
      Best rgds,
      Zed

  4. Jun 30

    eddie connatser says:

    Is there a way to force changes to a bundled plugin after Confluence has restart...

    Is there a way to force changes to a bundled plugin after Confluence has restarted?  I have made changes to the confluence-advanced-macros-1.6.2.6.jar file.  After making the changes and repackaging the jar, I put the jar back into the /bundled-plugins/ directory and saw that my new jar had successfully copied to this directory.  I then restarted Confluence so my changes would take place.  When I navigated back to the /bundled-plugins/ directory, the old confluence-advanced-macros-1.2.6.2.jar file had been restored and my test directories I had used to modify this jar file were deleted.  In other words, restarting confluence restored the /bundled-plugins/ to their originial state, hence erasing any changes I made.  I figure there is some type of boot configuration I have to change?  Thanks in advance!

    Eddie

    1. Jul 01

      Arie Murdianto says:

      Hi Eddie, Every time Confluence is restarted, Confluence will restore bundled p...

      Hi Eddie,

      Every time Confluence is restarted, Confluence will restore bundled plugins from atlassian-bundled-plugins.zip and all the plugins stored in <Confluence home>/bundled-plugins will be replaced. So that your change can take effect, you need to change the jar file inside atlassian-bundled-plugins.zip with the modified plugin.

      I hope that my explanation is clear.

      Cheers,

Add Comment


Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.