Confluence Development Hub

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.

Initial development environment setup
Building and Deploying Confluence in IDEA
- Setup Confluence Source Code For Development
- Creating an IDEA project with a Confluence distribution
Building and Deploying Plugins in IDEA
- Setting up a new Confluence plugin
- Working on an existing Confluence plugin
Packaging and releasing a plugin

Extra Information

Confluence Internals

Confluence Plugin Guide

Installing and Configuring Plugins manually
Installing and Configuring Plugins using the Plugin Repository
Installing plugins overview
Single Sign-on
Writing Confluence Plugins
- Accessing Confluence Components From Plugin Modules
- Confluence Plugin Module Types
  - Code Formatting Plugins — Code formatting plugin modules allow you to add new languages to the {code} macro.
  - Component Plugins
  - Downloadable Plugin Resources
  - Event Listener Plugins
  - Extractor Plugins — Extractor plugins allow you to hook into the mechanism by which Confluence populates its search index.
  - Job Plugins
  - Language Pack Plugins
  - Lifecycle Plugins — Lifecycle plugins allow you to perform tasks on application startup and shutdown
  - Macro Plugins
  - RPC Plugins
  - Servlet Plugins
  - Spring Component Plugins
  - StateAware
  - Theme Plugins
  - Trigger Plugins
  - User Macro Plugins
  - Velocity Context Plugins
  - Web UI Plugins — Web UI plugin modules allow you to insert links, tabs and sections of links into the Confluence web interface
  - Workflow Plugins
  - XWork-WebWork Plugins
- Plugin Self-Configuration

Customise Confluence Page Exports

Modify the style or content of the following page exports:

Remote API

Remote API Specification

Resources

The Confluence Confluence Developer FAQ

How do I associate my own properties with a ContentEntityObject? (Confluence 2.7)

How do I associate my own properties with a ContentEntityObject? (Confluence 2.6)

How do I associate my own properties with a ContentEntityObject? (Confluence 2.5.6)

How do I associate my own properties with a ContentEntityObject? (Confluence 2.5)

How do I associate my own properties with a ContentEntityObject? (Confluence 2.8)

How do I autowire a component? (Confluence 2.7)

How do I autowire a component? (Confluence 2.6)

How do I autowire a component? (Confluence 2.5.6)

How do I autowire a component? (Confluence 2.5)

How do I autowire a component? (Confluence 2.8)

How do I change the default polling time for email in Confluence? (Confluence 2.7)

How do I change the default polling time for email in Confluence? (Confluence 2.6)

How do I change the default polling time for email in Confluence? (Confluence 2.5.6)

How do I change the default polling time for email in Confluence? (Confluence 2.5)

How do I change the default polling time for email in Confluence? (Confluence 2.8)

How do I configure Confluence to use GMail as the mail server (Confluence 2.7)

How do I configure Confluence to use GMail as the mail server (Confluence 2.6)

How do I configure Confluence to use GMail as the mail server (Confluence 2.5.6)

How do I configure Confluence to use GMail as the mail server (Confluence 2.5)

How do I configure Confluence to use GMail as the mail server (Confluence 2.8)

How do I convert wiki text to HTML? (Confluence 2.7)

How do I convert wiki text to HTML? (Confluence 2.6)

How do I convert wiki text to HTML? (Confluence 2.5.6)

How do I convert wiki text to HTML? (Confluence 2.5)

How do I convert wiki text to HTML? (Confluence 2.8)

How Do I find enabled and disabled plugins in the Database? (Confluence 2.8)

How do I find information about lost attachments? (Confluence 2.7)

How do I find information about lost attachments? (Confluence 2.6)

How do I find information about lost attachments? (Confluence 2.5.6)

How do I find information about lost attachments? (Confluence 2.5)

How do I find information about lost attachments? (Confluence 2.8)

How do I find the logged in user? (Confluence 2.7)

How do I find the logged in user? (Confluence 2.6)

How do I find the logged in user? (Confluence 2.5.6)

How do I find the logged in user? (Confluence 2.5)

How do I find the logged in user? (Confluence 2.8)

How do I get a reference to a component? (Confluence 2.7)

How do I get a reference to a component? (Confluence 2.6)

How do I get a reference to a component? (Confluence 2.5.6)

How do I get a reference to a component? (Confluence 2.5)

How do I get a reference to a component? (Confluence 2.8)

How do I get hold of the HttpServletRequest? (Confluence 2.7)

How do I get hold of the HttpServletRequest? (Confluence 2.6)

How do I get hold of the HttpServletRequest? (Confluence 2.5.6)

How do I get hold of the HttpServletRequest? (Confluence 2.5)

