This documentation relates to an earlier version of Confluence.
View this page in the current documentation or visit the current documentation home.
Skip to end of metadata
Comment: Corrected links that should have been relative instead of absolute.
Go to start of metadata

This documentation applies to Confluence versions 2.0.x-2.5.4. The latest Confluence documentation is available via this link.


Getting Started With Plugins

This is a quick guide to getting off the ground when starting a new plugin for Confluence.

The Guide

Building and Deploying Confluence has been broken into a series of steps.
  1. Initial development environment setup
  2. Building and Deploying Confluence in IDEA
  3. Building and Deploying Plugins in IDEA
  4. Packaging and releasing a plugin

Extra Information

Confluence Internals

Confluence Plugin Guide

Customise Confluence Page Exports

Modify the style or content of the following page exports:

Remote API

Resources

The Confluence Confluence Developer FAQ

Page: How do I configure Confluence to use GMail as the mail server (Confluence 3.5)
Page: How do I disable RSS Feeds? (Confluence 3.5)
Page: How do I disable RSS Feeds? (Confluence 3.3)
Page: What class should my macro extend? (Confluence 3.0)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 3.0)
Page: How do I find the logged in user? (Confluence 3.0)
Page: How do I find Confluence Performance Tests? (Confluence 3.0)
Page: Encrypting error messages in Sybase (Confluence 3.0)
Page: Disable "Remember my login on this computer" (Confluence 3.0)
Page: How do I get my macro output exported to HTML and PDF? (Confluence 3.0)
Page: How Do I find enabled and disabled plugins in the Database? (Confluence 3.0)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 3.0)
Page: How do I display the Confluence System Classpath? (Confluence 3.0)
Page: How do I find information about lost attachments? (Confluence 2.8)
Page: How do I... find unused spaces (Confluence 2.8)
Page: I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.7)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.7)
Page: HTTP Response Code Definitions (Confluence 2.6)
Page: How does RENDERMODE work? (Confluence 2.5)
Page: How do I convert wiki text to HTML? (Confluence 2.5)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.5)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.5)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.5)
Page: How do I tell if a user has permission to...? (Confluence 2.5)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.5)
Page: How do I load a resource from a plugin? (Confluence 2.5)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.5)
Page: HTTP Response Code Definitions (Confluence 2.5)
Page: How do I find information about lost attachments? (Confluence 2.5)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 4.1)
Page: How do I convert wiki text to HTML? (Confluence 3.0)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 3.0)
Page: Disabling the 'Remember Me' feature (Confluence 3.5)
Page: How do I disable RSS Feeds? (Confluence 3.4)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.8)
Page: How do I... find unused spaces (Confluence 2.6)
Page: I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.5)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.5)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.5)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.5)
Page: How do I autowire a component? (Confluence 2.5)
Page: How do I get the location of the confluence.home directory? (Confluence 2.5)
Page: How do I get a reference to a component? (Confluence 2.5)
Page: What class should my XWork action plugin extend? (Confluence 2.5)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.5)
Page: How do I find information about lost attachments? (Confluence 3.0)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 3.0)
Page: How do I autowire a component? (Confluence 3.0)
Page: How do I get the location of the confluence.home directory? (Confluence 3.0)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 3.4)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 3.3)
Page: How do I use HTTPS for login only? (Confluence 3.3)
Page: How do I change the default polling time for email in Confluence? (Confluence 3.2)
Page: How do I change the default polling time for email in Confluence? (Confluence 4.0)
Page: What class should my macro extend? (Confluence 2.10)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.10)
Page: How do I find the logged in user? (Confluence 2.10)
Page: Encrypting error messages in Sybase (Confluence 2.10)
Page: Disable "Remember my login on this computer" (Confluence 2.10)
Page: How do I get my macro output exported to HTML and PDF? (Confluence 2.10)
Page: How Do I find enabled and disabled plugins in the Database? (Confluence 2.10)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.10)
Page: How do I display the Confluence System Classpath? (Confluence 2.10)
Page: What class should my macro extend? (Confluence 2.7)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.7)
Page: How do I find the logged in user? (Confluence 2.7)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.7)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.7)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.7)
Page: How do I autowire a component? (Confluence 2.7)
Page: How do I get the location of the confluence.home directory? (Confluence 2.7)
Page: How do I get a reference to a component? (Confluence 2.7)
Page: What class should my XWork action plugin extend? (Confluence 2.7)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.7)
Page: How does RENDERMODE work? (Confluence 2.7)
Page: How do I convert wiki text to HTML? (Confluence 2.7)
Page: How do I find information about lost attachments? (Confluence 2.5.6)
Page: How do I load a resource from a plugin? (Confluence 3.0)
Page: HTTP Response Code Definitions (Confluence 3.0)
Page: What class should my macro extend? (Confluence 2.6)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.6)
Page: How do I find the logged in user? (Confluence 2.6)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.6)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.6)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.5.6)
Page: What class should my macro extend? (Confluence 2.5.6)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.5.6)
Page: How do I find the logged in user? (Confluence 2.5.6)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.5.6)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.5.6)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.10)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.10)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.10)
Page: How do I autowire a component? (Confluence 2.10)
Page: How do I get the location of the confluence.home directory? (Confluence 2.10)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.10)
Page: How do I get a reference to a component? (Confluence 2.10)
Page: What class should my XWork action plugin extend? (Confluence 2.10)
Page: Enabling Developer Mode (Confluence 2.10)
Page: How does RENDERMODE work? (Confluence 2.10)
Page: How do I convert wiki text to HTML? (Confluence 2.10)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.8)
Page: How do I get the location of the confluence.home directory? (Confluence 2.8)
Page: How do I load a resource from a plugin? (Confluence 2.8)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.8)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.8)
Page: How do I tell if a user has permission to...? (Confluence 2.8)
Page: How do I use HTTPS for login only? (Confluence 2.8)
Page: HTTP Response Code Definitions (Confluence 2.8)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.8)
Page: What class should my XWork action plugin extend? (Confluence 2.8)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.8)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.8)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.7)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.7)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.7)
Page: How do I tell if a user has permission to...? (Confluence 2.7)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.7)
Page: How do I load a resource from a plugin? (Confluence 2.7)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.7)
Page: HTTP Response Code Definitions (Confluence 2.7)
Page: Disabling the 'Remember Me' feature (Confluence 4.1)
Page: How do I... find unused spaces (Confluence 3.0)
Page: How do I disable RSS Feeds? (Confluence 3.0)
Page: How do I use HTTPS for login only? (Confluence 3.0)
Page: Disable Velocity Caching (Confluence 3.0)
Page: How do I make my attachments open in a new window or a tab? (Confluence 3.0)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 3.0)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 3.0)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 3.0)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 3.0)
Page: How do I get hold of the HttpServletRequest? (Confluence 3.0)
Page: Disabling the 'Remember Me' feature (Confluence 3.4)
Page: How do I change the default polling time for email in Confluence? (Confluence 3.1)
Page: How do I check which Jar file a class file belong to? (Confluence 3.0)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.10)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.10)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.10)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.10)
Page: How do I tell if a user has permission to...? (Confluence 2.10)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.10)
Page: What is Bandana? One form of Confluence Persistence (Confluence 2.10)
Page: How do I load a resource from a plugin? (Confluence 2.10)
Page: HTTP Response Code Definitions (Confluence 2.10)
Page: How do I use HTTPS for login only? (Confluence 2.10)
Page: Disable Velocity Caching (Confluence 2.10)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.10)
Page: How do I find information about lost attachments? (Confluence 2.10)
Page: How do I... find unused spaces (Confluence 2.10)
Page: How do I disable RSS Feeds? (Confluence 2.10)
Page: How do I... find unused spaces (Confluence 2.9)
Page: How do I disable RSS Feeds? (Confluence 2.9)
Page: I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.5.6)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.5.6)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.5.6)
Page: How do I autowire a component? (Confluence 2.5.6)
Page: How do I get the location of the confluence.home directory? (Confluence 2.5.6)
Page: How do I get a reference to a component? (Confluence 2.5.6)
Page: What class should my XWork action plugin extend? (Confluence 2.5.6)
Page: How do I change the default polling time for email in Confluence? (Confluence 3.4)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 4.0)
Page: Disabling the 'Remember Me' feature (Confluence 4.0)
Page: How do I disable RSS Feeds? (Confluence 4.0)
Page: How Do I find enabled and disabled plugins in the Database? (Confluence 2.9)
Page: How do I display the Confluence System Classpath? (Confluence 2.9)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.8)
Page: How do I display the Confluence System Classpath? (Confluence 2.8)
Page: How Do I find enabled and disabled plugins in the Database? (Confluence 2.8)
Page: How do I find the logged in user? (Confluence 2.8)
Page: What class should my macro extend? (Confluence 2.8)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.8)
Page: How do I find the logged in user? (Confluence 2.5)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.5)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.5)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.9)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.9)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.9)
Page: How do I autowire a component? (Confluence 2.9)
Page: How do I get the location of the confluence.home directory? (Confluence 2.9)
Page: How does RENDERMODE work? (Confluence 2.8)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.8)
Page: How do I autowire a component? (Confluence 2.8)
Page: How do I convert wiki text to HTML? (Confluence 2.8)
Page: How do I get a reference to a component? (Confluence 2.8)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.8)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.8)
Page: How do I find information about lost attachments? (Confluence 2.6)
Page: What class should my macro extend? (Confluence 2.9)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.9)
Page: How do I find the logged in user? (Confluence 2.9)
Page: How do I change the default polling time for email in Confluence? (Confluence 2.9)
Page: Encrypting error messages in Sybase (Confluence 2.9)
Page: How do I configure Confluence to use GMail as the mail server (Confluence 2.9)
Page: Disable "Remember my login on this computer" (Confluence 2.9)
Page: How do I get my macro output exported to HTML and PDF? (Confluence 2.9)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.9)
Page: How do I get a reference to a component? (Confluence 2.9)
Page: What class should my XWork action plugin extend? (Confluence 2.9)
Page: Enabling Developer Mode (Confluence 2.9)
Page: How does RENDERMODE work? (Confluence 2.9)
Page: How do I convert wiki text to HTML? (Confluence 2.9)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.9)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.9)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.9)
Page: How do I tell if a user has permission to...? (Confluence 2.9)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.9)
Page: What is Bandana? One form of Confluence Persistence (Confluence 2.9)
Page: How do I load a resource from a plugin? (Confluence 2.9)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.9)
Page: HTTP Response Code Definitions (Confluence 2.9)
Page: How do I use HTTPS for login only? (Confluence 2.9)
Page: Disable Velocity Caching (Confluence 2.9)
Page: How do I disable RSS Feeds? (Confluence 4.1)
Page: I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.6)
Page: How do I associate my own properties with a ContentEntityObject? (Confluence 2.6)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.6)
Page: How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.6)
Page: How do I autowire a component? (Confluence 2.6)
Page: How do I get the location of the confluence.home directory? (Confluence 2.6)
Page: How do I get a reference to a component? (Confluence 2.6)
Page: What class should my XWork action plugin extend? (Confluence 2.6)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.6)
Page: How does RENDERMODE work? (Confluence 2.6)
Page: How do I convert wiki text to HTML? (Confluence 2.6)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.6)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.6)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.6)
Page: How do I tell if a user has permission to...? (Confluence 2.6)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.6)
Page: How do I load a resource from a plugin? (Confluence 2.6)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.6)
Page: What's the easiest way to render a velocity template from Java code? (Confluence 2.5.6)
Page: How does RENDERMODE work? (Confluence 2.5.6)
Page: How do I convert wiki text to HTML? (Confluence 2.5.6)
Page: How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.5.6)
Page: How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.5.6)
Page: I am trying to compile a plugin, but get an error about the target release (Confluence 2.5.6)
Page: How do I tell if a user has permission to...? (Confluence 2.5.6)
Page: What is the best way to load a class or resource from a plugin? (Confluence 2.5.6)
Page: How do I load a resource from a plugin? (Confluence 2.5.6)
Page: How do I make my attachments open in a new window or a tab? (Confluence 2.5.6)
Page: HTTP Response Code Definitions (Confluence 2.5.6)
Page: How do I get a reference to a component? (Confluence 3.0)
Page: What class should my XWork action plugin extend? (Confluence 3.0)
Page: Enabling Developer Mode (Confluence 3.0)
Page: How does RENDERMODE work? (Confluence 3.0)
Page: How do I change the default polling time for email in Confluence? (Confluence 3.3)
Page: Disable "Remember my login on this computer" (Confluence 3.3)
Page: How do I change the default polling time for email in Confluence? (Confluence 3.0)
Page: How do I find information about lost attachments? (Confluence 2.9)
Page: What class should my macro extend? (Confluence 2.5)
Page: Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.5)
Page: How do I find information about lost attachments? (Confluence 2.7)
Page: How do I... find unused spaces (Confluence 2.7)
Page: How do I get hold of the HttpServletRequest? (Confluence 2.7)
Page: How do I change the default polling time for email in Confluence? (Confluence 4.1)
Page: How do I change the default polling time for email in Confluence? (Confluence 3.5)
Page: How do I find Confluence Test Suite? (Confluence 3.0)
Page: How do I tell if a user has permission to...? (Confluence 3.0)
Page: What is the best way to load a class or resource from a plugin? (Confluence 3.0)
Page: What is Bandana? One form of Confluence Persistence (Confluence 3.0)