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.
Connect GitHub links for Confluence with your organization
To Connect GitHub links for Confluence with the organization, navigate to Confluence as an administrator.
Go to your Confluence administration.
Scroll down to the Apps section and select Github
To connect via GitHub App, select check the radio button for GitHub App (Recommended) and click Connect to GitHub
You may receive a prompt regarding opening an external page, if so click Continue
Select where you would like to install GitHub Links for Confluence, which can be a personal account or organization:
Configure which repositories to include, it’s also possible to review the permissions granted from there, then click Install.
Finally confirm access, and you should be redirected to Confluence
Make sure that when you authorize the GitHub App to access your data, you select the organization you want to use the app with.
Disconnecting GitHub links for Confluence
To Disconnect GitHub Links from Confluence
Go to the Confluence administration, then go to the apps configuration section
Click on Disconnect App
From GitHub, navigate to the GitHub Apps section, locate Links for Confluence and click Configure
Under Danger Zone, where it says Uninstall “Links for Confluence” click Uninstall
Reviewing Permissions & Repository access
To review the permissions granted to the application
Go to GitHub and navigate to the GitHub Apps section, locate Links for Confluence and click Configure
From here, you can see the Permissions currently granted to Links for Confluence
To update repository access
From the same Links for Confluence section go to the Repository access section
Update the repository access based on All repositories or Only select repositories
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?
Once connected, share the Get Started guide for the Confluence Users with your team so they can start embedding GitHub data straight away.
To change which repositories the app can access, or to grant additional permissions for Discussions and security alerts, see Managing GitHub App permissions and organisation access.
For a full list of supported GitHub link types, see Supported GitHub link types.
Updated: