-
Notifications
You must be signed in to change notification settings - Fork 14
Integrations: update GitLab guides #111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e5c6bdb
Update the GitLab integration guide for Self-Hosted
stevenrombauts 950260f
Update the GitLab integration guide for Cloud
stevenrombauts af9c5c4
Optimised images with calibre/image-actions
github-actions[bot] a592c71
Update docs/cloud/gitlab-integration-setup.md
stevenrombauts a244db4
Fix the callback URLs and key/secret obfuscation in GitLab screenshots
stevenrombauts afa9cd9
Optimised images with calibre/image-actions
github-actions[bot] 371f8b5
Fix missing secret in GitLab screenshot
stevenrombauts 95db4c7
Optimised images with calibre/image-actions
github-actions[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+148 KB
...ocs/integration-setup/cloud/gitlab-self-managed-01-packagist-setup-20241219.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-101 KB
...lic/img/docs/integration-setup/cloud/gitlab-self-managed-01-packagist-setup.png
Binary file not shown.
Binary file added
BIN
+220 KB
.../public/img/docs/integration-setup/cloud/gitlab-self-managed-02-gitlab-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+74.2 KB
.../img/docs/integration-setup/cloud/gitlab-self-managed-03-gitlab-credentials.png
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+104 KB
...docs/integration-setup/cloud/gitlab-self-managed-04-packagist-form-20241219.png
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-108 KB
...blic/img/docs/integration-setup/cloud/gitlab-self-managed-04-packagist-form.png
Binary file not shown.
Binary file added
BIN
+53.7 KB
.../public/img/docs/integration-setup/cloud/gitlab-self-managed-05-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-181 KB
Resources/public/img/docs/integration-setup/gitlab-01-packagist-setup.png
Binary file not shown.
Binary file removed
BIN
-239 KB
Resources/public/img/docs/integration-setup/gitlab-02-gitlab-form.png
Binary file not shown.
Binary file removed
BIN
-217 KB
Resources/public/img/docs/integration-setup/gitlab-03-gitlab-credentials.png
Binary file not shown.
Binary file removed
BIN
-203 KB
Resources/public/img/docs/integration-setup/gitlab-04-packagist-form.png
Binary file not shown.
Binary file added
BIN
+132 KB
...ces/public/img/docs/integration-setup/self-hosted/gitlab-01-packagist-setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+214 KB
Resources/public/img/docs/integration-setup/self-hosted/gitlab-02-gitlab-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+77.1 KB
.../public/img/docs/integration-setup/self-hosted/gitlab-03-gitlab-credentials.png
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+110 KB
...rces/public/img/docs/integration-setup/self-hosted/gitlab-04-packagist-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+13.6 KB
...blic/img/docs/integration-setup/self-hosted/gitlab-05-integrations-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,59 @@ | ||
# GitLab (Self-Managed) Integration Setup | ||
## Private Packagist Cloud | ||
|
||
## Initial Setup | ||
<div class="row column"> | ||
<div class="callout success"> | ||
<p> | ||
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. | ||
</p> | ||
<p>If you are using our Self-Hosted product, please <a href="/docs/self-hosted/gitlab-integration-setup">use this guide</a>.</p> | ||
</div> | ||
</div> | ||
|
||
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 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. | ||
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. | ||
|
||
 | ||
 | ||
|
||
## 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. | ||
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: | ||
|
||
 | ||
 | ||
|
||
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. | ||
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. | ||
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. | ||
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
|
||
## 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. | ||
|
||
 | ||
 | ||
|
||
You'll be redirected back to the list of integrations. | ||
|
||
### Share the GitLab login link | ||
|
||
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. | ||
|
||
 | ||
|
||
This link presents the option to authenticate with your GitLab account and can now be used to log in to Private Packagist. | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,51 @@ | ||
# GitLab Integration Setup | ||
## Private Packagist Self-Hosted | ||
|
||
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. | ||
If you are using our cloud product at packagist.com, [use this guide](../cloud/gitlab-integration-setup.md). | ||
<div class="row column"> | ||
<div class="callout success"> | ||
<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> | ||
<p>If you are using our Cloud product at packagist.com, <a href="/docs/cloud/gitlab-integration-setup">use this guide</a>.</p> | ||
</div> | ||
</div> | ||
|
||
## Initial Setup | ||
Hit the "Add Integration" button on the admin page in Private Packagist Self-Hosted to get to the form below. | ||
To allow your users to authenticate to Private Packagist Self-Hosted 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 | ||
Go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. If you've just | ||
installed Private Packagist Self-Hosted and it is still running in Setup Mode, you do not need to log in. If the application | ||
is no longer in Setup mode, you will have to log in with an admin account first. | ||
|
||
 | ||
|
||
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. | ||
To set up 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 set up the OAuth application on GitLab will automatically be displayed. | ||
|
||
 | ||
 | ||
|
||
## 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. | ||
## Create a GitLab 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. | ||
|
||
 | ||
 | ||
|
||
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. | ||
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. | ||
|
||
Instead of the user settings, you can also create an application in the settings section of a GitLab group, or if you | ||
have full admin access on GitLab in the GitLab admin section under Applications. | ||
There are two additional checkmarks on that page: "trusted" should remain unchecked, and "confidential" should remain checked. | ||
There are two additional checkmarks on that page: `trusted` should remain unchecked, and `confidential` should remain checked. | ||
|
||
 | ||
 | ||
|
||
## Finish the Setup | ||
## Create the integration | ||
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. | ||
|
||
 | ||
 | ||
|
||
The GitLab integration will be created and you will be redirected to the admin page. | ||
|
||
The new integration will be shown in the list of available integrations, and your users can | ||
now log in to your Private Packagist Self-Hosted installation using their GitLab account. | ||
|
||
 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.