Are you looking to include files from public or private repositories on Gitlab? - Try out Include GitLab for Confluence

CONFLUENCE Data Center / Server

Visually render your technical diagrams in Confluence, without the hassle of using a visual editor

Check next section.

Render PlantUML diagrams in Confluence based on versioned files in your private Bitbucket repository

By combining Include Bitbucket for Confluence app with PlantUML for Confluence app,
you can have your PlantUML diagrams definitions versioned in your private repository and still enjoy them rendered on your Confluence page.
To get that:

  1. use the PlantUML Render macro and within this macro,

  2. use the Bitbucket file macro with option Hide File Header checked

to include the PlantUML file from your repository.

For more details, please check documentation of PlantUML Render macro.

Can you Include files from a Bitbucket Cloud repo into Confluence Data Center/Server?

Yes, our Confluence DC/Server app Include Bitbucket for Confluence does support Bitbucket Cloud, see how to configure it here.

Problem when enabling Include Bitbucket for Confluence app after update to 2.0.3 or newer

If Include Bitbucket for Confluence app fails to be enabled after an update, but producing similar error in the log:

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'markupParsers': Cannot create inner bean '(inner bean)#67aa14d9' of type [org.eclipse.gemini.blueprint.config.internal.adapter.OsgiServiceLifecycleListenerAdapter] while setting bean property 'listeners' with key [0]; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name '(inner bean)#67aa14d9': Invocation of init method failed; nested exception is java.lang.IllegalArgumentException: Custom bind method [addParser] not found on class class com.sun.proxy.$Proxy3483 ...


  1. Uninstall Include Bitbucket for Confluence app

  2. Restart Confluence

  3. Install version 2.0.3 or newer of Include Bitbucket for Confluence.

  4. Enabling Include Bitbucket for Confluence app should work now.

    1. Please let us know, if this workaround does not work for you. Thanks.

A programming language is missing from the list of syntax options in the macro's editor

Starting from version 1.14.0 of our app, custom brushes for additional languages are not supported anymore due to technical problems in combination with other apps not provided by us.

We support custom syntax highlighting languages in the app, up to version 1.13.5.

You can add support for custom programming languages in the Confluence admin area:

General configuration -> Configure Code Macro -> Add a new language

You need a so called "brush" file for your new programming language. See this page about the format of these files and where you can find existing brushes.

After you have done this, you should be able to see your new programming language in the list of supported programming languages in the plug-in's macro configuration dialog.

Confluence New Code plug-in not found

This error indicates that the app cannot find the Confluence Code Viewer. The Code Viewer is shipped with Confluence in the ‘Code Macro Plugin’ and enabled by default. If you see the error message above, for some reason it isn’t enabled.

Please check and enable the Code Macro Plugin:

  1. Go to the ‘Manager add-ons’ in the Confluence admin: ‘Gear-Icon'->Add-ons

  2. Select ‘All Add-ons’ in the drop down menu

  3. Search for the ‘Code Macro Plugin’

  4. Expand it, check the Add-on key, it should be ‘com.atlassian.confluence.ext.newcode-macro-plugin’

  5. If the ‘Code Macro Plugin’ Add-on is disabled, you have to enable it in order to make Bitbucket for Confluence work

  6. If the ‘Code Macro Plugin’ is missing or has another add-on key as listed above, please let us know and tell us the Confluence version  

Binary files are rendered in plain text and it is not what is expected

As of the v2.3.0 release, you may have noticed a difference in behaviour. If you ever edited a macro for a binary file and set it to 'Plain Text', we will now render it as such after this release. If you want to change this then the user has to manually unselect the Plain Text option.

Editing pages is no longer possible, how do I fix the problem?

There may be an incompatibility our plug-in has with some other plug-ins and specific Confluence versions causing this issue.

The quickest way to fix the issue seems to be to use compatible version ranges and there are two options to follow:

  1. Upgrade to the latest Confluence version (7.20 as of this post):

    • Using the latest version (2.3.0) of Include Bitbucket for Confluence works on Confluence 7.20

  2. If upgrading to the latest Confluence version is not an option then stay on the older version and downgrade Include Bitbucket for Confluence to 2.2.5

    • Using the older Include Bitbucket version 2.2.5 seems to work fine with that Confluence version.



Is it possible to include a private repository?

Yes, a private repository can be included from Bitbucket Cloud. Just paste link of file from Bitbucket Cloud private repo, and the app will show a link to grant access to the repository.

To view a private repository in Confluence Cloud, does the user also have to be a Bitbucket Cloud user?

Yes, the Confluence Cloud user also has to be a Bitbucket Cloud user and member of the team where the repository is stored. Are you looking for an impersonation

feature? Vote and watch this feature request: https://mibexsoftware.atlassian.net/browse/INCLUDE-81

Can I add GitHub files when using the Include GitLab for Confluence?

Include Gitlab does not officially support GitHub files but it is currently possible to add public GitHub files with raw links. However, adding private GitHub repos will not work. 

Can we Impersonate a Bitbucket user, so Confluence Users do not need a Login for Bitbucket?

It depends on the Confluence edition and where the file is, on Bitbucket Cloud or Bitbucket Data Center:

Confluence Edition

Bitbucket Edition


Confluence Edition

Bitbucket Edition


Confluence Cloud

Bitbucket Cloud

Each Confluence user needs to authenticate against Bitbucket Cloud.
So every Confluence user also needs a Bitbucket valid login.
The user needs permissions on Bitbucket to see the file.

Confluence Cloud

Bitbucket Data Center

An access token of a specific user is shared and used for all Confluence Users.
A Confluence user does not need any Bitbucket login.
Every Confluence user can view included Bitbucket files.

Confluence Data Center

Bitbucket Cloud

The app uses an app password. A confluence user does not need an individual Bitbucket login.

A Confluence user does not need any Bitbucket login.

Every Confluence user can view included Bitbucket files.

Confluence Data Center

Bitbucket Data Center

The app uses an application link.

Every user needs also a Bitbucket account.

The user needs permissions on Bitbucket to see the file.

We have our Bitbucket instance behind a firewall and when we input our URL and token and hit Submit, nothing occurs.

The Include for Confluence Cloud app uses the Heroku platform, which is itself hosted by AWS. As a result, the IP address used for app requests is not static, and is periodically reassigned.

Unfortunately, this means that at any given time the requests to Confluence Cloud could be coming from any of the AWS Europe range. At the moment Heroku uses eu-west-1 and eu-central-1.

The AWS list changes over time. The current ranges for these regions can be found here https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html

Pasting a File URL from Bitbucket/GitHub/GitLab does not work

There limitations on when pasting a file URL does work. It does not work when:

  • Pasting GitLab URL on other domains and not on gitlab.com. In that case, use the GitLab file macro explicitly.

  • Pasting Bitbucket DC URLs. In that case, use the Bitbucket file macro explicitly.

  • Longer file URLs might not work. Contact our support to let us know.