|
1 | 1 | # GitLab (Self-Managed) Integration Setup
|
2 | 2 | ## Private Packagist Cloud
|
3 | 3 |
|
4 |
| -## Initial Setup |
| 4 | +<div class="row column"> |
| 5 | + <div class="callout success"> |
| 6 | + <p> |
| 7 | + This guide explains how to set up an OAuth integration for Private Packagist Cloud with the on-premises version of GitLab. |
| 8 | + If you use their public service on GitLab.com, these instructions are not relevant to you. |
| 9 | + </p> |
| 10 | + <p>If you are using our Self-Hosted product, please <a href="/docs/self-hosted/gitlab-integration-setup">use this guide</a>.</p> |
| 11 | + </div> |
| 12 | +</div> |
| 13 | + |
| 14 | +To allow your users to authenticate to Private Packagist with their GitLab account, you'll first need to create |
| 15 | +an integration in Private Packagist. This document walks you through the required steps. |
| 16 | + |
| 17 | +## Open the Add Integration form |
5 | 18 |
|
6 | 19 | 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.
|
7 |
| -To set up a GitLab Self-Managed integration with Private Packagist, start by selecting "GitLab" as the plaform and enter the URL of your own GitLab server. A link to setup the OAuth application on your GitLab server will automatically be displayed. |
| 20 | +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. |
| 21 | +A link to setup the OAuth application on your GitLab server will automatically be displayed. |
8 | 22 |
|
9 |
| - |
| 23 | + |
10 | 24 |
|
11 | 25 | ## Add an OAuth Application
|
12 | 26 |
|
13 |
| -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. |
| 27 | +Do not submit the integration form yet, but copy the content from the "Callback URL / Redirect URL" and follow the |
| 28 | +setup link to your GitLab server. The fields Client ID and Client Secret remain empty for now. |
| 29 | + |
| 30 | +On the GitLab applications page, click the "Add new application" button and fill in the form as shown here: |
14 | 31 |
|
15 |
| - |
| 32 | + |
16 | 33 |
|
17 |
| -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. |
| 34 | +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. |
18 | 35 |
|
19 | 36 | If you have full admin access on GitLab, then you can also create an application in the GitLab admin section under Applications.
|
20 |
| -There are two additional checkmarks on that page: "trusted" should remain unchecked, and "confidential" should remain checked. |
| 37 | +There are two additional checkmarks on that page: `trusted` should remain unchecked, and `confidential` should remain checked. |
21 | 38 |
|
22 |
| - |
| 39 | +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. |
| 40 | + |
| 41 | + |
23 | 42 |
|
24 | 43 | ## Finish the Setup
|
25 | 44 |
|
26 | 45 | 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.
|
27 | 46 |
|
28 |
| - |
| 47 | + |
| 48 | + |
| 49 | +You'll be redirected back to the list of integrations. |
| 50 | + |
| 51 | +### Share the GitLab login link |
| 52 | + |
| 53 | +The final step is sharing your organization-specific login link with your users. Look for the "Login link" button next to |
| 54 | +your newly created GitLab integration on the integrations page, and copy the URL. |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +This link presents the option to authenticate with your GitLab account and can now be used to log in to Private Packagist. |
| 59 | + |
0 commit comments