Skip to content

Commit e5c6bdb

Browse files
Update the GitLab integration guide for Self-Hosted
1 parent 20b2b79 commit e5c6bdb

11 files changed

+35
-16
lines changed
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading
Loading
Loading
Loading

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ A link to set up the OAuth application on GitHub will automatically be displayed
2525

2626
![Packagist Setup](/Resources/public/img/docs/integration-setup/self-hosted/github-01-packagist-setup.png)
2727

28-
## Creating an OAuth Application
28+
## Create a GitHub OAuth Application
2929
Do not submit the integration form yet, but copy the content from the "Callback
3030
URL / Redirect URL" and follow the setup link to your GitHub server. The fields
3131
Client ID and Client Secret remain empty for now.
@@ -37,7 +37,7 @@ to get a new secret. You'll need the client ID and client secret to finish the s
3737

3838
![GitHub Credentials](/Resources/public/img/docs/integration-setup/github-03-github-credentials-20241219.png)
3939

40-
## Finish the Setup
40+
## Create the integration
4141
Copy and paste the "Client ID" and "Client Secret" values back into the Private
4242
Packagist integration form and submit the form with the "Create Integration"
4343
button.
Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,51 @@
11
# GitLab Integration Setup
22
## Private Packagist Self-Hosted
33

4-
This guide explains how to setup an OAuth integration for Private Packagist Self-Hosted with either the on-premises version of GitLab, or their public service on gitlab.com.
5-
If you are using our cloud product at packagist.com, [use this guide](../cloud/gitlab-integration-setup.md).
4+
<div class="row column">
5+
<div class="callout success">
6+
<p>This guide explains how to set up an OAuth integration for Private Packagist Self-Hosted with either the on-premises version of GitLab, or their public service on GitLab.com.</p>
7+
<p>If you are using our Cloud product at packagist.com, <a href="/docs/cloud/gitlab-integration-setup">use this guide</a>.</p>
8+
</div>
9+
</div>
610

7-
## Initial Setup
8-
Hit the "Add Integration" button on the admin page in Private Packagist Self-Hosted to get to the form below.
11+
To allow your users to authenticate to Private Packagist Self-Hosted with their GitLab account, you'll
12+
first need to create an integration in Private Packagist. This document walks you through the required steps.
13+
14+
## Open the Add Integration form
15+
Go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. If you've just
16+
installed Private Packagist Self-Hosted and it is still running in Setup Mode, you do not need to log in. If the application
17+
is no longer in Setup mode, you will have to log in with an admin account first.
918

1019
![Add Integration](/Resources/public/img/docs/self-hosted/08-integration-create.png)
1120

12-
To setup a GitLab integration with Private Packagist start by selecting "GitLab" as the platform and enter the URL of your own GitLab server or use <i>https://gitlab.com</i> for the public GitLab server as seen in the example below. A link to setup the oauth application on GitLab will automatically be displayed.
21+
To set up a GitLab integration with Private Packagist start by selecting "GitLab" as the platform and enter the URL of
22+
your own GitLab server or use <i>https://gitlab.com</i> for the public GitLab server as seen in the example below.
23+
A link to set up the OAuth application on GitLab will automatically be displayed.
1324

14-
![Packagist Setup](/Resources/public/img/docs/integration-setup/gitlab-01-packagist-setup.png)
25+
![Packagist Setup](/Resources/public/img/docs/integration-setup/self-hosted/gitlab-01-packagist-setup.png)
1526

16-
## Add an OAuth Application
17-
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+
## Create a GitLab OAuth Application
28+
Do not submit the integration form yet, but copy the content from the "Callback URL / Redirect URL" and follow the
29+
setup link to your GitLab server. The fields Client ID and Client Secret remain empty for now.
1830

19-
![GitLab Form](/Resources/public/img/docs/integration-setup/gitlab-02-gitlab-form.png)
31+
![GitLab Form](/Resources/public/img/docs/integration-setup/self-hosted/gitlab-02-gitlab-form.png)
2032

21-
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.
33+
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.
2234

2335
Instead of the user settings, you can also create an application in the settings section of a GitLab group, or if you
2436
have full admin access on GitLab in the GitLab admin section under Applications.
25-
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.
2638

2739
![GitLab Credentials](/Resources/public/img/docs/integration-setup/gitlab-03-gitlab-credentials.png)
2840

29-
## Finish the Setup
41+
## Create the integration
3042
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.
3143

32-
![GitLab Credentials](/Resources/public/img/docs/integration-setup/gitlab-04-packagist-form.png)
44+
![GitLab Credentials](/Resources/public/img/docs/integration-setup/self-hosted/gitlab-04-packagist-form.png)
45+
46+
The GitLab integration will be created and you will be redirected to the admin page.
47+
48+
The new integration will be shown in the list of available integrations, and your users can
49+
now log in to your Private Packagist Self-Hosted installation using their GitLab account.
50+
51+
![Available integrations](/Resources/public/img/docs/integration-setup/self-hosted/gitlab-05-integrations-overview.png)

0 commit comments

Comments
 (0)