Skip to content

Commit 950260f

Browse files
Update the GitLab integration guide for Cloud
1 parent e5c6bdb commit 950260f

10 files changed

+41
-10
lines changed
Loading
Loading
Binary file not shown.
Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,59 @@
11
# GitLab (Self-Managed) Integration Setup
22
## Private Packagist Cloud
33

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
518

619
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.
822

9-
![Packagist Setup](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-01-packagist-setup.png)
23+
![Packagist Setup](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-01-packagist-setup-20241219.png)
1024

1125
## Add an OAuth Application
1226

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:
1431

15-
![GitLab Form](/Resources/public/img/docs/integration-setup/gitlab-02-gitlab-form.png)
32+
![GitLab Form](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-02-gitlab-form.png)
1633

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.
1835

1936
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.
2138

22-
![GitLab Credentials](/Resources/public/img/docs/integration-setup/gitlab-03-gitlab-credentials.png)
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+
![GitLab Credentials](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-03-gitlab-credentials.png)
2342

2443
## Finish the Setup
2544

2645
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.
2746

28-
![GitLab Credentials](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-04-packagist-form.png)
47+
![Complete integration form](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-04-packagist-form-20241219.png)
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+
![GitLab integration](/Resources/public/img/docs/integration-setup/cloud/gitlab-self-managed-05-integration.png)
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+

docs/self-hosted/gitlab-integration-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Instead of the user settings, you can also create an application in the settings
3636
have full admin access on GitLab in the GitLab admin section under Applications.
3737
There are two additional checkmarks on that page: `trusted` should remain unchecked, and `confidential` should remain checked.
3838

39-
![GitLab Credentials](/Resources/public/img/docs/integration-setup/gitlab-03-gitlab-credentials.png)
39+
![GitLab Credentials](/Resources/public/img/docs/integration-setup/self-hosted/gitlab-03-gitlab-credentials.png)
4040

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

0 commit comments

Comments
 (0)