/
Using GitLab Diagrams (cloud only)

Using GitLab Diagrams (cloud only)

Owned by Aljoša Klišanić
Last updated: Dec 16, 2024
3 min read

“PlantUML Diagrams for Confluence” cloud allows users to import their GitLab diagrams into Confluence pages.

Setup

Step1: GitLab OAuth App

In order to connect GitLab account with “PlantUML diagrams for Confluence” add-on, user should first create OAuth app on their GitLab account. For companies, we suggest creating separate account for this role as a security measure.

  1. Go to gitlab.com and login into account.

  2. Click on the account image on top left side:

    gitlab_app_2.png

  3. From the drop-down menu select “Preferences“

  4. From the left menu bar select “Applications”

  5. Click “Add new Application“ on the right.

  6. Give OAuth app a name and insert redirect URL as shown on “PlantUML Diagrams for Confluence“ plugin’s Settings page. Give only read_api permission.

    gitlab_app_3.png

  7. Save application. On the next page copy and save application secret and ID. Make sure newly created OAuth App is listed under “Authorized Applications”.

    gitlab_app_1.png

Step 2: Plugin setup

  1. Open “PlantUML Diagrams for Confluence“ setup page. Select “GitLab” tab.

  2. Populate fields and click on “Save Settings“. This will persist connection details. Make sure you entered them correctly. Note that only gitlab.com is supported for now.

     

  3. Click on “Connect With GitLab“ button. This will initiate connection procedure. At this point you need to grant permission to OAuth App to communicate with “PlantUML Diagrams for Confluence”. After you allow communication, both apps are connected and Confluence users will be able to use repositories visible to OAuth app.

 

Using repository explorer

Main concepts

When Plugin editor is opened user will see GitLab icon next to the GitHub icon. When GitLab icon is clicked Repository Explorer will open showing available repositories. Users can browse repositories using File Explorer or input the URL directly.

Repository URL feature

In order to avoid browsing repositories, users can directly put repository URL into “GitLab repository URL” field. It’s a HTTPS URL received from “Clone from HTTPS“ feature on the GitLab project page. When users provide this URL, they will be automatically redirected to given project Branches view. If URL is invalid error message will be shown.

Direct link feature

User can always choose direct link feature to avoid navigating through the repositories.

Open GitLab and navigate to the file you wish to include into Confluence page. Copy URL from the browser. Paste that URL into upper right field in Repository Explorer:

If the URL is valid it will enable “Select” button. Click on the button and the diagram will be loaded into editor.