How do I get hold of the HttpServletRequest? (Confluence 2.8)

How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.7)

How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.6)

How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.5.6)

How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.5)

How do I get the base URL and ContextPath of a Confluence installation? (Confluence 2.8)

How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.7)

How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.6)

How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.5.6)

How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.5)

How do I get the information about Confluence such as version number, build number, build date? (Confluence 2.8)

How do I get the location of the confluence.home directory? (Confluence 2.7)

How do I get the location of the confluence.home directory? (Confluence 2.6)

How do I get the location of the confluence.home directory? (Confluence 2.5.6)

How do I get the location of the confluence.home directory? (Confluence 2.5)

How do I get the location of the confluence.home directory? (Confluence 2.8)

How do I load a resource from a plugin? (Confluence 2.7)

How do I load a resource from a plugin? (Confluence 2.6)

How do I load a resource from a plugin? (Confluence 2.5.6)

How do I load a resource from a plugin? (Confluence 2.5)

How do I load a resource from a plugin? (Confluence 2.8)

How do I make my attachments open in a new window or a tab? (Confluence 2.7)

How do I make my attachments open in a new window or a tab? (Confluence 2.6)

How do I make my attachments open in a new window or a tab? (Confluence 2.5.6)

How do I make my attachments open in a new window or a tab? (Confluence 2.5)

How do I make my attachments open in a new window or a tab? (Confluence 2.8)

How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.7)

How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.6)

How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.5.6)

How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.5)

How do I prevent my rendered wiki text from being surrounded by paragraph tags? (Confluence 2.8)

How do I tell if a user has permission to...? (Confluence 2.7)

How do I tell if a user has permission to...? (Confluence 2.6)

How do I tell if a user has permission to...? (Confluence 2.5.6)

How do I tell if a user has permission to...? (Confluence 2.5)

How do I tell if a user has permission to...? (Confluence 2.8)

How do I use HTTPS for login only? (Confluence 2.8)

How do I... find unused spaces (Confluence 2.7)

How do I... find unused spaces (Confluence 2.6)

How do I... find unused spaces (Confluence 2.8)

How does RENDERMODE work? (Confluence 2.7)

How does RENDERMODE work? (Confluence 2.6)

How does RENDERMODE work? (Confluence 2.5.6)

How does RENDERMODE work? (Confluence 2.5)

How does RENDERMODE work? (Confluence 2.8)

HTTP Response Code Definitions (Confluence 2.7)

HTTP Response Code Definitions (Confluence 2.6)

HTTP Response Code Definitions (Confluence 2.5.6)

HTTP Response Code Definitions (Confluence 2.5)

HTTP Response Code Definitions (Confluence 2.8)

I am trying to compile a plugin, but get an error about the target release (Confluence 2.7)

I am trying to compile a plugin, but get an error about the target release (Confluence 2.6)

I am trying to compile a plugin, but get an error about the target release (Confluence 2.5.6)

I am trying to compile a plugin, but get an error about the target release (Confluence 2.5)

I am trying to compile a plugin, but get an error about the target release (Confluence 2.8)

I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.7)

I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.6)

I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.5.6)

I have checked out the source, and use IntelliJ IDEA. Where do I go from here? (Confluence 2.5)

What class should my macro extend? (Confluence 2.7)

What class should my macro extend? (Confluence 2.6)

What class should my macro extend? (Confluence 2.5.6)

What class should my macro extend? (Confluence 2.5)

What class should my macro extend? (Confluence 2.8)

What class should my XWork action plugin extend? (Confluence 2.7)

What class should my XWork action plugin extend? (Confluence 2.6)

What class should my XWork action plugin extend? (Confluence 2.5.6)

What class should my XWork action plugin extend? (Confluence 2.5)

What class should my XWork action plugin extend? (Confluence 2.8)

What is the best way to load a class or resource from a plugin? (Confluence 2.7)

What is the best way to load a class or resource from a plugin? (Confluence 2.6)

What is the best way to load a class or resource from a plugin? (Confluence 2.5.6)

What is the best way to load a class or resource from a plugin? (Confluence 2.5)

What is the best way to load a class or resource from a plugin? (Confluence 2.8)

What's the easiest way to render a velocity template from Java code? (Confluence 2.7)

What's the easiest way to render a velocity template from Java code? (Confluence 2.6)

What's the easiest way to render a velocity template from Java code? (Confluence 2.5.6)

What's the easiest way to render a velocity template from Java code? (Confluence 2.5)

What's the easiest way to render a velocity template from Java code? (Confluence 2.8)

Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.7)

Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.6)

Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.5.6)

Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.5)

Within a Confluence macro, how do I retrieve the current ContentEntityObject? (Confluence 2.8)