Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

“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” plugin user should first create OAuth app on his account. For Companies we strongly 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 some 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 applications 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.

    settings gitlab.png

  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 allowed communication both apps are connectec 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 ivon is clicked Repositoru Explorer will open showing available repositories. User can browse them as he browse File Explorer or he cn use search functionality on the upper right corner.

gitlab explorer.png

Repository URL feature

In order to avoid browsing repositories user can directly put repositoru URL into “GitLab repository URL” field. It should be in standard format received from “Clone from HTTPS“ feature on the GitLab project page. When user provides this URL he will be automatically redirected to given project Branches view. If URL is invalid error message is shown.

  • No labels