GitHub links
GitHub links
Breadcrumbs

Getting Started Guide for Confluence Administrators

Get GitHub Links for Confluence connected to your GitHub organisation. Once connected, your team can start embedding live GitHub data - pull requests, issues, source files, releases, discussions, security alerts, and more - directly on any Confluence page.

To Connect GitHub links for Confluence with the organization, navigate to Confluence as an administrator.

  1. Go to your Confluence administration.

  2. Scroll down to the Apps section and select GitHub Configuration.

    image-20260622-135643.png


  3. To connect via GitHub App, select the radio button for GitHub App (Recommended) and click Connect to GitHub

    image-20260622-135714.png

  4. You may receive a prompt regarding opening an external page, if so click Continue

    image-20260622-140102.png

  5. Select where you would like to install GitHub Links for Confluence, which can be a personal account or organization:

    image-20260622-140157.png

  6. Configure which repositories to include, it’s also possible to review the permissions granted from there, then click Install.

    image-20260622-140314.png

  7. Finally confirm access, and you should be redirected to Confluence

    image-20260622-140444.png


Make sure that when you authorize the GitHub App to access your data, you select the organization you want to use the app with.

To Disconnect GitHub Links from Confluence

  1. Go to your Confluence administration.

  2. Scroll down to the Apps section and select GitHub Configuration.

  3. Click on Disconnect App

    image-20260622-140546.png



  4. From GitHub, navigate to the GitHub Apps section, locate Links for Confluence and click Configure

    image-20260622-142024.png


  5. Under Danger Zone, where it says Uninstall “Links for Confluence” click Uninstall

    image-20260622-142129.png


Reviewing Permissions & Repository access

To review the permissions granted to the application

  1. Go to GitHub and navigate to the GitHub Apps section, locate Links for Confluence and click Configure

  2. From here, you can see the Permissions currently granted to Links for Confluence

    image-20260622-142203.png


To update repository access

  1. From the same Links for Confluence section go to the Repository access section

  2. Update the repository access based on All repositories or Only select repositories

    image-20260622-142240.png


  3. Once the necessary updates have been made, click Save

Some features - such as Discussions, Code Scanning alerts, and Security Advisories - require additional permissions beyond the defaults. See Managing GitHub App permissions and organisation access for details.

Usage with private repositories

To use the private repositories, you need to allow our GitHub App to access your private repositories. We do not clone or access source code. We use GitHub APIs to get additional information from the links inserted in Confluence.

If you want to use this App only with public repositories - you do NOT need any additional configuration. It works out of the box.

When you allow GitHub App to access your data, please make sure that you grant permissions to your organization as well, not only your personal repositories.


What's next?

Updated: