Last updated

Manage self-hosted Git providers

Connect your self-hosted source control to offer continuous validation and delivery of your APIs, reference documentation, and developer projects. Define self-hosted Git providers on the organization level in Reunite. After you add self-hosted Git providers to an organization, those providers become available for all users in the organization, making it possible to connect your repositories, or add remote content to Redocly projects. You can add one or more Git self-hosted providers, depending on your infrastructure.

Before you begin

Make sure you have the following before you begin:

  • You must have an OWNER role in your Reunite organization.

Create an application in your GitLab self-managed

Redocly supports OAuth 2.0 to identify your GitLab self-managed users, so they can authenticate and perform operations such as opening or merging your GitLab merge requests from Redocly.

To connect your GitLab self-managed instance to Reunite, you must create an OAuth 2 application on your instance and copy the Application ID and Secret for use in a later step in the process.

The OAuth 2 application must have api scope and use one of the following Redirect URIs depending on your location:

  • Redirect URI: https://app.cloud.redocly.com/callback/oauth2.
  • Scopes: api.

See Create an application for OAuth 2.0 in GitLab's documentation for more information on creating an application in GitLab.

Add a self-hosted Git provider

To add a self-hosted Git provider in Reunite for your organization:

  1. On the Overview page for your organization, click Self-hosted Git providers.
  2. Click Add new provider.
  3. In the Add new provider modal, complete the following:
    • Choose a Provider Type.
    • Copy the Redirect URI and paste it into your provider's application settings.
    • Enter a name for the Git provider.
    • Enter the self-managed Git server URL.
    • Enter the application ID from your Git provider.
    • Enter the application secret from your Git provider.
  4. Click Save.

Afterward, the self-hosted Git provider displays on the list of Git providers when users in your organization want to add your repository as a project source to Reunite, or to add content from remote repository.

Edit self-hosted Git provider properties

You can edit the properties of your self-hosted Git provider to reflect the changes in your infrastructure.

To edit a self-hosted Git provider's properties:

  1. On the Organization page, click Self-hosted Git providers.
  2. Next to the Git provider you want to modify, click the Edit icon.
  3. Adjust the details as needed.
  4. Click Save.

Delete an existing self-hosted Git provider

You can delete self-hosted Git provider integrations you no longer need.

To delete self-hosted Git provider instances:

  1. On the Organization page, click Self-hosted Git providers.
  2. Next to the Git provider you want to modify, click the Delete icon.
  3. Enter the provider name; this step ensures that you delete the correct provider. Then click the Delete button to confirm deletion.

Deleting a Git self-hosted provider instance removes all associated OAuth and personal access token authorization credentials, and stops synchronization for remote content and projects related to this provider.

Perform this action only if you're certain your organization has no use for this Git self-hosted provider instance.

  • Now that you have added a self-hosted Git provider instance, you can follow step-by-step instructions for connecting a Git provider to a project in your organization.
  • You can also add remote files from your GitLab self-hosted instance to any project in your organization.

Resources

 
Next page