Developer guides

This page contains a list of all developer guides for Confluence Server and Data Center. Some of these guides are out of date, or only apply to legacy versions of Confluence, but may still contain some useful context.

Can't find what you need? Ask the Atlassian developer community.

Reference documentation

Alphabetical list of developer guides

Accessing Confluence Components from Plugin Modules
Adapting a theme for Confluence 5.0 (Legacy)
Adding a Configuration UI for your Plugin
Adding a custom action to Confluence
Add a field to CQL
Adding a Theme icon
Adding an option to the editor insert menu (Legacy)
Adding Confluence keyboard shortcuts
Adding Feature Discovery to your plugin
Adding items to the info banner
Adding menu Items to Confluence (Legacy)
Adding new Confluence to HipChat notifications (Legacy)
Adding Plugin and Module Resources
Adding space shortcut links
Advanced HTML encoding
Advanced Searching using CQL
Anti-XSS documentation
Atlassian Cache 2 overview
Attachment Content Extractor Plugins (Legacy)
Babel Polyfill in Confluence Server
Bandana caching
Building Confluence from source code (Legacy)
Collaborative editing for Confluence Server
Confluence architecture
Confluence blueprints
Confluence bootstrap process
Caching architecture
Confluence Data Center Plugin Validator
Confluence internals
Confluence Journal Service
Confluence Macro Manager
Confluence OAuth 2.0 provider API
Confluence objects accessible from Velocity
Confluence permissions architecture
Confluence services
Confluence Test data for Plugin Developers (Legacy)
Confluence UI architecture (Legacy)
Confluence UI guidelines
Confluence User Macro guide
Converting a Plugin to Plugin Framework 2 (Legacy)
Create a new custom index and interact with it using a custom SearchIndexAccessor
Create a search decorator
Create a search extractor
Creating a new Confluence Translation (Legacy)
Creating a Stylesheet Theme
Creating a Theme
Creating a Wikipedia macro (Legacy)
Creating an admin task (Legacy)
Create an attachment text extractor
Creating your Plugin Descriptor
Custom actions with the blueprint API
Custom user directories in Confluence (Legacy)
Customising the display of macro parameters in the editor placeholder (Legacy)
Date formatting with time zones (Legacy)
Defining a pluggable service in a Confluence plugin
Deprecation guidelines
Disable Velocity caching
DTDs and schemas (Legacy)
Dynamically migrate macro parameters
Enable XSRF protection in your app
Enable XSS protection in your app
Enabling developer mode
Enabling TinyMCE plugins (Legacy)
Exception handling guidelines
Extending autoconvert (Legacy)
Extending the Confluence insert link dialog (Legacy)
Extending the highlight actions panel (Legacy)
Extending the image properties dialog (Legacy)
Extending the macro property panel (Legacy)
Extending the v2 search API (Legacy)
Form Token handling (Legacy)
Generating JSON output in Confluence with Jsonator
Hibernate session and transaction management for bulk operations
Hibernate sessions and transaction management guidelines
High level architecture overview
How to index and search with a SearchIndexAccessor
How to make your plugin compatible with mobile app
How to switch to non-minified JavaScript for debugging
HTML to markup conversion for the rich text editor (Legacy)
HTTP authentication with Seraph
HTTP response code definitions
I18N architecture
Icons
Including information in your macro for the Macro Browser (Legacy)
Including Javascript and CSS resources (Legacy)
Instruction text in blueprints
Internationalising Confluence plugins (Legacy)
Javadoc standards
JavaScript API for blueprint wizards (Legacy)
JavaScript components (Legacy)
Logging guidelines
Maintaining web resources during ADG rollout (Legacy)
Make REST API endpoints available for JWT authentication
Make your add-on compatible with read-only mode
Making your macro render in Confluence mobile
Making your Plugin Modules State Aware (Legacy)
Migrating to Atlassian Plugin Framework 3 (Legacy)
Packages available to OSGi plugins
Packaging and installing a theme plugin
Page tree API documentation (Legacy)
Password hash algorithm
Performing text searches using CQL
Persistence in Confluence
Plugin cookbook
Plugin points for the editor in 4.0 (Legacy)
Plugin resources
Polyfills in Confluence Server
Posting notifications in Confluence (Legacy)
Providing an image as a macro placeholder in the editor (Legacy)
Renamable users in Confluence 5.2 (Legacy)
Rendering Velocity templates in a macro (Legacy)
Saving Theme Configurations with Bandana
Searching using the v2 search API
Secure your macro
Sending emails in a plugin (Legacy)
Space Blueprints
Spring IoC in Confluence
Spring usage guidelines
Starting a Confluence cluster on a single machine
Templating in JavaScript with Soy (Legacy)
Theme Configuration (Legacy)
Translating ConfluenceActionSupport content
Translations for the Rich Text Editor (Legacy)
Troubleshooting macros in the page gadget (Legacy)
Unit testing plugins (Legacy)
Updating a Confluence Translation (Legacy)
Updating a theme for editable comments (Legacy)
Upgrading and migrating an existing Confluence macro to 4.0 (Legacy)
Using Standard Page Decorators
Using the v2 Search API
Velocity template overview
Webhooks
Workaround pattern for autowiring jobs (Legacy)
Workflow Plugin Prototype (Legacy)
Write a simple Confluence blueprint plugin
Write a simple Confluence Space blueprint
Write an advanced blueprint plugin
Write an intermediate blueprint plugin
Writing a Confluence theme
Writing a macro using JSON (Legacy)
Writing a mixed Space screen (Legacy)
Writing a plugin upgrade task to migrate user data to new user keys (Legacy)
Writing a Space Admin screen
Writing an Event Listener plugin module (Legacy)
Writing an space index page for a content type (Legacy)
Writing Confluence plugins
Writing Macros (Legacy)
Writing macros for pre-4.0 versions of Confluence (Legacy)
Writing Soy templates in your plugin (Legacy)
XWork Plugin Complex Parameters and Security