Connect with GitHub
The PlantUML Diagrams for Confluence cloud app features a GitHub integration. This allows users to use PlantUML diagrams stored in their GitHub repositories within their Confluence cloud instance.
To connect, customers create their own GitHub OAuth App and use it to authorize access to their repositories. We recommend using a dedicated GitHub account with proper permissions when creating and authorizing the app, since repository access is controlled entirely on the GitHub side. Full setup details are available in GitHub's own documentation, linked above.
GitHub connection is done in 3 simple steps:
Create your own GitHub OAuth App by following GitHub's official guide, and note the generated Client ID and Client Secret.
Enter the Client ID and Client Secret from your OAuth app.
On the same page, initiate the GitHub connection flow (see image below) to authorize the connection and return to Confluence.
After successful integration, PlantUML diagrams can be displayed on Confluence pages and blog posts by the app.
Error messages
Access key is expired or invalid
User needs to generate a new access key. Go to Settings page and remove the current key by clicking on "Disconnect GitHub Account". Then re-connect as before and a new valid key will be granted.
Troubleshooting
Company GitHub accounts may have blocked OAuth apps or have other security features that may interfere with GitHub integration. A typical symptom is that content visible to the user in GitHub is not displayed in the plugin.
In case of such issues, organization approval for OAuth apps needs to be set, and the OAuth app needs to be approved for the user's organization.