GitLab self-managed

Use GitLab self-managed instance as a source for your API definitions and developer portal projects.

Connect GitLab self-managed to Redocly

GitLab self-managed operates similarly to the GitLab.com integration. It requires some additional setup.

Create a GitLab application

Navigate to your GitLab user settings. Create a GitLab Application.

A regular user account is acceptable, but we recommend you create a service account for managing applications. Service accounts typically have administrative privileges, and are not used by human users, but by the system for administration and interacting with external services.

GitLab user dropdown

Go to the Applications tab and provide "Redocly Workflows" for the new application name. Set the Redirect URI to https://app.redoc.ly/callbacks/gitlab-auth.

Activate the api scope from the Scopes list in order to allow our system to read your repositories and write commit statuses.

GitLab Applications tab 1

Select the Save application button to create a new application.

GitLab Applications tab 2

You will be redirected to the page with credentials for the new application.

GitLab application credentials

Keep this tab opened (this data is required for the following steps).

Connect application to your organization in Redocly's web app

Navigate to your Org Settings and go to the Source control providers tab.

Organization source control settings

Scroll down to GitLab self-managed section and copy/paste Application ID and Secret values from the GitLab application to the corresponding form fields. Also, provide the URL to your self-managed instance.

Organization source control gitlab self-managed settings

Select Save self-managed Gitlab settings to complete the configuration.

You're all set! You can now use the GitLab self-managed source similarly to the GitLab.com integration source.