Loading... Background job is running.

Edit on GitHub

GitLab Self-Managed Integration Setup

Private Packagist Cloud

This guide explains how to set up an OAuth integration for Private Packagist Cloud with the on-premises version of GitLab. If you use their public service on GitLab.com, these instructions are not relevant to you.

If you are using our Self-Hosted product, please use this guide.

To allow your users to authenticate to Private Packagist with their GitLab account, you'll first need to create an integration in Private Packagist. This document walks you through the required steps.

Open the Add Integration form

From the organization settings page, select the "Integrations" subtab. Hit the "Add Integration" button on the integrations listing page to get to the form below. To set up a GitLab Self-Managed integration with Private Packagist, start by selecting "GitLab" as the platform and enter the URL of your own GitLab server. A link to setup the OAuth application on your GitLab server will automatically be displayed.

Packagist Setup

Add an OAuth Application

Do not submit the integration form yet, but copy the content from the "Callback URL / Redirect URL" and follow the setup link to your GitLab server. The fields Client ID and Client Secret remain empty for now.

On the GitLab applications page, click the "Add new application" button and fill in the form as shown here:

GitLab Form

Make sure the api and read_user scopes are both checked and save the new application. This will reveal the credentials required to finish the setup on Private Packagist.

If you have full admin access on GitLab, then you can also create an application in the GitLab admin section under Applications. There are two additional checkmarks on that page: trusted should remain unchecked, and confidential should remain checked.

After you create the application, you will get a new Application ID and Secret. You'll need both these values to continue the set up in Private Packagist.

GitLab Credentials

Finish the Setup

Copy and paste the "Application Id" and "Secret" value back into the Private Packagist integration form and submit the form with the "Save Integration" button.

Complete integration form

You'll be redirected back to the list of integrations.

The final step is sharing your organization-specific login link with your users. Look for the "Login link" button next to your newly created GitLab integration on the integrations page, and copy the URL.

GitLab integration

This link presents the option to authenticate with your GitLab account and can now be used to log in to Private Packagist.

Start Free Trial

Login to create an organization and start your free trial!