How to edit bundled or system plugins
Platform Notice: Data Center - This article applies to Atlassian products on the Data Center platform.
Note that this knowledge base article was created for the Data Center version of the product. Data Center knowledge base articles for non-Data Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Purpose
In rare cases, although not advisable, some users need to edit the contents of the bundled plugin in Confluence. The guide below is an example to find and edit a bundled/system plugin
Solution
Customizing the Contents of Bundled Plugin
Please note that this will only work if the bundled plugin has not been upgraded
Backup
atlassian-bundled-plugins folder in <confluence-install>/confluence/WEB-INF/. This folder contains all of the Confluence bundled plugins.- Locate the JAR file of the bundled plugin and unjar the
plugin-name-X.X.X.X.jarin the folderatlassian-bundled-plugins. Once unjarred, edit the necessary files and save the edited files
- Jar the file back to
plugin-name-X.X.X.X.jar. Please refer to How to edit files in Confluence JAR files for more information - Restart your Confluence. Your changes would be reflected after this.
Customizing the Contents of Upgraded Bundled Plugin
If the bundled plugin has been upgraded, please do the following instead:
- Downgrade the bundled plugin by uninstalling it from the Confluence Admin > Managed Add-ons under the User Installed Plugins section
- Download the plugin JAR manually from the Atlassian Marketplace
- Unjar the plugin, edit the necessary files, save the edited files, and jar it back
- Backup
atlassian-bundled-plugins folder in <confluence-install>/confluence/WEB-INF/ - Delete the old plugin JAR file
- Insert the new plugin JAR file
- Upload the new plugin JAR file into Confluence
Customizing the Contents of Bundled Plugin
Please note that this will only work if the bundled plugin has not been upgraded
Backup
atlassian-bundled-plugins.zip in <confluence-install>/confluence/WEB-INF/classes/com/atlassian/confluence/setup/. This zip file contains all of the Confluence bundled plugins.- Unzip the
atlassian-bundled-plugins.zip. - Locate the JAR file of the bundled plugin and unjar the
plugin-name-X.X.X.X.jarin the unzippedatlassian-bundled-plugins.zip. Once unjarred, edit the necessary files and save the edited files
- Jar the file back to
plugin-name-X.X.X.X.jar. Please refer to How to edit files in Confluence JAR files for more information - Zip the
atlassian-bundled-plugins.zipback. - Restart your Confluence. Your changes would be reflected after this.
Customizing the Contents of Upgraded Bundled Plugin
If the bundled plugin has been upgraded, please do the following instead:
- Downgrade the bundled plugin by uninstalling it from the Confluence Admin > Plugins under the User Installed Plugins section
- Download the plugin JAR manually from the Atlassian Marketplace
- Unjar the plugin, edit the necessary files, save the edited files, and jar it back
- Backup
atlassian-bundled-plugins.zip in <confluence-install>/confluence/WEB-INF/classes/com/atlassian/confluence/setup/ - Unzip the
atlassian-bundled-plugins.zip. - Delete the old plugin JAR file
- Insert the new plugin JAR file
- Zip the
atlassian-bundled-plugins.zipback. - Restart your Confluence. Your changes will be reflected after this.