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.
The app uses GitHub OAuth application to access user’s files. We recommend customers use dedicated GitHub account with proper permissions to connect with the GitHub application. This is important because repository access is done on the GitHub side.
GitHub connection is done in 3 simple steps:
Create app Settings Space using the Settings page.
On the same page, initiate GitHub connection flow (see image below).
Connect the GitHub account with the GitHub app 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 new access key. Go to Settings page and remove current key by clicking on “Disconnect GitHub Account“ button. Then re-connect as before and a new valid key will be granted .
Troubleshooting
Company GitHub accounts may have blocked OAuth apps or some other security features that may interfere with GitHub integration. Typical for these errors is that content visible for 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 OAuth apps for user's organization needs to be approved.