Skip to content

Manage Git Instances

With Git instances, administrators can restrict the location of Git repositories.

No Git Instance Defined

When you don't want to define Git instances, users can use any location for their repositories. Some features, which require a specific instance, e.g., Gitlab, are not available.

Define a Git Instance

  1. Please navigate to Menu > Settings
  2. Select Git below Model sources

  3. You can see all existing instances (if any). To add a new integration, please use the form below "Add new integration". You have to enter the following information:

    1. Git Type
      • General: Works with every Git server that supports the Git protocol. Features like the diagram cache are not available.
      • Gitlab: Only works with Gitlab instances (self-hosted / SaaS). With Gitlab, the diagram cache integration can be used.
      • GitHub: Works with the public GitHub instance. With GitHub, the diagram cache integration can be used.
    2. Name: Any name to identify the instance
    3. Instance base URL: The base URL of the instance, e.g., https://gitlab.com. For more information, see Matching between models and instances
    4. API URL:
      • Gitlab: The API URL to the Gitlab REST API. In most of the cases: {base_url}/api/v4, e.g., https://gitlab.com/api/v4.
      • GitHub: The API URL to the GitHub REST API. The url is https://api.github.com.

Warning

New repositories have to match at least one instance. Otherwise, they can not be added as model source to models.

Matching between Models and Instances

Models are matched with instances with a longest prefix match of the URL.

Let's construct a short example. We have two Git instances:

  • Instance one with the URL https://git.example.com/
  • Instance two with the URL https://git.example.com/test

A model with the path https://git.example.com/test/test2.git is now associated with instance two. A model with the path https://git.example.com/test2/test2.git would be associated with instance one.